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 at the [project.scripts] section for details.

Command

Description

Filename

ns-install-cli

Install tab completion for all scripts

nerfstudio/scripts/completions/install.py

ns-process-data

Generate a dataset from your own data

nerfstudio/scripts/process_data.py

ns-download-data

Download existing captures

nerfstudio/scripts/downloads/download_data.py

ns-train

Generate a NeRF

nerfstudio/scripts/train.py

ns-viewer

View a trained NeRF

nerfstudio/scripts/viewer/run_viewer.py

ns-eval

Run evaluation metrics for your Model

nerfstudio/scripts/eval.py

ns-render

Render out a video of your NeRF

nerfstudio/scripts/render.py

ns-export

Export a NeRF into other formats

nerfstudio/scripts/exporter.py