Skip to content

Commit bd15de3

Browse files
fwilliamsfwilliams
authored
More API docs (#277)
Signed-off-by: Francis Williams <francis@fwilliams.info> Signed-off-by: Francis Williams <fwilliams@users.noreply.github.com>
1 parent 648416f commit bd15de3

37 files changed

+1929
-1102
lines changed

‎docs/api/convolution_plan.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
``fvdb.ConvolutionPlan``
1+
Sparse Convolution
22
==========================
33

44
.. autoclass:: fvdb.ConvolutionPlan

‎docs/api/enums.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Enums
2+
======
3+
4+
.. autoclass:: fvdb.ProjectionType
5+
:members:
6+
7+
.. autoclass:: fvdb.ShOrderingMode
8+
:members:

docs/api/gaussian_splat_3d.rst renamed to docs/api/gaussian_splatting.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
``fvdb.GaussianSplat3d``
1+
Gaussian Splatting
22
==========================
33

4+
.. autoclass:: fvdb.ProjectedGaussianSplats
5+
:members:
6+
:special-members: __getitem__, __setitem__
7+
48
.. autoclass:: fvdb.GaussianSplat3d
59
:members:
610
:special-members: __getitem__, __setitem__

‎docs/api/grid.rst‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎docs/api/nn.rst‎

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,17 @@
1-
fvdb.nn
2-
=======
3-
4-
`fvdb.nn` is a collection of neural network layers to build sparse neural networks.
5-
6-
Pooling and Upsampling
7-
-----------------------
1+
Neural Network Layers and Blocks
2+
===================================
83

94
.. autoclass:: fvdb.nn.MaxPool
105
.. autoclass:: fvdb.nn.AvgPool
116
.. autoclass:: fvdb.nn.UpsamplingNearest
12-
13-
Convolution Layers
14-
------------------
15-
167
.. autoclass:: fvdb.nn.SparseConv3d
178
.. autoclass:: fvdb.nn.SparseConvTranspose3d
18-
19-
Normalization Layers
20-
--------------------
21-
229
.. autoclass:: fvdb.nn.BatchNorm
2310
.. autoclass:: fvdb.nn.GroupNorm
2411
.. autoclass:: fvdb.nn.SyncBatchNorm
2512

26-
Activation Functions
27-
--------------------
28-
29-
.. autoclass:: fvdb.nn.CELU
30-
.. autoclass:: fvdb.nn.ELU
31-
.. autoclass:: fvdb.nn.GELU
32-
.. autoclass:: fvdb.nn.LeakyReLU
33-
.. autoclass:: fvdb.nn.ReLU
34-
.. autoclass:: fvdb.nn.SELU
35-
.. autoclass:: fvdb.nn.Sigmoid
36-
.. autoclass:: fvdb.nn.SiLU
37-
.. autoclass:: fvdb.nn.Tanh
38-
39-
Other Layers
40-
------------
41-
42-
.. autoclass:: fvdb.nn.Dropout
43-
.. autoclass:: fvdb.nn.InjectFromGrid
44-
.. autoclass:: fvdb.nn.Linear
45-
.. autoclass:: fvdb.nn.Sequential
46-
47-
U-Net Architecture
48-
------------------
13+
U-Net Architecture Blocks
14+
---------------------------
4915

5016
.. autoclass:: fvdb.nn.SimpleUNet
5117
.. autoclass:: fvdb.nn.SimpleUNetBasicBlock

docs/api/grid_batch.rst renamed to docs/api/sparse_grids.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
``fvdb.GridBatch``
1+
Sparse Grids
22
==================
33

4+
.. autoclass:: fvdb.Grid
5+
:members:
6+
47
.. autoclass:: fvdb.GridBatch
58
:members:

‎docs/api/utils.rst‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
fvdb.utils
1+
Utilities
22
==================
33

4-
.. autofunction:: fvdb.utils.build_ext.FVDBExtension
4+
.. autofunction:: fvdb.utils.fvdbCudaExtension
5+
6+
7+
``fvdb.utils.metrics``
8+
--------------------------
9+
10+
.. automodule:: fvdb.utils.metrics
11+
:members:

‎docs/api/viz.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
``fvdb.viz``
1+
Visualization
22
===============================
33

44
.. automodule:: fvdb.viz

‎docs/conf.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
# List of patterns, relative to source directory, that match files and
5656
# directories to ignore when looking for source files.
5757
# This pattern also affects html_static_path and html_extra_path.
58-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "wip"]
58+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "wip", "tutorials/wip/"]
5959

6060
autodoc_default_options = {"undoc-members": "forward, extra_repr"}
6161

@@ -88,4 +88,5 @@ def process_signature(app, what, name, obj, options, signature, return_annotatio
8888

8989

9090
def setup(app):
91-
app.connect("autodoc-process-signature", process_signature)
91+
pass
92+
# app.connect("autodoc-process-signature", process_signature)

‎docs/index.rst‎

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -71,31 +71,19 @@ spatial intelligence research and applications.
7171

7272
.. toctree::
7373
:maxdepth: 1
74-
:caption: Tutorials
74+
:caption: Basic Concepts
7575

76-
tutorials/installation
77-
tutorials/basic_concepts
78-
tutorials/building_grids
79-
tutorials/basic_grid_ops
80-
tutorials/ray_tracing
81-
tutorials/simple_unet
82-
tutorials/io
83-
tutorials/volume_rendering
8476

8577
.. toctree::
8678
:maxdepth: 1
8779
:caption: API References
8880

89-
api/convolution_plan
90-
api/gaussian_splat_3d
91-
api/grid
92-
api/grid_batch
9381
api/jagged_tensor
82+
api/convolution_plan
83+
api/sparse_grids
84+
api/gaussian_splatting
9485
api/viz
95-
96-
.. toctree::
97-
:maxdepth: 2
98-
86+
api/enums
9987
api/nn
10088
api/utils
10189

0 commit comments

Comments
 (0)