Pushing more introduction docs (#683)

* Pushing more introduction docs
This commit is contained in:
Jake Austin authored and GitHub committed 2022-10-05 01:50:49 -07:00
1 parent 464f05f0af
commit a95bb2d611
4 files changed
+55

No files matched your search

+33
View File
@@ -60,6 +60,39 @@ ns-train nerfacto --vis viewer --data data/nerfstudio/poster --viewer.websocket-
* All data configurations must go at the end. In this case, `nerfstudio-data` and all of its corresponding configurations come at the end after the model and viewer specification.
:::
## Intro to nerfstudio CLI and Configs
Nerfstudio allows for customizing your training runs, eval runs, configs from the CLI in a powerful way, but there are some things to understand.
The most demonstrative and helpful example of this in action is the difference in output between the following commands:
```bash
ns-train -h
```
```bash
ns-train nerfacto -h nerfstudio-data
```
```bash
ns-train nerfacto nerfstudio-data -h
```
In each of these examples, the -h applies to the previous subcommand (`ns-train`, `nerfacto`, and `nerfstudio-data`).
In the first example, this shows us the help menu for the `ns-train` script.
In the second examples, we will get the help menu for the `nerfacto` model.
In the third examples, we will get the help menu for the `nerfstudio-data` dataparser.
With our scripts, your arguments will apply to the previous subcommand in your command, and thus where you put your arguments matters! Any optional arguments you discover while doing
```bash
ns-train nerfacto -h nerfstudio-data
```
need to come directly after the `nerfacto` subcommand since these optional arguments only belong to the `nerfacto` subcommand:
```bash
ns-train nerfacto <nerfacto optional args> nerfstudio-data
```
Each script will have some other minor quirks (like the training script dataparser subcommand needing to come after the model subcommand), read up on them [here](../reference/cli/index.md).
## Visualizing training runs
If you are using a fast NeRF variant (ie. Nerfacto/Instant-NGP), we recommend using our viewer. See our [viewer docs](viewer_quickstart.md) for a tutorial on using the viewer. The viewer will allow interactive, real-time visualization of training.