diff --git a/README.md b/README.md index 5d50fe8c9..9b6fe974a 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,7 @@ Download the original NeRF Blender dataset. We support the major datasets and al ``` ns-download-data --dataset=blender +ns-download-data --dataset=nerfstudio --capture=poster ``` Use `--help` to view all currently available datasets. The resulting script should download and unpack the dataset as follows: @@ -150,8 +151,11 @@ ns-train --help # Run a vanilla nerf model. ns-train vanilla-nerf -# +# Run with nerfacto model. ns-train nerfacto + +# Run with nerfstudio data. You'll may have to change the ports, and be sure to forward the "websocket-port". +ns-train nerfacto --vis viewer --viewer.zmq-port 8001 --viewer.websocket-port 8002 nerfactory-data --pipeline.datamanager.dataparser.data-directory data/nerfstudio/poster --pipeline.datamanager.dataparser.downscale-factor 4 ``` ### 3.x Training a model with the viewer diff --git a/docs/tutorials/quickstart.md b/docs/tutorials/quickstart.md index 7c89c6416..aa71371a8 100644 --- a/docs/tutorials/quickstart.md +++ b/docs/tutorials/quickstart.md @@ -61,6 +61,7 @@ Download the original NeRF Blender dataset. We support the major datasets and al ``` ns-download-data --dataset=blender +ns-download-data --dataset=nerfstudio --capture=poster ``` Use `--help` to view all currently available datasets. The resulting script should download and unpack the dataset as follows: @@ -87,12 +88,18 @@ Run a vanilla nerf model. ns-train vanilla-nerf ``` -Run a vanilla nerf model. +Run a nerfacto model. ```bash ns-train nerfacto ``` +Run with nerfstudio data. You'll may have to change the ports, and be sure to forward the "websocket-port". + +``` +ns-train nerfacto --vis viewer --viewer.zmq-port 8001 --viewer.websocket-port 8002 nerfactory-data --pipeline.datamanager.dataparser.data-directory data/nerfstudio/poster --pipeline.datamanager.dataparser.downscale-factor 4 +``` + # Visualizing training runs If you using a fast NeRF variant (ie. Instant-NGP), we reccomend using our viewer. See our [viewer docs](../tutorials/viewer/viewer_quickstart.md) for more details. The viewer will allow interactive visualization of training in realtime.