mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-15 04:13:57 +08:00
Update cli docs (#674)
This commit is contained in:
1 parent
a6ad3a40c4
commit
e01206f728
7 files changed
+67
-17
No files matched your search
@@ -0,0 +1,25 @@
|
||||
# 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
|
||||
|
||||
| Command | Description |
|
||||
| ---------------- | ------------------------------------------------ |
|
||||
| ns_process_data | Generate a dataset from your own photos or video |
|
||||
| ns_download_data | Download existing captures |
|
||||
| ns_train | Generate a NeRF |
|
||||
| ns_render | Render out a video of your NeRF |
|
||||
| ns_eval | Run evaluation metrics for your Model |
|
||||
| ns_install_cli | Install tab completion for all scripts |
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
ns_process_data
|
||||
ns_download_data
|
||||
ns_train
|
||||
ns_render
|
||||
ns_eval
|
||||
```
|
||||
@@ -1,12 +0,0 @@
|
||||
.. _cli:
|
||||
|
||||
CLI
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ns_process_data
|
||||
ns_download_data
|
||||
ns_render
|
||||
ns_eval
|
||||
@@ -4,6 +4,6 @@
|
||||
.. argparse::
|
||||
:module: scripts.downloads.download_data
|
||||
:func: get_parser_fn
|
||||
:prog: ns-process-data
|
||||
:prog: ns-download-data
|
||||
:nodefault:
|
||||
```
|
||||
@@ -4,6 +4,6 @@
|
||||
.. argparse::
|
||||
:module: scripts.eval
|
||||
:func: get_parser_fn
|
||||
:prog: ns-process-data
|
||||
:prog: ns-eval
|
||||
:nodefault:
|
||||
```
|
||||
@@ -9,6 +9,6 @@ Make sure to have [FFmpeg](https://ffmpeg.org/download.html) installed.
|
||||
.. argparse::
|
||||
:module: scripts.render
|
||||
:func: get_parser_fn
|
||||
:prog: ns-process-data
|
||||
:prog: ns-render
|
||||
:nodefault:
|
||||
```
|
||||
@@ -0,0 +1,31 @@
|
||||
# ns-train
|
||||
|
||||
Primary interface for training a NeRF model. `--help` is your friend when navigating command arguments. We also recommend installing the tab completion `ns-install-cli`.
|
||||
|
||||
```bash
|
||||
usage: ns-train {method} [method args] {dataparser} [dataparser args]
|
||||
```
|
||||
|
||||
If you are using a nerfstudio data set, the minimal command is:
|
||||
|
||||
```bash
|
||||
ns-train nerfacto --data YOUR_DATA
|
||||
```
|
||||
|
||||
To learn about the available methods:
|
||||
|
||||
```bash
|
||||
ns-train --help
|
||||
```
|
||||
|
||||
To learn about a methods parameters:
|
||||
|
||||
```bash
|
||||
ns-train {method} --help
|
||||
```
|
||||
|
||||
By default the nerfstudio dataparser is used. If you would like to use a different dataparser it can be specified after all of the method arguments. For a list of dataparser options:
|
||||
|
||||
```bash
|
||||
ns-train {method} {dataparser} --help
|
||||
```
|
||||
Reference in new issue
Block a user