From df0f3205f402c5a65b10703ba89f0bd28d8ab6df Mon Sep 17 00:00:00 2001 From: Matthew Tancik Date: Sat, 18 Feb 2023 19:03:46 -0800 Subject: [PATCH] Add ns-viewer docs (#1450) --- docs/reference/cli/index.md | 2 ++ docs/reference/cli/ns_viewer.md | 9 +++++++++ 2 files changed, 11 insertions(+) create mode 100644 docs/reference/cli/ns_viewer.md diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md index 797f0d9eb..9e1b8fae4 100644 --- a/docs/reference/cli/index.md +++ b/docs/reference/cli/index.md @@ -12,6 +12,7 @@ Here are the popular commands that we offer. If you've cloned the repo, you can | ns-process-data | Generate a dataset from your own data | scripts/process_data.py | | ns-download-data | Download existing captures | scripts/downloads/download_data.py | | ns-train | Generate a NeRF | scripts/train.py | +| ns-viewer | View a trained NeRF | scripts/viewer/run_viewer.py | | ns-eval | Run evaluation metrics for your Model | scripts/eval.py | | ns-render | Render out a video of your NeRF | scripts/render.py | | ns-export | Export a NeRF into other formats | scripts/exporter.py | @@ -24,6 +25,7 @@ ns_process_data ns_download_data ns_train ns_render +ns_viewer ns_export ns_eval ``` diff --git a/docs/reference/cli/ns_viewer.md b/docs/reference/cli/ns_viewer.md new file mode 100644 index 000000000..841472a5f --- /dev/null +++ b/docs/reference/cli/ns_viewer.md @@ -0,0 +1,9 @@ +# ns-viewer + +```{eval-rst} +.. argparse:: + :module: scripts.viewer.run_viewer + :func: get_parser_fn + :prog: ns-viewer + :nodefault: +```