Restructure docs

docs/index.rst

@@ -27,26 +27,37 @@ Contents
    tutorials/quickstart.md
    tutorials/data_setup.rst
    tutorials/creating_graphs.md
-   Contributing <tutorials/contributing.md>
    tutorials/viewer.md
 
+.. toctree::
+   :hidden:
+   :caption: Models
+
+   NeRF<models/nerf.md>
+   Mip-NeRF<models/mipnerf.md>
+   Mip-NeRF 360<models/mipnerf_360.md>
+   Instan-NGP<models/instant_ngp.md>
+   NeRF-W<models/nerf_w.md>
+   Semantic NeRF<models/semantic_nerf.md>
+
+.. toctree::
+   :hidden:
+   :caption: Component Guides
+
+   notebooks/index
+
 .. toctree::
    :hidden:
    :caption: Tooling
 
    tooling/index
-
+   
 .. toctree::
    :hidden:
    :caption: Reference
 
-   notebooks/index
-   
-.. toctree::
-   :hidden:
-   :caption: API
-
-   reference/index
+   Contributing<reference/contributing.md>
+   reference/api/index
 
 
 

docs/models/instant_ngp.md

@@ -0,0 +1,14 @@
+# Instant-NGP
+<h4>Instant Neural Graphics Primitives with a Multiresolution Hash Encoding</h4>
+
+```{button-link} https://nvlabs.github.io/instant-ngp/
+:color: primary
+:outline:
+Paper Website
+```
+
+### Running Model
+
+```bash
+python scripts/run_train.py --config-name=graph_instant_ngp.yaml
+```

docs/models/mipnerf.md

@@ -0,0 +1,14 @@
+# Mip-NeRF
+<h4>A Multiscale Representation for Anti-Aliasing Neural Radiance Fields</h4>
+
+```{button-link} https://jonbarron.info/mipnerf/
+:color: primary
+:outline:
+Paper Website
+```
+
+### Running Model
+
+```bash
+python scripts/run_train.py --config-name=graph_mipnerf.yaml
+```

docs/models/mipnerf_360.md

@@ -0,0 +1,14 @@
+# Mip-NeRF 360
+<h4>Unbounded Anti-Aliased Neural Radiance Fields</h4>
+
+```{button-link} https://jonbarron.info/mipnerf360/
+:color: primary
+:outline:
+Paper Website
+```
+
+### Running Model
+
+```bash
+python scripts/run_train.py --config-name=graph_mipnerf_360.yaml
+```

docs/models/nerf.md

@@ -0,0 +1,14 @@
+# NeRF
+<h4>Neural Radiance Fields</h4>
+
+```{button-link} https://www.matthewtancik.com/nerf
+:color: primary
+:outline:
+Paper Website
+```
+
+### Running Model
+
+```bash
+python scripts/run_train.py --config-name=graph_vanilla_nerf.yaml
+```

docs/models/nerf_w.md

@@ -0,0 +1,14 @@
+# NeRF-W
+<h4>NeRF in the Wild</h4>
+
+```{button-link} https://nerf-w.github.io/
+:color: primary
+:outline:
+Paper Website
+```
+
+### Running Model
+
+```bash
+python scripts/run_train.py --config-name=graph_nerf_w.yaml
+```

docs/models/semantic_nerf.md

@@ -0,0 +1,7 @@
+# Semantic NeRF
+
+### Running Model
+
+```bash
+python scripts/run_train.py --config-name=graph_semantic_nerf.yaml
+```

docs/tooling/index.rst

@@ -7,6 +7,3 @@
     logging.md
     profiling.md
     benchmarking.md
-    other_codebase.md
-    speedup.md
-    jupyter.md

docs/tooling/jupyter.md

@@ -1,10 +0,0 @@
-# Setting up Jupyter
-
-We provide a few visualization tools with Jupyter that can be found in `notebooks/`.
-
-To install and run any of the notebooks, simply run the following commands:
-
-```bash
-python -m jupyter lab build
-bash environments/run_jupyter.sh
-```

docs/tooling/other_codebase.md

@@ -1,16 +0,0 @@
-# Run other repos with our data
-
-If you are looking to test out other existing repo's with our data, the pyRad structure makes it easy!
-
-For instance, you can run nerf-pytorch and jaxnerf with the following commands:
-
-```bash
-# nerf-pytorch
-cd external
-python run_nerf.py --config configs/chair.txt --datadir /path/to/pyrad/data/blender/chair
-
-# jaxnerf
-cd external
-conda activate jaxnerf
-python -m jaxnerf.train --data_dir=/path/to/pyrad/data/blender/chair --train_dir=/path/to/pyrad/outputs/blender_chair_jaxnerf --config=/path/to/pyrad/external/jaxnerf/configs/demo --render_every 100
-```

docs/tooling/speedup.md

@@ -1,14 +0,0 @@
-# Speeding up code with TinyCuda
-
-Documentation for running the code with CUDA.
-Please see https://github.com/NVlabs/tiny-cuda-nn for how to install tiny-cuda-nn.
-
-```bash
-pip install git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindings/torch
-```
-
-To run instant-ngp with tcnn, you can do the following. This is with the fox dataset.
-
-```bash
-python scripts/run_train.py --config-name=instant_ngp_tcnn.yaml data/dataset=instant_ngp_fox
-```