Reorganize documentation (#631)

restructure_docs
nerfstudio-project · Oct 3, 2022 · d7c34ca · d7c34ca
1 parent 5a76b95
commit d7c34ca
Show file tree

Hide file tree

Showing 68 changed files with 87 additions and 148 deletions.
diff --git a/docs/tooling/benchmarking.md → docs/developer_guides/benchmarking.md b/docs/tooling/benchmarking.md → docs/developer_guides/benchmarking.md
diff --git a/docs/tooling/config.md → docs/developer_guides/config.md b/docs/tooling/config.md → docs/developer_guides/config.md
diff --git a/docs/tooling/logging_profiling.md → docs/developer_guides/logging_profiling.md b/docs/tooling/logging_profiling.md → docs/developer_guides/logging_profiling.md
diff --git a/...ials/pipelines/creating_new_methods.ipynb → ...ides/pipelines/creating_new_methods.ipynb b/...ials/pipelines/creating_new_methods.ipynb → ...ides/pipelines/creating_new_methods.ipynb
diff --git a/docs/tutorials/pipelines/datamanagers.ipynb → ...loper_guides/pipelines/datamanagers.ipynb b/docs/tutorials/pipelines/datamanagers.ipynb → ...loper_guides/pipelines/datamanagers.ipynb
diff --git a/docs/tutorials/pipelines/dataparsers.ipynb → ...eloper_guides/pipelines/dataparsers.ipynb b/docs/tutorials/pipelines/dataparsers.ipynb → ...eloper_guides/pipelines/dataparsers.ipynb
diff --git a/...tutorials/pipelines/imgs/datamanagers.png → ...er_guides/pipelines/imgs/datamanagers.png b/...tutorials/pipelines/imgs/datamanagers.png → ...er_guides/pipelines/imgs/datamanagers.png
diff --git a/.../tutorials/pipelines/imgs/dataparsers.png → ...per_guides/pipelines/imgs/dataparsers.png b/.../tutorials/pipelines/imgs/dataparsers.png → ...per_guides/pipelines/imgs/dataparsers.png
diff --git a/docs/tutorials/pipelines/imgs/models.png → ...eveloper_guides/pipelines/imgs/models.png b/docs/tutorials/pipelines/imgs/models.png → ...eveloper_guides/pipelines/imgs/models.png
diff --git a/docs/tutorials/pipelines/imgs/pipelines.png → ...loper_guides/pipelines/imgs/pipelines.png b/docs/tutorials/pipelines/imgs/pipelines.png → ...loper_guides/pipelines/imgs/pipelines.png
diff --git a/...als/pipelines/imgs/pipelines_overview.png → ...des/pipelines/imgs/pipelines_overview.png b/...als/pipelines/imgs/pipelines_overview.png → ...des/pipelines/imgs/pipelines_overview.png
diff --git a/docs/tutorials/pipelines/index.rst → docs/developer_guides/pipelines/index.rst b/docs/tutorials/pipelines/index.rst → docs/developer_guides/pipelines/index.rst
diff --git a/docs/tutorials/pipelines/models.ipynb → docs/developer_guides/pipelines/models.ipynb b/docs/tutorials/pipelines/models.ipynb → docs/developer_guides/pipelines/models.ipynb
@@ -195,17 +195,13 @@
                 "\n",
                 "```bash\n",
                 "python scripts/train.py --config-name vanilla_nerf\n",
-                "```\n",
-                "\n",
-                "And now you have a brand-new NeRF in training! For testing and visualizing, simply refer to steps 4-5 in the [quickstart guide](https://github.com/plenoptix/nerfstudio#quickstart).\n",
-                "\n",
-                "To help you get started, we also provide additional training tools such as profiling, logging, and debugging. Please refer to our [features guide](../../tooling/index.rst)."
+                "```"
             ]
         }
     ],
     "metadata": {
         "kernelspec": {
-            "display_name": "Python 3.8.13 ('nerfactory')",
+            "display_name": "Python 3.8.12 ('nerfactory')",
             "language": "python",
             "name": "python3"
         },
@@ -219,12 +215,12 @@
             "name": "python",
             "nbconvert_exporter": "python",
             "pygments_lexer": "ipython3",
-            "version": "3.8.13"
+            "version": "3.8.12"
         },
         "orig_nbformat": 4,
         "vscode": {
             "interpreter": {
-                "hash": "b7b86c17c0dfd6b313529972d424f2e075cc198a46cda005757126afe8133c7b"
+                "hash": "34c28001ff35fb390494047002768a8182dcf55b1b11415165e62ea61557ab83"
             }
         }
     },

diff --git a/docs/tutorials/pipelines/pipelines.ipynb → ...eveloper_guides/pipelines/pipelines.ipynb b/docs/tutorials/pipelines/pipelines.ipynb → ...eveloper_guides/pipelines/pipelines.ipynb
diff --git a/docs/tutorials/viewer/faq.md → docs/developer_guides/viewer/faq.md b/docs/tutorials/viewer/faq.md → docs/developer_guides/viewer/faq.md
diff --git a/docs/tutorials/viewer/for_developers.md → ...developer_guides/viewer/for_developers.md b/docs/tutorials/viewer/for_developers.md → ...developer_guides/viewer/for_developers.md
diff --git a/docs/tutorials/viewer/imgs/bulldozer.png → ...eveloper_guides/viewer/imgs/bulldozer.png b/docs/tutorials/viewer/imgs/bulldozer.png → ...eveloper_guides/viewer/imgs/bulldozer.png
diff --git a/docs/tutorials/viewer/imgs/nerfviewer.png → ...veloper_guides/viewer/imgs/nerfviewer.png b/docs/tutorials/viewer/imgs/nerfviewer.png → ...veloper_guides/viewer/imgs/nerfviewer.png
diff --git a/docs/tutorials/viewer/imgs/viewer_figure.png → ...oper_guides/viewer/imgs/viewer_figure.png b/docs/tutorials/viewer/imgs/viewer_figure.png → ...oper_guides/viewer/imgs/viewer_figure.png
diff --git a/docs/tutorials/viewer/index.rst → docs/developer_guides/viewer/index.rst b/docs/tutorials/viewer/index.rst → docs/developer_guides/viewer/index.rst
diff --git a/docs/tutorials/viewer/viewer_notebook.ipynb → ...loper_guides/viewer/viewer_notebook.ipynb b/docs/tutorials/viewer/viewer_notebook.ipynb → ...loper_guides/viewer/viewer_notebook.ipynb
diff --git a/docs/tutorials/viewer/viewer_quickstart.md → ...eloper_guides/viewer/viewer_quickstart.md b/docs/tutorials/viewer/viewer_quickstart.md → ...eloper_guides/viewer/viewer_quickstart.md
diff --git a/docs/guides/index.rst b/docs/guides/index.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -36,30 +36,36 @@ Contents
    :hidden:
    :caption: Getting Started
 
-   Quickstart<tutorials/quickstart_index>
-   tutorials/data/index
-   tutorials/pipelines/index
-   tutorials/viewer/index
+   quickstart/installation
+   quickstart/first_nerf
+   quickstart/custom_dataset
+   quickstart/viewer_quickstart
+   Contributing<reference/contributing.md>
 
 .. toctree::
    :hidden:
-   :caption: Guides
+   :caption: NeRFology
 
-   guides/index
+   nerfology/models/index
+   nerfology/model_components/index
+   nerfology/dataloader_components/index
 
 .. toctree::
    :hidden:
-   :caption: Tooling
+   :caption: Developer Guides
 
-   tooling/index
+   developer_guides/pipelines/index
+   developer_guides/viewer/index
+   developer_guides/config
+   developer_guides/logging_profiling
+   developer_guides/benchmarking
 
 .. toctree::
    :hidden:
    :caption: Reference
 
    reference/cli/index
    reference/api/index
-   Contributing<reference/contributing.md>
 
 
 

diff --git a/...omponents/incrementally_add_cameras.ipynb → ...omponents/incrementally_add_cameras.ipynb b/...omponents/incrementally_add_cameras.ipynb → ...omponents/incrementally_add_cameras.ipynb
diff --git a/docs/guides/dataloader_components/index.md → .../nerfology/dataloader_components/index.md b/docs/guides/dataloader_components/index.md → .../nerfology/dataloader_components/index.md
diff --git a/...omponents/pixel_sampling_strategies.ipynb → ...omponents/pixel_sampling_strategies.ipynb b/...omponents/pixel_sampling_strategies.ipynb → ...omponents/pixel_sampling_strategies.ipynb
diff --git a/...s/model_components/imgs/frustums-dark.png → ...y/model_components/imgs/frustums-dark.png b/...s/model_components/imgs/frustums-dark.png → ...y/model_components/imgs/frustums-dark.png
diff --git a/...guides/model_components/imgs/frustums.png → ...fology/model_components/imgs/frustums.png b/...guides/model_components/imgs/frustums.png → ...fology/model_components/imgs/frustums.png
diff --git a/...ponents/imgs/samplers_stratified-dark.png → ...ponents/imgs/samplers_stratified-dark.png b/...ponents/imgs/samplers_stratified-dark.png → ...ponents/imgs/samplers_stratified-dark.png
diff --git a/...onents/imgs/samplers_stratified-light.png → ...onents/imgs/samplers_stratified-light.png b/...onents/imgs/samplers_stratified-light.png → ...onents/imgs/samplers_stratified-light.png
diff --git a/...el_components/imgs/samplers_type-dark.png → ...el_components/imgs/samplers_type-dark.png b/...el_components/imgs/samplers_type-dark.png → ...el_components/imgs/samplers_type-dark.png
diff --git a/...l_components/imgs/samplers_type-light.png → ...l_components/imgs/samplers_type-light.png b/...l_components/imgs/samplers_type-light.png → ...l_components/imgs/samplers_type-light.png
diff --git a/docs/guides/model_components/index.md → docs/nerfology/model_components/index.md b/docs/guides/model_components/index.md → docs/nerfology/model_components/index.md
diff --git a/.../model_components/visualize_cameras.ipynb → .../model_components/visualize_cameras.ipynb b/.../model_components/visualize_cameras.ipynb → .../model_components/visualize_cameras.ipynb
diff --git a/...model_components/visualize_encoders.ipynb → ...model_components/visualize_encoders.ipynb b/...model_components/visualize_encoders.ipynb → ...model_components/visualize_encoders.ipynb
diff --git a/...model_components/visualize_samplers.ipynb → ...model_components/visualize_samplers.ipynb b/...model_components/visualize_samplers.ipynb → ...model_components/visualize_samplers.ipynb
diff --git a/.../model_components/visualize_samples.ipynb → .../model_components/visualize_samples.ipynb b/.../model_components/visualize_samples.ipynb → .../model_components/visualize_samples.ipynb
diff --git a/...nents/visualize_spatial_distortions.ipynb → ...nents/visualize_spatial_distortions.ipynb b/...nents/visualize_spatial_distortions.ipynb → ...nents/visualize_spatial_distortions.ipynb
diff --git a/...mgs/mipnerf/models_mipnerf_field-dark.png → ...mgs/mipnerf/models_mipnerf_field-dark.png b/...mgs/mipnerf/models_mipnerf_field-dark.png → ...mgs/mipnerf/models_mipnerf_field-dark.png
diff --git a/...gs/mipnerf/models_mipnerf_field-light.png → ...gs/mipnerf/models_mipnerf_field-light.png b/...gs/mipnerf/models_mipnerf_field-light.png → ...gs/mipnerf/models_mipnerf_field-light.png
diff --git a/.../mipnerf/models_mipnerf_pipeline-dark.png → .../mipnerf/models_mipnerf_pipeline-dark.png b/.../mipnerf/models_mipnerf_pipeline-dark.png → .../mipnerf/models_mipnerf_pipeline-dark.png
diff --git a/...mipnerf/models_mipnerf_pipeline-light.png → ...mipnerf/models_mipnerf_pipeline-light.png b/...mipnerf/models_mipnerf_pipeline-light.png → ...mipnerf/models_mipnerf_pipeline-light.png
diff --git a/...es/models/imgs/models_nerf-field-dark.png → ...gy/models/imgs/models_nerf-field-dark.png b/...es/models/imgs/models_nerf-field-dark.png → ...gy/models/imgs/models_nerf-field-dark.png
diff --git a/...s/models/imgs/models_nerf-field-light.png → ...y/models/imgs/models_nerf-field-light.png b/...s/models/imgs/models_nerf-field-light.png → ...y/models/imgs/models_nerf-field-light.png
diff --git a/...models/imgs/models_nerf-pipeline-dark.png → ...models/imgs/models_nerf-pipeline-dark.png b/...models/imgs/models_nerf-pipeline-dark.png → ...models/imgs/models_nerf-pipeline-dark.png
diff --git a/.../imgs/models_nerf-pipeline-field-dark.png → .../imgs/models_nerf-pipeline-field-dark.png b/.../imgs/models_nerf-pipeline-field-dark.png → .../imgs/models_nerf-pipeline-field-dark.png
diff --git a/...imgs/models_nerf-pipeline-field-light.png → ...imgs/models_nerf-pipeline-field-light.png b/...imgs/models_nerf-pipeline-field-light.png → ...imgs/models_nerf-pipeline-field-light.png
diff --git a/...odels/imgs/models_nerf-pipeline-light.png → ...odels/imgs/models_nerf-pipeline-light.png b/...odels/imgs/models_nerf-pipeline-light.png → ...odels/imgs/models_nerf-pipeline-light.png
diff --git a/...gs/models_nerf-pipeline-renderer-dark.png → ...gs/models_nerf-pipeline-renderer-dark.png b/...gs/models_nerf-pipeline-renderer-dark.png → ...gs/models_nerf-pipeline-renderer-dark.png
diff --git a/...s/models_nerf-pipeline-renderer-light.png → ...s/models_nerf-pipeline-renderer-light.png b/...s/models_nerf-pipeline-renderer-light.png → ...s/models_nerf-pipeline-renderer-light.png
diff --git a/...mgs/models_nerf-pipeline-sampler-dark.png → ...mgs/models_nerf-pipeline-sampler-dark.png b/...mgs/models_nerf-pipeline-sampler-dark.png → ...mgs/models_nerf-pipeline-sampler-dark.png
diff --git a/...gs/models_nerf-pipeline-sampler-light.png → ...gs/models_nerf-pipeline-sampler-light.png b/...gs/models_nerf-pipeline-sampler-light.png → ...gs/models_nerf-pipeline-sampler-light.png
diff --git a/docs/guides/models/index.md → docs/nerfology/models/index.md b/docs/guides/models/index.md → docs/nerfology/models/index.md
diff --git a/docs/guides/models/instant_ngp.md → docs/nerfology/models/instant_ngp.md b/docs/guides/models/instant_ngp.md → docs/nerfology/models/instant_ngp.md
diff --git a/docs/guides/models/mipnerf.md → docs/nerfology/models/mipnerf.md b/docs/guides/models/mipnerf.md → docs/nerfology/models/mipnerf.md
diff --git a/docs/guides/models/mipnerf_360.md → docs/nerfology/models/mipnerf_360.md b/docs/guides/models/mipnerf_360.md → docs/nerfology/models/mipnerf_360.md
diff --git a/docs/guides/models/nerf.md → docs/nerfology/models/nerf.md b/docs/guides/models/nerf.md → docs/nerfology/models/nerf.md
diff --git a/docs/guides/models/nerf_w.md → docs/nerfology/models/nerf_w.md b/docs/guides/models/nerf_w.md → docs/nerfology/models/nerf_w.md
diff --git a/docs/guides/models/semantic_nerf.md → docs/nerfology/models/semantic_nerf.md b/docs/guides/models/semantic_nerf.md → docs/nerfology/models/semantic_nerf.md
diff --git a/docs/tutorials/data/creating_dataset.md → docs/quickstart/custom_dataset.md b/docs/tutorials/data/creating_dataset.md → docs/quickstart/custom_dataset.md
@@ -1,4 +1,4 @@
-# Using custom data
+# Using Custom Data
 
 Training model on existing datasets is only so fun. If you would like to train on self captured data you will need to process the data into an existing format. Specifically we need to know the camera poses for each image. [COLMAP](https://github.com/colmap/colmap) is a standard tool for extracting poses. It is possible to use other methods like [SLAM](https://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping) or hardware recorded poses. We intend to add documentation for these other methods in the future.
 

diff --git a/docs/tutorials/quickstart.md → docs/quickstart/first_nerf.md b/docs/tutorials/quickstart.md → docs/quickstart/first_nerf.md
@@ -1,63 +1,8 @@
-# Installation
+# Training First Model
 
-### Create environment
+## Downloading data
 
-We reccomend using conda to manage dependencies. Make sure to install [Conda](https://docs.conda.io/en/latest/miniconda.html) before preceding.
-
-```bash
-conda create --name nerfstudio -y python=3.8.13
-conda activate nerfstudio
-python -m pip install --upgrade pip
-
-```
-
-### Dependencies
-
-Install pytorch with CUDA (this repo has been tested with CUDA 11.3) and [tiny-cuda-nn](https://github.com/NVlabs/tiny-cuda-nn)
-
-```bash
-pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 -f https://download.pytorch.org/whl/torch_stable.html
-pip install git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindings/torch
-
-```
-
-### Installing nerfstudio
-
-Easy option:
-
-```bash
-pip install nerfstudio
-```
-
-If you would want the latest and greatest:
-
-```bash
-git clone [email protected]:plenoptix/nerfstudio.git
-cd nerfstudio
-pip install -e .
-
-```
-
-### Optional Installs
-
-#### Tab completion (bash & zsh)
-
-This needs to be rerun when the CLI changes, for example if nerfstudio is updated.
-
-```bash
-ns-install-cli
-```
-
-### Development packages
-
-```bash
-pip install -e.[dev]
-pip install -e.[docs]
-```
-
-# Downloading data
-
-Download the original NeRF Blender dataset. We support the major datasets and allow users to create their own dataset, described in detail [here](https://docs.nerf.studio/en/latest/tutorials/data/index.html).
+Download the original NeRF Blender dataset. We support the major datasets and allow users to create their own dataset, described in detail [here TODO].
 
 ```
 ns-download-data --dataset=blender
@@ -78,7 +23,7 @@ Use `--help` to view all currently available datasets. The resulting script shou
          ...
 ```
 
-# Training a model
+## Training a model
 
 To run with all the defaults, e.g. vanilla nerf method with the blender lego image
 
@@ -100,27 +45,27 @@ Run with nerfstudio data. You'll may have to change the ports, and be sure to fo
 ns-train nerfacto --vis viewer --viewer.zmq-port 8001 --viewer.websocket-port 8002 nerfstudio-data --pipeline.datamanager.dataparser.data-directory data/nerfstudio/poster --pipeline.datamanager.dataparser.downscale-factor 4
 ```
 
-# Visualizing training runs
+## Visualizing training runs
 
-If you using a fast NeRF variant (ie. Instant-NGP), we reccomend using our viewer. See our [viewer docs](../tutorials/viewer/viewer_quickstart.md) for more details. The viewer will allow interactive visualization of training in realtime.
+If you using a fast NeRF variant (ie. Instant-NGP), we reccomend using our viewer. See our [viewer docs](viewer_quickstart.md) for more details. The viewer will allow interactive visualization of training in realtime.
 
 Additionally, if you run everything with the default configuration, by default, we use [TensorBoard](https://www.tensorflow.org/tensorboard) to log all training curves, test images, and other stats. Once the job is launched, you will be able to track training by launching the tensorboard in `outputs/blender_lego/vanilla_nerf/<timestamp>/<events.tfevents>`.
 
 ```bash
 tensorboard --logdir outputs
 ```
 
-# Rendering a Trajectory
+## Rendering a Trajectory
 
-To evaluate the trained NeRF, we provide an evaluation script that allows you to do benchmarking (see our [benchmarking workflow](../tooling/benchmarking.md)) or to render out the scene with a custom trajectory and save the output to a video.
+To evaluate the trained NeRF, we provide an evaluation script that allows you to do benchmarking (see our [benchmarking workflow](../developer_guides/benchmarking.md)) or to render out the scene with a custom trajectory and save the output to a video.
 
 ```bash
 ns-eval render-trajectory --load-config=outputs/blender_lego/instant_ngp/2022-07-07_230905/config.yml --traj=spiral --output-path=output.mp4
 ```
 
-Please note, this quickstart allows you to preform everything in a headless manner. We also provide a web-based viewer that allows you to easily monitor training or render out trajectories. See our [viewer docs](../tutorials/viewer/viewer_quickstart.md) for more.
+Please note, this quickstart allows you to preform everything in a headless manner. We also provide a web-based viewer that allows you to easily monitor training or render out trajectories. See our [viewer docs](viewer_quickstart.md) for more.
 
-# FAQ
+## FAQ
 
 - [TinyCUDA installation errors out with cuda mismatch](tiny-cuda-error)
 

diff --git a/docs/quickstart/installation.md b/docs/quickstart/installation.md
@@ -0,0 +1,56 @@
+# Installation
+
+### Create environment
+
+We reccomend using conda to manage dependencies. Make sure to install [Conda](https://docs.conda.io/en/latest/miniconda.html) before preceding.
+
+```bash
+conda create --name nerfstudio -y python=3.8.13
+conda activate nerfstudio
+python -m pip install --upgrade pip
+
+```
+
+### Dependencies
+
+Install pytorch with CUDA (this repo has been tested with CUDA 11.3) and [tiny-cuda-nn](https://github.com/NVlabs/tiny-cuda-nn)
+
+```bash
+pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 -f https://download.pytorch.org/whl/torch_stable.html
+pip install git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindings/torch
+
+```
+
+### Installing nerfstudio
+
+Easy option:
+
+```bash
+pip install nerfstudio
+```
+
+If you would want the latest and greatest:
+
+```bash
+git clone [email protected]:plenoptix/nerfstudio.git
+cd nerfstudio
+pip install -e .
+
+```
+
+### Optional Installs
+
+#### Tab completion (bash & zsh)
+
+This needs to be rerun when the CLI changes, for example if nerfstudio is updated.
+
+```bash
+ns-install-cli
+```
+
+### Development packages
+
+```bash
+pip install -e.[dev]
+pip install -e.[docs]
+```
diff --git a/docs/quickstart/viewer_quickstart.md b/docs/quickstart/viewer_quickstart.md
@@ -0,0 +1 @@
+# Setting up Viewer
diff --git a/docs/tooling/index.rst b/docs/tooling/index.rst
diff --git a/docs/tutorials/data/index.rst b/docs/tutorials/data/index.rst
diff --git a/docs/tutorials/data/media/creating_dataset_visualize_dataset.png b/docs/tutorials/data/media/creating_dataset_visualize_dataset.png
diff --git a/docs/tutorials/quickstart_index.rst b/docs/tutorials/quickstart_index.rst