mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-16 12:53:44 +08:00
Restructure docs
This commit is contained in:
1 parent
87cc10ad40
commit
d86e10b725
34 files changed
+97
-52
No files matched your search
@@ -0,0 +1,39 @@
|
||||
.. _dataset:
|
||||
|
||||
Data
|
||||
============
|
||||
|
||||
Image Dataset
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.data.image_dataset
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Image Sampler
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.data.image_sampler
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Pixel Sampler
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.data.pixel_sampler
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Structures
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.data.structs
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Utils
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.data.utils
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,25 @@
|
||||
.. _fields:
|
||||
|
||||
Fields
|
||||
============
|
||||
|
||||
Base
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.fields.base
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Instant NGP
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.fields.instant_ngp_field
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
NeRF
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.fields.nerf_field
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _embeddings:
|
||||
|
||||
Embeddings
|
||||
===================
|
||||
|
||||
.. automodule:: pyrad.fields.modules.embedding
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _encodings:
|
||||
|
||||
Encodings
|
||||
===================
|
||||
|
||||
.. automodule:: pyrad.fields.modules.encoding
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _field_heads:
|
||||
|
||||
Field Heads
|
||||
===================
|
||||
|
||||
.. automodule:: pyrad.fields.modules.field_heads
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _field_losses:
|
||||
|
||||
Field Losses
|
||||
===================
|
||||
|
||||
.. automodule:: pyrad.fields.modules.field_losses
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,15 @@
|
||||
.. _field_modules:
|
||||
|
||||
Field Modules
|
||||
===================
|
||||
|
||||
TODO: High level description of field modules and how they connect together.
|
||||
|
||||
.. toctree::
|
||||
|
||||
encodings
|
||||
embeddings
|
||||
field_heads
|
||||
field_losses
|
||||
mlp
|
||||
spatial_distortions
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _mlp:
|
||||
|
||||
MLP
|
||||
===================
|
||||
|
||||
.. automodule:: pyrad.fields.modules.mlp
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _spatial_distortions:
|
||||
|
||||
Spatial Distortions
|
||||
=====================
|
||||
|
||||
.. automodule:: pyrad.fields.modules.spatial_distortions
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,39 @@
|
||||
.. _graphs:
|
||||
|
||||
Graphs
|
||||
============
|
||||
|
||||
Base
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.graphs.base
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Instant NGP
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.graphs.instant_ngp
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
Semantic NeRF
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.graphs.semantic_nerf
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
TensoRF
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.graphs.tensorf
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
NeRF
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.graphs.vanilla_nerf
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. _graph_modules:
|
||||
|
||||
Graph Modules
|
||||
===================
|
||||
|
||||
TODO: High level description of graph modules and how they are used.
|
||||
|
||||
.. toctree::
|
||||
|
||||
ray_sampler
|
||||
ray_losses
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _ray_losses:
|
||||
|
||||
Ray Losses
|
||||
===================
|
||||
|
||||
.. automodule:: pyrad.graphs.modules.ray_losses
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _ray_sampler:
|
||||
|
||||
Ray Sampler
|
||||
===================
|
||||
|
||||
.. automodule:: pyrad.graphs.modules.ray_sampler
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,18 @@
|
||||
.. _reference:
|
||||
|
||||
API
|
||||
============
|
||||
|
||||
TODO: Explanation of each component
|
||||
|
||||
.. toctree::
|
||||
|
||||
data
|
||||
fields
|
||||
fields/modules/index
|
||||
graphs
|
||||
graphs/modules/index
|
||||
optimizers
|
||||
renderers/index
|
||||
utils/index
|
||||
viewer
|
||||
@@ -0,0 +1,9 @@
|
||||
.. _optimizers:
|
||||
|
||||
Optimizers
|
||||
============
|
||||
|
||||
.. automodule:: pyrad.optimizers.optimizers
|
||||
:members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _renderers:
|
||||
|
||||
Renderers
|
||||
============
|
||||
|
||||
.. automodule:: pyrad.renderers.renderers
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _colors:
|
||||
|
||||
Colors
|
||||
------------
|
||||
|
||||
.. automodule:: pyrad.utils.colors
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,11 @@
|
||||
.. _utils:
|
||||
|
||||
Utils
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
|
||||
colors
|
||||
math
|
||||
visualization
|
||||
tensor_dataclass
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _math:
|
||||
|
||||
Math
|
||||
============
|
||||
|
||||
.. automodule:: pyrad.utils.math
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _tensor_dataclass:
|
||||
|
||||
TensorDataclass
|
||||
=================
|
||||
|
||||
.. automodule:: pyrad.utils.tensor_dataclass
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _visualization:
|
||||
|
||||
Visualization
|
||||
----------------
|
||||
|
||||
.. automodule:: pyrad.utils.visualization
|
||||
:members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _viewer:
|
||||
|
||||
Viewer
|
||||
============
|
||||
|
||||
.. automodule:: pyrad.viewer
|
||||
:members:
|
||||
:show-inheritance:
|
||||
Reference in new issue
Block a user