tink/nerfstudio
4
0 Fork 0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-13 03:14:00 +08:00
Code Activity

Update sphinx docs (#1695)

Browse Source
This commit is contained in:
Matthew Tancik authored and GitHub committed 2023-04-04 11:08:09 -07:00
1 parent f6b67a0ad0
commit 4e6c52c8fd
4 files changed
+44 -10
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/reference/cli/index.md
+11 -10
View File
@@ -6,21 +6,22 @@ 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 | Install tab completion for all scripts | scripts/completions/install.py |
| ns-process-data | Generate a dataset from your own data | scripts/process_data.py |
| ns-download-data | Download existing captures | scripts/downloads/download_data.py |
| ns-train | Generate a NeRF | scripts/train.py |
| ns-viewer | View a trained NeRF | scripts/viewer/run_viewer.py |
| ns-eval | Run evaluation metrics for your Model | scripts/eval.py |
| ns-render | Render out a video of your NeRF | scripts/render.py |
| ns-export | Export a NeRF into other formats | 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
:hidden:
ns_install_cli
ns_process_data
ns_download_data
ns_train
docs/reference/cli/ns_install_cli.md
+9
View File
@@ -0,0 +1,9 @@
# ns-install-cli
```{eval-rst}
.. argparse::
:module: scripts.completions.install
:func: get_parser_fn
:prog: ns-install-cli
:nodefault:
```