4
0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-11 02:24:38 +08:00
nerfstudio/docs/reference/cli/index.md
2022-10-11 14:26:42 -07:00

28 lines
1.4 KiB
Markdown

# CLI
We provide a command line interface for training your own NeRFs (no coding necessary). You can learn more about each command by using the `--help` argument.
## Commands
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 photos or video | scripts/process_data.py |
| ns-download-data | Download existing captures | scripts/downloads/download_data.py |
| ns-train | Generate a NeRF | scripts/train.py |
| ns-eval | Run evaluation metrics for your Model | scripts/eval.py |
| ns-render | Render out a video of your NeRF | scripts/render.py |
```{toctree}
:maxdepth: 1
:hidden:
ns_process_data
ns_download_data
ns_train
ns_render
ns_eval
```