undo docs change

This commit is contained in:
terrance committed 2023-05-12 18:47:13 +00:00
1 parent a0c38e8430
commit c9151d4a90
21 files changed
+7547 -7568

No files matched your search

+22 -1
View File
@@ -7,4 +7,25 @@ Base
----------------
.. automodule:: nerfstudio.data.datamanagers.base_datamanager
:members:
:members:
Depth Datamanager
-----------------
.. automodule:: nerfstudio.data.datamanagers.depth_datamanager
:members:
:show-inheritance:
SDF Datamanager
----------------
.. automodule:: nerfstudio.data.datamanagers.sdf_datamanager
:members:
:show-inheritance:
Semantic Datamanager
---------------------
.. automodule:: nerfstudio.data.datamanagers.semantic_datamanager
:members:
:show-inheritance:
+10 -10
View File
@@ -6,16 +6,16 @@ We provide a command line interface for training your own NeRFs (no coding neces
Here are the popular commands that we offer. If you've cloned the repo, you can also look at the [pyproject.toml file](https://github.com/nerfstudio-project/nerfstudio/blob/main/pyproject.toml) at the `[project.scripts]` section for details.
| Command | Description | Filename |
| ------------------------------------ | -------------------------------------- | --------------------------------------------- |
| [ns-install-cli](ns_install_cli) | Install tab completion for all scripts | nerfstudio/scripts/completions/install.py |
| [ns-process-data](ns_process_data) | Generate a dataset from your own data | nerfstudio/scripts/process_data.py |
| [ns-download-data](ns_download_data) | Download existing captures | nerfstudio/scripts/downloads/download_data.py |
| [ns-train](ns_train) | Generate a NeRF | nerfstudio/scripts/train.py |
| [ns-viewer](ns_viewer) | View a trained NeRF | nerfstudio/scripts/viewer/run_viewer.py |
| [ns-eval](ns_eval) | Run evaluation metrics for your Model | nerfstudio/scripts/eval.py |
| [ns-render](ns_render) | Render out a video of your NeRF | nerfstudio/scripts/render.py |
| [ns-export](ns_export) | Export a NeRF into other formats | nerfstudio/scripts/exporter.py |
| Command | Description | Filename |
| ------------------------------------ | -------------------------------------- | ---------------------------------- |
| [ns-install-cli](ns_install_cli) | Install tab completion for all scripts | scripts/completions/install.py |
| [ns-process-data](ns_process_data) | Generate a dataset from your own data | scripts/process_data.py |
| [ns-download-data](ns_download_data) | Download existing captures | scripts/downloads/download_data.py |
| [ns-train](ns_train) | Generate a NeRF | scripts/train.py |
| [ns-viewer](ns_viewer) | View a trained NeRF | scripts/viewer/run_viewer.py |
| [ns-eval](ns_eval) | Run evaluation metrics for your Model | scripts/eval.py |
| [ns-render](ns_render) | Render out a video of your NeRF | scripts/render.py |
| [ns-export](ns_export) | Export a NeRF into other formats | scripts/exporter.py |
```{toctree}
:maxdepth: 1
+1 -1
View File
@@ -2,7 +2,7 @@
```{eval-rst}
.. argparse::
:module: nerfstudio.scripts.downloads.download_data
:module: scripts.downloads.download_data
:func: get_parser_fn
:prog: ns-download-data
:nodefault:
+1 -1
View File
@@ -2,7 +2,7 @@
```{eval-rst}
.. argparse::
:module: nerfstudio.scripts.eval
:module: scripts.eval
:func: get_parser_fn
:prog: ns-eval
:nodefault:
+1 -1
View File
@@ -2,7 +2,7 @@
```{eval-rst}
.. argparse::
:module: nerfstudio.scripts.exporter
:module: scripts.exporter
:func: get_parser_fn
:prog: ns-export
:nodefault:
+1 -1
View File
@@ -2,7 +2,7 @@
```{eval-rst}
.. argparse::
:module: nerfstudio.scripts.completions.install
:module: scripts.completions.install
:func: get_parser_fn
:prog: ns-install-cli
:nodefault:
+1 -1
View File
@@ -8,7 +8,7 @@ You may also want to install [hloc](https://github.com/cvg/Hierarchical-Localiza
```{eval-rst}
.. argparse::
:module: nerfstudio.scripts.process_data
:module: scripts.process_data
:func: get_parser_fn
:prog: ns-process-data
:nodefault:
+1 -1
View File
@@ -7,7 +7,7 @@ Make sure to have [FFmpeg](https://ffmpeg.org/download.html) installed.
```{eval-rst}
.. argparse::
:module: nerfstudio.scripts.render
:module: scripts.render
:func: get_parser_fn
:prog: ns-render
:nodefault:
+1 -1
View File
@@ -2,7 +2,7 @@
```{eval-rst}
.. argparse::
:module: nerfstudio.scripts.viewer.run_viewer
:module: scripts.viewer.run_viewer
:func: get_parser_fn
:prog: ns-viewer
:nodefault:
+9 -10
View File
@@ -7,14 +7,13 @@ Below, we document the contribution pipeline and good-to-knows for when you're r
The project is set up for development in VSCode, we recommend using it if you plan to contribute.
## Overview
Below are the various tooling features our team uses to maintain this codebase.
| Tooling | Support |
| --------------- | ---------------------------------------------------------- |
| Linter | [Black](https://black.readthedocs.io/en/stable/) |
| Testing | [PyTest](https://docs.pytest.org/en/7.1.x/) |
| Docs | [Sphinx](https://www.sphinx-doc.org/en/master/) |
| Tooling | Support |
| --------------- | ------------- |
| Linter | [Black](https://black.readthedocs.io/en/stable/) |
| Testing | [PyTest](https://docs.pytest.org/en/7.1.x/) |
| Docs | [Sphinx](https://www.sphinx-doc.org/en/master/) |
| Docstring style | [Google](https://google.github.io/styleguide/pyguide.html) |
## Requirements
@@ -54,8 +53,8 @@ conda install -c conda-forge pandoc
:::{admonition} Attention
:class: attention
In order to merge changes to the code base, all of these checks must be passing. If you pass these tests locally, you will likely pass on github servers as well (results in a green checkmark next to your commit).
:::
In order to merge changes to the code base, all of these checks must be passing. If you pass these tests locally, you will likely pass on github servers as well (results in a green checkmark next to your commit).
:::
3. Open pull request! 💌
@@ -66,7 +65,7 @@ conda install -c conda-forge pandoc
Run the following to build the documentation:
```bash
python nerfstudio/scripts/docs/build_docs.py
python scripts/docs/build_docs.py
```
:::{admonition} Tip
@@ -85,7 +84,7 @@ If you want the code to build on save you can use [sphinx autobuild](https://git
:class: info
If changes to the structure are made, the build files may be incorrect.
:::
:::
```bash
pip install sphinx-autobuild