diff --git a/docs/tooling/benchmarking.md b/docs/developer_guides/benchmarking.md similarity index 100% rename from docs/tooling/benchmarking.md rename to docs/developer_guides/benchmarking.md diff --git a/docs/tooling/config.md b/docs/developer_guides/config.md similarity index 100% rename from docs/tooling/config.md rename to docs/developer_guides/config.md diff --git a/docs/tooling/logging_profiling.md b/docs/developer_guides/logging_profiling.md similarity index 100% rename from docs/tooling/logging_profiling.md rename to docs/developer_guides/logging_profiling.md diff --git a/docs/tutorials/pipelines/creating_new_methods.ipynb b/docs/developer_guides/pipelines/creating_new_methods.ipynb similarity index 100% rename from docs/tutorials/pipelines/creating_new_methods.ipynb rename to docs/developer_guides/pipelines/creating_new_methods.ipynb diff --git a/docs/tutorials/pipelines/datamanagers.ipynb b/docs/developer_guides/pipelines/datamanagers.ipynb similarity index 100% rename from docs/tutorials/pipelines/datamanagers.ipynb rename to docs/developer_guides/pipelines/datamanagers.ipynb diff --git a/docs/tutorials/pipelines/dataparsers.ipynb b/docs/developer_guides/pipelines/dataparsers.ipynb similarity index 100% rename from docs/tutorials/pipelines/dataparsers.ipynb rename to docs/developer_guides/pipelines/dataparsers.ipynb diff --git a/docs/tutorials/pipelines/imgs/datamanagers.png b/docs/developer_guides/pipelines/imgs/datamanagers.png similarity index 100% rename from docs/tutorials/pipelines/imgs/datamanagers.png rename to docs/developer_guides/pipelines/imgs/datamanagers.png diff --git a/docs/tutorials/pipelines/imgs/dataparsers.png b/docs/developer_guides/pipelines/imgs/dataparsers.png similarity index 100% rename from docs/tutorials/pipelines/imgs/dataparsers.png rename to docs/developer_guides/pipelines/imgs/dataparsers.png diff --git a/docs/tutorials/pipelines/imgs/models.png b/docs/developer_guides/pipelines/imgs/models.png similarity index 100% rename from docs/tutorials/pipelines/imgs/models.png rename to docs/developer_guides/pipelines/imgs/models.png diff --git a/docs/tutorials/pipelines/imgs/pipelines.png b/docs/developer_guides/pipelines/imgs/pipelines.png similarity index 100% rename from docs/tutorials/pipelines/imgs/pipelines.png rename to docs/developer_guides/pipelines/imgs/pipelines.png diff --git a/docs/tutorials/pipelines/imgs/pipelines_overview.png b/docs/developer_guides/pipelines/imgs/pipelines_overview.png similarity index 100% rename from docs/tutorials/pipelines/imgs/pipelines_overview.png rename to docs/developer_guides/pipelines/imgs/pipelines_overview.png diff --git a/docs/tutorials/pipelines/index.rst b/docs/developer_guides/pipelines/index.rst similarity index 100% rename from docs/tutorials/pipelines/index.rst rename to docs/developer_guides/pipelines/index.rst diff --git a/docs/tutorials/pipelines/models.ipynb b/docs/developer_guides/pipelines/models.ipynb similarity index 95% rename from docs/tutorials/pipelines/models.ipynb rename to docs/developer_guides/pipelines/models.ipynb index 8fdf48530..b1dfbe57b 100644 --- a/docs/tutorials/pipelines/models.ipynb +++ b/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 b/docs/developer_guides/pipelines/pipelines.ipynb similarity index 100% rename from docs/tutorials/pipelines/pipelines.ipynb rename to docs/developer_guides/pipelines/pipelines.ipynb diff --git a/docs/tutorials/viewer/faq.md b/docs/developer_guides/viewer/faq.md similarity index 100% rename from docs/tutorials/viewer/faq.md rename to docs/developer_guides/viewer/faq.md diff --git a/docs/tutorials/viewer/for_developers.md b/docs/developer_guides/viewer/for_developers.md similarity index 100% rename from docs/tutorials/viewer/for_developers.md rename to docs/developer_guides/viewer/for_developers.md diff --git a/docs/tutorials/viewer/imgs/bulldozer.png b/docs/developer_guides/viewer/imgs/bulldozer.png similarity index 100% rename from docs/tutorials/viewer/imgs/bulldozer.png rename to docs/developer_guides/viewer/imgs/bulldozer.png diff --git a/docs/tutorials/viewer/imgs/nerfviewer.png b/docs/developer_guides/viewer/imgs/nerfviewer.png similarity index 100% rename from docs/tutorials/viewer/imgs/nerfviewer.png rename to docs/developer_guides/viewer/imgs/nerfviewer.png diff --git a/docs/tutorials/viewer/imgs/viewer_figure.png b/docs/developer_guides/viewer/imgs/viewer_figure.png similarity index 100% rename from docs/tutorials/viewer/imgs/viewer_figure.png rename to docs/developer_guides/viewer/imgs/viewer_figure.png diff --git a/docs/tutorials/viewer/index.rst b/docs/developer_guides/viewer/index.rst similarity index 100% rename from docs/tutorials/viewer/index.rst rename to docs/developer_guides/viewer/index.rst diff --git a/docs/tutorials/viewer/viewer_notebook.ipynb b/docs/developer_guides/viewer/viewer_notebook.ipynb similarity index 100% rename from docs/tutorials/viewer/viewer_notebook.ipynb rename to docs/developer_guides/viewer/viewer_notebook.ipynb diff --git a/docs/tutorials/viewer/viewer_quickstart.md b/docs/developer_guides/viewer/viewer_quickstart.md similarity index 100% rename from docs/tutorials/viewer/viewer_quickstart.md rename to docs/developer_guides/viewer/viewer_quickstart.md diff --git a/docs/guides/index.rst b/docs/guides/index.rst deleted file mode 100644 index 7ad957e8d..000000000 --- a/docs/guides/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -Interactive Guides ------------------- - -Want to learn more about NeRFs and how they work? You're at the right spot! - -Here, we decompose each of the pre-implemented NeRF modules- from how the data's loaded to how the model operates-in an easy to understand way. -Interact with the notebooks to gain a visual intuition for each component. -Check back in regularly as the technology continues to develop with new modules! - -.. toctree:: - :maxdepth: 1 - - models/index - model_components/index - dataloader_components/index \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index e03358ca3..4f2478684 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,22 +36,29 @@ Contents :hidden: :caption: Getting Started - Quickstart - tutorials/data/index - tutorials/pipelines/index - tutorials/viewer/index + quickstart/installation + quickstart/first_nerf + quickstart/custom_dataset + quickstart/viewer_quickstart + Contributing .. 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: @@ -59,7 +66,6 @@ Contents reference/cli/index reference/api/index - Contributing diff --git a/docs/guides/dataloader_components/incrementally_add_cameras.ipynb b/docs/nerfology/dataloader_components/incrementally_add_cameras.ipynb similarity index 100% rename from docs/guides/dataloader_components/incrementally_add_cameras.ipynb rename to docs/nerfology/dataloader_components/incrementally_add_cameras.ipynb diff --git a/docs/guides/dataloader_components/index.md b/docs/nerfology/dataloader_components/index.md similarity index 100% rename from docs/guides/dataloader_components/index.md rename to docs/nerfology/dataloader_components/index.md diff --git a/docs/guides/dataloader_components/pixel_sampling_strategies.ipynb b/docs/nerfology/dataloader_components/pixel_sampling_strategies.ipynb similarity index 100% rename from docs/guides/dataloader_components/pixel_sampling_strategies.ipynb rename to docs/nerfology/dataloader_components/pixel_sampling_strategies.ipynb diff --git a/docs/guides/model_components/imgs/frustums-dark.png b/docs/nerfology/model_components/imgs/frustums-dark.png similarity index 100% rename from docs/guides/model_components/imgs/frustums-dark.png rename to docs/nerfology/model_components/imgs/frustums-dark.png diff --git a/docs/guides/model_components/imgs/frustums.png b/docs/nerfology/model_components/imgs/frustums.png similarity index 100% rename from docs/guides/model_components/imgs/frustums.png rename to docs/nerfology/model_components/imgs/frustums.png diff --git a/docs/guides/model_components/imgs/samplers_stratified-dark.png b/docs/nerfology/model_components/imgs/samplers_stratified-dark.png similarity index 100% rename from docs/guides/model_components/imgs/samplers_stratified-dark.png rename to docs/nerfology/model_components/imgs/samplers_stratified-dark.png diff --git a/docs/guides/model_components/imgs/samplers_stratified-light.png b/docs/nerfology/model_components/imgs/samplers_stratified-light.png similarity index 100% rename from docs/guides/model_components/imgs/samplers_stratified-light.png rename to docs/nerfology/model_components/imgs/samplers_stratified-light.png diff --git a/docs/guides/model_components/imgs/samplers_type-dark.png b/docs/nerfology/model_components/imgs/samplers_type-dark.png similarity index 100% rename from docs/guides/model_components/imgs/samplers_type-dark.png rename to docs/nerfology/model_components/imgs/samplers_type-dark.png diff --git a/docs/guides/model_components/imgs/samplers_type-light.png b/docs/nerfology/model_components/imgs/samplers_type-light.png similarity index 100% rename from docs/guides/model_components/imgs/samplers_type-light.png rename to docs/nerfology/model_components/imgs/samplers_type-light.png diff --git a/docs/guides/model_components/index.md b/docs/nerfology/model_components/index.md similarity index 100% rename from docs/guides/model_components/index.md rename to docs/nerfology/model_components/index.md diff --git a/docs/guides/model_components/visualize_cameras.ipynb b/docs/nerfology/model_components/visualize_cameras.ipynb similarity index 100% rename from docs/guides/model_components/visualize_cameras.ipynb rename to docs/nerfology/model_components/visualize_cameras.ipynb diff --git a/docs/guides/model_components/visualize_encoders.ipynb b/docs/nerfology/model_components/visualize_encoders.ipynb similarity index 100% rename from docs/guides/model_components/visualize_encoders.ipynb rename to docs/nerfology/model_components/visualize_encoders.ipynb diff --git a/docs/guides/model_components/visualize_samplers.ipynb b/docs/nerfology/model_components/visualize_samplers.ipynb similarity index 100% rename from docs/guides/model_components/visualize_samplers.ipynb rename to docs/nerfology/model_components/visualize_samplers.ipynb diff --git a/docs/guides/model_components/visualize_samples.ipynb b/docs/nerfology/model_components/visualize_samples.ipynb similarity index 100% rename from docs/guides/model_components/visualize_samples.ipynb rename to docs/nerfology/model_components/visualize_samples.ipynb diff --git a/docs/guides/model_components/visualize_spatial_distortions.ipynb b/docs/nerfology/model_components/visualize_spatial_distortions.ipynb similarity index 100% rename from docs/guides/model_components/visualize_spatial_distortions.ipynb rename to docs/nerfology/model_components/visualize_spatial_distortions.ipynb diff --git a/docs/guides/models/imgs/mipnerf/models_mipnerf_field-dark.png b/docs/nerfology/models/imgs/mipnerf/models_mipnerf_field-dark.png similarity index 100% rename from docs/guides/models/imgs/mipnerf/models_mipnerf_field-dark.png rename to docs/nerfology/models/imgs/mipnerf/models_mipnerf_field-dark.png diff --git a/docs/guides/models/imgs/mipnerf/models_mipnerf_field-light.png b/docs/nerfology/models/imgs/mipnerf/models_mipnerf_field-light.png similarity index 100% rename from docs/guides/models/imgs/mipnerf/models_mipnerf_field-light.png rename to docs/nerfology/models/imgs/mipnerf/models_mipnerf_field-light.png diff --git a/docs/guides/models/imgs/mipnerf/models_mipnerf_pipeline-dark.png b/docs/nerfology/models/imgs/mipnerf/models_mipnerf_pipeline-dark.png similarity index 100% rename from docs/guides/models/imgs/mipnerf/models_mipnerf_pipeline-dark.png rename to docs/nerfology/models/imgs/mipnerf/models_mipnerf_pipeline-dark.png diff --git a/docs/guides/models/imgs/mipnerf/models_mipnerf_pipeline-light.png b/docs/nerfology/models/imgs/mipnerf/models_mipnerf_pipeline-light.png similarity index 100% rename from docs/guides/models/imgs/mipnerf/models_mipnerf_pipeline-light.png rename to docs/nerfology/models/imgs/mipnerf/models_mipnerf_pipeline-light.png diff --git a/docs/guides/models/imgs/models_nerf-field-dark.png b/docs/nerfology/models/imgs/models_nerf-field-dark.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-field-dark.png rename to docs/nerfology/models/imgs/models_nerf-field-dark.png diff --git a/docs/guides/models/imgs/models_nerf-field-light.png b/docs/nerfology/models/imgs/models_nerf-field-light.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-field-light.png rename to docs/nerfology/models/imgs/models_nerf-field-light.png diff --git a/docs/guides/models/imgs/models_nerf-pipeline-dark.png b/docs/nerfology/models/imgs/models_nerf-pipeline-dark.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-pipeline-dark.png rename to docs/nerfology/models/imgs/models_nerf-pipeline-dark.png diff --git a/docs/guides/models/imgs/models_nerf-pipeline-field-dark.png b/docs/nerfology/models/imgs/models_nerf-pipeline-field-dark.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-pipeline-field-dark.png rename to docs/nerfology/models/imgs/models_nerf-pipeline-field-dark.png diff --git a/docs/guides/models/imgs/models_nerf-pipeline-field-light.png b/docs/nerfology/models/imgs/models_nerf-pipeline-field-light.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-pipeline-field-light.png rename to docs/nerfology/models/imgs/models_nerf-pipeline-field-light.png diff --git a/docs/guides/models/imgs/models_nerf-pipeline-light.png b/docs/nerfology/models/imgs/models_nerf-pipeline-light.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-pipeline-light.png rename to docs/nerfology/models/imgs/models_nerf-pipeline-light.png diff --git a/docs/guides/models/imgs/models_nerf-pipeline-renderer-dark.png b/docs/nerfology/models/imgs/models_nerf-pipeline-renderer-dark.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-pipeline-renderer-dark.png rename to docs/nerfology/models/imgs/models_nerf-pipeline-renderer-dark.png diff --git a/docs/guides/models/imgs/models_nerf-pipeline-renderer-light.png b/docs/nerfology/models/imgs/models_nerf-pipeline-renderer-light.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-pipeline-renderer-light.png rename to docs/nerfology/models/imgs/models_nerf-pipeline-renderer-light.png diff --git a/docs/guides/models/imgs/models_nerf-pipeline-sampler-dark.png b/docs/nerfology/models/imgs/models_nerf-pipeline-sampler-dark.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-pipeline-sampler-dark.png rename to docs/nerfology/models/imgs/models_nerf-pipeline-sampler-dark.png diff --git a/docs/guides/models/imgs/models_nerf-pipeline-sampler-light.png b/docs/nerfology/models/imgs/models_nerf-pipeline-sampler-light.png similarity index 100% rename from docs/guides/models/imgs/models_nerf-pipeline-sampler-light.png rename to docs/nerfology/models/imgs/models_nerf-pipeline-sampler-light.png diff --git a/docs/guides/models/index.md b/docs/nerfology/models/index.md similarity index 100% rename from docs/guides/models/index.md rename to docs/nerfology/models/index.md diff --git a/docs/guides/models/instant_ngp.md b/docs/nerfology/models/instant_ngp.md similarity index 100% rename from docs/guides/models/instant_ngp.md rename to docs/nerfology/models/instant_ngp.md diff --git a/docs/guides/models/mipnerf.md b/docs/nerfology/models/mipnerf.md similarity index 100% rename from docs/guides/models/mipnerf.md rename to docs/nerfology/models/mipnerf.md diff --git a/docs/guides/models/mipnerf_360.md b/docs/nerfology/models/mipnerf_360.md similarity index 100% rename from docs/guides/models/mipnerf_360.md rename to docs/nerfology/models/mipnerf_360.md diff --git a/docs/guides/models/nerf.md b/docs/nerfology/models/nerf.md similarity index 100% rename from docs/guides/models/nerf.md rename to docs/nerfology/models/nerf.md diff --git a/docs/guides/models/nerf_w.md b/docs/nerfology/models/nerf_w.md similarity index 100% rename from docs/guides/models/nerf_w.md rename to docs/nerfology/models/nerf_w.md diff --git a/docs/guides/models/semantic_nerf.md b/docs/nerfology/models/semantic_nerf.md similarity index 100% rename from docs/guides/models/semantic_nerf.md rename to docs/nerfology/models/semantic_nerf.md diff --git a/docs/tutorials/data/creating_dataset.md b/docs/quickstart/custom_dataset.md similarity index 99% rename from docs/tutorials/data/creating_dataset.md rename to docs/quickstart/custom_dataset.md index 57133e743..d5c6f4204 100644 --- a/docs/tutorials/data/creating_dataset.md +++ b/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 b/docs/quickstart/first_nerf.md similarity index 68% rename from docs/tutorials/quickstart.md rename to docs/quickstart/first_nerf.md index f169d8606..2ce77e3e3 100644 --- a/docs/tutorials/quickstart.md +++ b/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 git@github.com: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,9 +45,9 @@ 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//`. @@ -110,17 +55,17 @@ Additionally, if you run everything with the default configuration, by default, 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 new file mode 100644 index 000000000..ffd78dcd1 --- /dev/null +++ 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 git@github.com: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 new file mode 100644 index 000000000..b6a15852a --- /dev/null +++ b/docs/quickstart/viewer_quickstart.md @@ -0,0 +1 @@ +# Setting up Viewer diff --git a/docs/tooling/index.rst b/docs/tooling/index.rst deleted file mode 100644 index fe1c92e8f..000000000 --- a/docs/tooling/index.rst +++ /dev/null @@ -1,8 +0,0 @@ - -.. toctree:: - :maxdepth: 1 - - config.md - logging_profiling.md - benchmarking.md - diff --git a/docs/tutorials/data/index.rst b/docs/tutorials/data/index.rst deleted file mode 100644 index fde6bf107..000000000 --- a/docs/tutorials/data/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Data Setup ----------- - -.. toctree:: - :maxdepth: 1 - - creating_dataset.md diff --git a/docs/tutorials/data/media/creating_dataset_visualize_dataset.png b/docs/tutorials/data/media/creating_dataset_visualize_dataset.png deleted file mode 100644 index bc4338d47..000000000 Binary files a/docs/tutorials/data/media/creating_dataset_visualize_dataset.png and /dev/null differ diff --git a/docs/tutorials/quickstart_index.rst b/docs/tutorials/quickstart_index.rst deleted file mode 100644 index dd2d27ede..000000000 --- a/docs/tutorials/quickstart_index.rst +++ /dev/null @@ -1,35 +0,0 @@ - -| - -.. image:: ../_static/imgs/logo.png - :width: 400 - :align: center - :alt: nerfstudio - :class: only-light - -.. image:: ../_static/imgs/logo-dark.png - :width: 400 - :align: center - :alt: nerfstudio - :class: only-dark - - -Neural Volumetric Rendering -""""""""""""""""""""""""""""" - -All-in-one repository for state-of-the-art NeRFs. - -nerfstudio provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs. -The library supports a more interpretable implementation of NeRFs by modularizing each component. -With more modular NeRFs, not only does your code become far more user-friendly, but using this framework also makes it easier for the community to build upon your implementation. - - -# TODO: high level summary of what is in the quickstart tabs. - -Quickstart ------------ - -.. toctree:: - :maxdepth: 1 - - quickstart.md \ No newline at end of file