Update cli docs (#674)

This commit is contained in:
Matthew Tancik authored and GitHub committed 2022-10-04 22:11:02 -07:00
1 parent a6ad3a40c4
commit e01206f728
7 files changed
+67 -17

No files matched your search

+31
View File
@@ -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
```