Reduced tyro overhead + helptext formatting (#719)

* `ns-train` helptext formatting for tyro 0.3.23

* Remove unused import
This commit is contained in:
Brent Yi authored and GitHub committed 2022-10-06 13:33:42 -07:00
1 parent eaa16e535a
commit 05d264a335
4 files changed
+46 -18

No files matched your search

+7 -7
View File
@@ -61,9 +61,9 @@ ns-train nerfacto --vis viewer --data data/nerfstudio/poster --viewer.websocket-
:::
## 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.
Nerfstudio allows customization of training and eval 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:
The most demonstrative and helpful example of the CLI structure is the difference in output between the following commands:
```bash
ns-train -h
```
@@ -76,13 +76,13 @@ 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 first example, we get the help menu for the `ns-train` script.
In the second examples, we will get the help menu for the `nerfacto` model.
In the second example, we get the help menu for the `nerfacto` model.
In the third examples, we will get the help menu for the `nerfstudio-data` dataparser.
In the third example, we 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
With our scripts, your arguments will apply to the preceding subcommand in your command, and thus where you put your arguments matters! Any optional arguments you discover from running
```bash
ns-train nerfacto -h nerfstudio-data
```
@@ -133,4 +133,4 @@ Calculate the psnr of your trained model and save to a json file.
ns-eval --load-config={PATH_TO_CONFIG} --output-path=output.json
```
We also provide a train and evaluation script that allows you to do benchmarking on the classical Blender dataset (see our [benchmarking workflow](../developer_guides/debugging_tools/benchmarking.md)).
We also provide a train and evaluation script that allows you to do benchmarking on the classical Blender dataset (see our [benchmarking workflow](../developer_guides/debugging_tools/benchmarking.md)).