Tancik/update docs (#12)

Update docs structure.

docs/reference/dataset.rst

@@ -0,0 +1,32 @@
+.. _dataset:
+
+Dataset
+============
+
+Colmap Utils
+----------------
+
+.. automodule:: pyrad.nerf.dataset.colmap_utils
+   :members:
+   :show-inheritance:
+
+Image Dataset
+----------------
+
+.. automodule:: pyrad.nerf.dataset.image_dataset
+   :members:
+   :show-inheritance:
+
+Structures
+----------------
+
+.. automodule:: pyrad.nerf.dataset.structs
+   :members:
+   :show-inheritance:
+
+Utils
+----------------
+
+.. automodule:: pyrad.nerf.dataset.utils
+   :members:
+   :show-inheritance:

docs/reference/field_modules/embeddings.rst

@@ -0,0 +1,8 @@
+.. _embeddings:
+
+Embeddings
+===================
+
+.. automodule:: pyrad.nerf.field_modules.embedding
+   :members:
+   :show-inheritance:

docs/reference/field_modules/encodings.rst

@@ -0,0 +1,8 @@
+.. _encodings:
+
+Encodings
+===================
+
+.. automodule:: pyrad.nerf.field_modules.encoding
+   :members:
+   :show-inheritance:

docs/reference/field_modules/field_heads.rst

@@ -0,0 +1,8 @@
+.. _field_heads:
+
+Field Heads
+===================
+
+.. automodule:: pyrad.nerf.field_modules.field_heads
+   :members:
+   :show-inheritance:

docs/reference/field_modules/field_losses.rst

@@ -0,0 +1,8 @@
+.. _field_losses:
+
+Field Losses
+===================
+
+.. automodule:: pyrad.nerf.field_modules.field_losses
+   :members:
+   :show-inheritance:

docs/reference/field_modules/index.rst

@@ -0,0 +1,14 @@
+.. _field_modules:
+
+Field Modules
+===================
+
+TODO: High level description of field modules and how they connect together.
+
+.. toctree::
+
+   encodings
+   embeddings
+   field_heads
+   field_losses
+   mlp

docs/reference/field_modules/mlp.rst

@@ -0,0 +1,8 @@
+.. _mlp:
+
+MLP
+===================
+
+.. automodule:: pyrad.nerf.field_modules.mlp
+   :members:
+   :show-inheritance:

docs/reference/fields.rst

@@ -0,0 +1,25 @@
+.. _fields:
+
+Fields
+============
+
+Base
+----------------
+
+.. automodule:: pyrad.nerf.fields.base
+   :members:
+   :show-inheritance:
+
+Instant NGP
+----------------
+
+.. automodule:: pyrad.nerf.fields.instant_ngp_field
+   :members:
+   :show-inheritance:
+
+NeRF
+----------------
+
+.. automodule:: pyrad.nerf.fields.nerf_field
+   :members:
+   :show-inheritance:

docs/reference/graphs.rst

@@ -0,0 +1,39 @@
+.. _graphs:
+
+Graphs
+============
+
+Base
+----------------
+
+.. automodule:: pyrad.nerf.graph.base
+   :members:
+   :show-inheritance:
+
+Instant NGP
+----------------
+
+.. automodule:: pyrad.nerf.graph.instant_ngp
+   :members:
+   :show-inheritance:
+
+Semantic NeRF
+----------------
+
+.. automodule:: pyrad.nerf.graph.semantic_nerf
+   :members:
+   :show-inheritance:
+
+TensoRF
+----------------
+
+.. automodule:: pyrad.nerf.graph.tensorf
+   :members:
+   :show-inheritance:
+
+NeRF
+----------------
+
+.. automodule:: pyrad.nerf.graph.vanilla_nerf
+   :members:
+   :show-inheritance:

docs/reference/index.rst

@@ -0,0 +1,34 @@
+.. _reference:
+
+API
+============
+
+TODO: Explanation of each component
+
+.. toctree::
+    :hidden:
+
+    dataset
+    samplers
+    field_modules/index
+    renderers
+    fields
+    graphs
+
+Hydra config structure
+========================
+
+Logging, debugging utilities
+===================================
+
+Benchmarking, other tooling
+===================================
+
+Running other repos with our data
+===================================
+
+Speeding up the code
+===================================
+
+Setting up Jupyter
+========================

docs/reference/renderers.rst

@@ -0,0 +1,8 @@
+.. _renderers:
+
+Renderers
+============
+
+.. automodule:: pyrad.nerf.renderers
+   :members:
+   :show-inheritance:

docs/reference/samplers.rst

@@ -0,0 +1,25 @@
+.. _samplers:
+
+Samplers
+============
+
+Image Samplers
+-------------------------------
+
+.. automodule:: pyrad.nerf.image_sampler
+   :members:
+   :show-inheritance:
+
+Pixel Samplers
+-------------------------------
+
+.. automodule:: pyrad.nerf.pixel_sampler
+   :members:
+   :show-inheritance:
+
+Ray Samplers
+-------------------------------
+
+.. automodule:: pyrad.nerf.ray_sampler
+   :members:
+   :show-inheritance: