JaggedTensor Python docs (#283)

Cleans up formatting of JaggedTensor docstrings and adds more detailed
examples.

---------

Signed-off-by: Francis Williams <francis@fwilliams.info>
Signed-off-by: Francis Williams <fwilliams@users.noreply.github.com>
Co-authored-by: Mark Harris <mharris@nvidia.com>

Author: fwilliams

docs/conf.py

@@ -55,7 +55,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "wip", "tutorials/wip/"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "wip", "tutorials"]
 
 autodoc_default_options = {"undoc-members": "forward, extra_repr"}
 

docs/index.rst

@@ -40,17 +40,16 @@ The videos below show fVDB being used for large-scale 3D reconstruction, simulat
 .. raw:: html
 
    <p style="text-align: center; font-weight: bold; font-style: italic; text-decoration: underline; font-size: medium; text-decoration-skip-ink: none; margin-bottom: 0.5em;">
-   fVDB being used to reconstruct radiance fields and TSDF volumes from images and points</p>
+   fVDB being used to reconstruct radiance (25 million splats) fields and TSDF volumes (100 million voxels) from images and points</p>
   <video autoplay loop controls muted width="90%" style="display: block; margin: 0 auto;">
      <source src="https://fvdb-data.s3.us-east-2.amazonaws.com/fvdb-reality-capture/spot_airport_480p.mp4" type="video/mp4" />
   </video>
 
    <br>
-
    <p style="text-align: center; font-weight: bold; font-style: italic; text-decoration: underline; font-size: medium; text-decoration-skip-ink: none; margin-bottom: 0.5em;">
-   fVDB being used to visualize large scale volumetric data in a web browser</p>
+   fVDB being used to process a sparse SDF on a grid with 181 million voxels. Visualized in a browser.</p>
   <video autoplay loop controls muted width="90%" style="display: block; margin: 0 auto;">
-     <source src="https://fvdb-data.s3.us-east-2.amazonaws.com/fvdb-reality-capture/large_recon_480p.mp4" type="video/mp4" />
+     <source src="https://fvdb-data.s3.us-east-2.amazonaws.com/fvdb-reality-capture/crawler_480p.mp4" type="video/mp4" />
   </video>
 
 |
@@ -71,11 +70,7 @@ spatial intelligence research and applications.
 
 .. toctree::
    :maxdepth: 1
-   :caption: Basic Concepts
-
-.. toctree::
-   :maxdepth: 1
-   :caption: API References
+   :caption: Documentation
 
    api/jagged_tensor
    api/convolution_plan

fvdb/__init__.py

@@ -219,12 +219,8 @@ def jcat(things_to_cat, dim=None):
     "ShOrderingMode",
     "ConvolutionPlan",
     # GridBatch operations
-    "load_gridbatch",
-    "save_gridbatch",
     # Grid operations
     "Grid",
-    "load_grid",
-    "save_grid",
     # JaggedTensor operations
     "jcat",
     "jrand",

fvdb/__init__.pyi

@@ -21,8 +21,8 @@ from ._Cpp import ConvPackBackend, config, volume_render
 from .convolution_plan import ConvolutionPlan
 from .enums import ProjectionType, ShOrderingMode
 from .gaussian_splatting import GaussianSplat3d, ProjectedGaussianSplats
-from .grid import Grid, load_grid, save_grid
-from .grid_batch import GridBatch, load_gridbatch, save_gridbatch
+from .grid import Grid
+from .grid_batch import GridBatch
 from .jagged_tensor import JaggedTensor, jempty, jones, jrand, jrandn, jzeros
 from .torch_jagged import (
     add,
@@ -103,13 +103,7 @@ __all__ = [
     "GaussianSplat3d",
     "ProjectedGaussianSplats",
     "ConvolutionPlan",
-    # GridBatch operations
-    "load_gridbatch",
-    "save_gridbatch",
-    # Grid operations
     "Grid",
-    "load_grid",
-    "save_grid",
     # JaggedTensor operations
     "jcat",
     "jrand",