From d86e10b725d9e48142a159ad3427d68fa0942f61 Mon Sep 17 00:00:00 2001 From: Matt Tancik Date: Tue, 12 Jul 2022 11:54:12 -0700 Subject: [PATCH] Restructure docs --- docs/index.rst | 29 +++++++++++++------ docs/models/instant_ngp.md | 14 +++++++++ docs/models/mipnerf.md | 14 +++++++++ docs/models/mipnerf_360.md | 14 +++++++++ docs/models/nerf.md | 14 +++++++++ docs/models/nerf_w.md | 14 +++++++++ docs/models/semantic_nerf.md | 7 +++++ docs/reference/{ => api}/data.rst | 0 docs/reference/{ => api}/fields.rst | 0 .../{ => api}/fields/modules/embeddings.rst | 0 .../{ => api}/fields/modules/encodings.rst | 0 .../{ => api}/fields/modules/field_heads.rst | 0 .../{ => api}/fields/modules/field_losses.rst | 0 .../{ => api}/fields/modules/index.rst | 0 .../{ => api}/fields/modules/mlp.rst | 0 .../fields/modules/spatial_distortions.rst | 0 docs/reference/{ => api}/graphs.rst | 0 .../{ => api}/graphs/modules/index.rst | 0 .../{ => api}/graphs/modules/ray_losses.rst | 0 .../{ => api}/graphs/modules/ray_sampler.rst | 0 docs/reference/{ => api}/index.rst | 0 docs/reference/{ => api}/optimizers.rst | 0 docs/reference/{ => api}/renderers/index.rst | 0 docs/reference/{ => api}/utils/colors.rst | 0 docs/reference/{ => api}/utils/index.rst | 0 docs/reference/{ => api}/utils/math.rst | 0 .../{ => api}/utils/tensor_dataclass.rst | 0 .../{ => api}/utils/visualization.rst | 0 docs/reference/{ => api}/viewer.rst | 0 docs/{tutorials => reference}/contributing.md | 0 docs/tooling/index.rst | 3 -- docs/tooling/jupyter.md | 10 ------- docs/tooling/other_codebase.md | 16 ---------- docs/tooling/speedup.md | 14 --------- 34 files changed, 97 insertions(+), 52 deletions(-) create mode 100644 docs/models/instant_ngp.md create mode 100644 docs/models/mipnerf.md create mode 100644 docs/models/mipnerf_360.md create mode 100644 docs/models/nerf.md create mode 100644 docs/models/nerf_w.md create mode 100644 docs/models/semantic_nerf.md rename docs/reference/{ => api}/data.rst (100%) rename docs/reference/{ => api}/fields.rst (100%) rename docs/reference/{ => api}/fields/modules/embeddings.rst (100%) rename docs/reference/{ => api}/fields/modules/encodings.rst (100%) rename docs/reference/{ => api}/fields/modules/field_heads.rst (100%) rename docs/reference/{ => api}/fields/modules/field_losses.rst (100%) rename docs/reference/{ => api}/fields/modules/index.rst (100%) rename docs/reference/{ => api}/fields/modules/mlp.rst (100%) rename docs/reference/{ => api}/fields/modules/spatial_distortions.rst (100%) rename docs/reference/{ => api}/graphs.rst (100%) rename docs/reference/{ => api}/graphs/modules/index.rst (100%) rename docs/reference/{ => api}/graphs/modules/ray_losses.rst (100%) rename docs/reference/{ => api}/graphs/modules/ray_sampler.rst (100%) rename docs/reference/{ => api}/index.rst (100%) rename docs/reference/{ => api}/optimizers.rst (100%) rename docs/reference/{ => api}/renderers/index.rst (100%) rename docs/reference/{ => api}/utils/colors.rst (100%) rename docs/reference/{ => api}/utils/index.rst (100%) rename docs/reference/{ => api}/utils/math.rst (100%) rename docs/reference/{ => api}/utils/tensor_dataclass.rst (100%) rename docs/reference/{ => api}/utils/visualization.rst (100%) rename docs/reference/{ => api}/viewer.rst (100%) rename docs/{tutorials => reference}/contributing.md (100%) delete mode 100644 docs/tooling/jupyter.md delete mode 100644 docs/tooling/other_codebase.md delete mode 100644 docs/tooling/speedup.md diff --git a/docs/index.rst b/docs/index.rst index 67a227aa8..83ac11da5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,26 +27,37 @@ Contents tutorials/quickstart.md tutorials/data_setup.rst tutorials/creating_graphs.md - Contributing tutorials/viewer.md +.. toctree:: + :hidden: + :caption: Models + + NeRF + Mip-NeRF + Mip-NeRF 360 + Instan-NGP + NeRF-W + Semantic NeRF + +.. 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/api/index diff --git a/docs/models/instant_ngp.md b/docs/models/instant_ngp.md new file mode 100644 index 000000000..9e1b819f4 --- /dev/null +++ b/docs/models/instant_ngp.md @@ -0,0 +1,14 @@ +# Instant-NGP +

Instant Neural Graphics Primitives with a Multiresolution Hash Encoding

+ +```{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 +``` \ No newline at end of file diff --git a/docs/models/mipnerf.md b/docs/models/mipnerf.md new file mode 100644 index 000000000..1ea0aded6 --- /dev/null +++ b/docs/models/mipnerf.md @@ -0,0 +1,14 @@ +# Mip-NeRF +

A Multiscale Representation for Anti-Aliasing Neural Radiance Fields

+ +```{button-link} https://jonbarron.info/mipnerf/ +:color: primary +:outline: +Paper Website +``` + +### Running Model + +```bash +python scripts/run_train.py --config-name=graph_mipnerf.yaml +``` \ No newline at end of file diff --git a/docs/models/mipnerf_360.md b/docs/models/mipnerf_360.md new file mode 100644 index 000000000..7971b2ae0 --- /dev/null +++ b/docs/models/mipnerf_360.md @@ -0,0 +1,14 @@ +# Mip-NeRF 360 +

Unbounded Anti-Aliased Neural Radiance Fields

+ +```{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 +``` \ No newline at end of file diff --git a/docs/models/nerf.md b/docs/models/nerf.md new file mode 100644 index 000000000..1176225c9 --- /dev/null +++ b/docs/models/nerf.md @@ -0,0 +1,14 @@ +# NeRF +

Neural Radiance Fields

+ +```{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 +``` \ No newline at end of file diff --git a/docs/models/nerf_w.md b/docs/models/nerf_w.md new file mode 100644 index 000000000..916a09d67 --- /dev/null +++ b/docs/models/nerf_w.md @@ -0,0 +1,14 @@ +# NeRF-W +

NeRF in the Wild

+ +```{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 +``` \ No newline at end of file diff --git a/docs/models/semantic_nerf.md b/docs/models/semantic_nerf.md new file mode 100644 index 000000000..60860d96c --- /dev/null +++ b/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 +``` \ No newline at end of file diff --git a/docs/reference/data.rst b/docs/reference/api/data.rst similarity index 100% rename from docs/reference/data.rst rename to docs/reference/api/data.rst diff --git a/docs/reference/fields.rst b/docs/reference/api/fields.rst similarity index 100% rename from docs/reference/fields.rst rename to docs/reference/api/fields.rst diff --git a/docs/reference/fields/modules/embeddings.rst b/docs/reference/api/fields/modules/embeddings.rst similarity index 100% rename from docs/reference/fields/modules/embeddings.rst rename to docs/reference/api/fields/modules/embeddings.rst diff --git a/docs/reference/fields/modules/encodings.rst b/docs/reference/api/fields/modules/encodings.rst similarity index 100% rename from docs/reference/fields/modules/encodings.rst rename to docs/reference/api/fields/modules/encodings.rst diff --git a/docs/reference/fields/modules/field_heads.rst b/docs/reference/api/fields/modules/field_heads.rst similarity index 100% rename from docs/reference/fields/modules/field_heads.rst rename to docs/reference/api/fields/modules/field_heads.rst diff --git a/docs/reference/fields/modules/field_losses.rst b/docs/reference/api/fields/modules/field_losses.rst similarity index 100% rename from docs/reference/fields/modules/field_losses.rst rename to docs/reference/api/fields/modules/field_losses.rst diff --git a/docs/reference/fields/modules/index.rst b/docs/reference/api/fields/modules/index.rst similarity index 100% rename from docs/reference/fields/modules/index.rst rename to docs/reference/api/fields/modules/index.rst diff --git a/docs/reference/fields/modules/mlp.rst b/docs/reference/api/fields/modules/mlp.rst similarity index 100% rename from docs/reference/fields/modules/mlp.rst rename to docs/reference/api/fields/modules/mlp.rst diff --git a/docs/reference/fields/modules/spatial_distortions.rst b/docs/reference/api/fields/modules/spatial_distortions.rst similarity index 100% rename from docs/reference/fields/modules/spatial_distortions.rst rename to docs/reference/api/fields/modules/spatial_distortions.rst diff --git a/docs/reference/graphs.rst b/docs/reference/api/graphs.rst similarity index 100% rename from docs/reference/graphs.rst rename to docs/reference/api/graphs.rst diff --git a/docs/reference/graphs/modules/index.rst b/docs/reference/api/graphs/modules/index.rst similarity index 100% rename from docs/reference/graphs/modules/index.rst rename to docs/reference/api/graphs/modules/index.rst diff --git a/docs/reference/graphs/modules/ray_losses.rst b/docs/reference/api/graphs/modules/ray_losses.rst similarity index 100% rename from docs/reference/graphs/modules/ray_losses.rst rename to docs/reference/api/graphs/modules/ray_losses.rst diff --git a/docs/reference/graphs/modules/ray_sampler.rst b/docs/reference/api/graphs/modules/ray_sampler.rst similarity index 100% rename from docs/reference/graphs/modules/ray_sampler.rst rename to docs/reference/api/graphs/modules/ray_sampler.rst diff --git a/docs/reference/index.rst b/docs/reference/api/index.rst similarity index 100% rename from docs/reference/index.rst rename to docs/reference/api/index.rst diff --git a/docs/reference/optimizers.rst b/docs/reference/api/optimizers.rst similarity index 100% rename from docs/reference/optimizers.rst rename to docs/reference/api/optimizers.rst diff --git a/docs/reference/renderers/index.rst b/docs/reference/api/renderers/index.rst similarity index 100% rename from docs/reference/renderers/index.rst rename to docs/reference/api/renderers/index.rst diff --git a/docs/reference/utils/colors.rst b/docs/reference/api/utils/colors.rst similarity index 100% rename from docs/reference/utils/colors.rst rename to docs/reference/api/utils/colors.rst diff --git a/docs/reference/utils/index.rst b/docs/reference/api/utils/index.rst similarity index 100% rename from docs/reference/utils/index.rst rename to docs/reference/api/utils/index.rst diff --git a/docs/reference/utils/math.rst b/docs/reference/api/utils/math.rst similarity index 100% rename from docs/reference/utils/math.rst rename to docs/reference/api/utils/math.rst diff --git a/docs/reference/utils/tensor_dataclass.rst b/docs/reference/api/utils/tensor_dataclass.rst similarity index 100% rename from docs/reference/utils/tensor_dataclass.rst rename to docs/reference/api/utils/tensor_dataclass.rst diff --git a/docs/reference/utils/visualization.rst b/docs/reference/api/utils/visualization.rst similarity index 100% rename from docs/reference/utils/visualization.rst rename to docs/reference/api/utils/visualization.rst diff --git a/docs/reference/viewer.rst b/docs/reference/api/viewer.rst similarity index 100% rename from docs/reference/viewer.rst rename to docs/reference/api/viewer.rst diff --git a/docs/tutorials/contributing.md b/docs/reference/contributing.md similarity index 100% rename from docs/tutorials/contributing.md rename to docs/reference/contributing.md diff --git a/docs/tooling/index.rst b/docs/tooling/index.rst index 07215964f..265eafa5f 100644 --- a/docs/tooling/index.rst +++ b/docs/tooling/index.rst @@ -7,6 +7,3 @@ logging.md profiling.md benchmarking.md - other_codebase.md - speedup.md - jupyter.md diff --git a/docs/tooling/jupyter.md b/docs/tooling/jupyter.md deleted file mode 100644 index 8892dc7fa..000000000 --- a/docs/tooling/jupyter.md +++ /dev/null @@ -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 -``` \ No newline at end of file diff --git a/docs/tooling/other_codebase.md b/docs/tooling/other_codebase.md deleted file mode 100644 index 9b087924e..000000000 --- a/docs/tooling/other_codebase.md +++ /dev/null @@ -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 -``` \ No newline at end of file diff --git a/docs/tooling/speedup.md b/docs/tooling/speedup.md deleted file mode 100644 index f366533ae..000000000 --- a/docs/tooling/speedup.md +++ /dev/null @@ -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 -``` \ No newline at end of file