4
0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-11 02:24:38 +08:00
nerfstudio/docs/tutorials/viewer/viewer_quickstart.md
Matthew Tancik 531361a6aa
Remove remaining nerfactory (#598)
* Remove remaining nerfactory

* Lint
2022-10-01 12:28:15 -07:00

1.3 KiB

Quickstart

We provide a real-time, web-based viewer that can be used during training or to view a trained model. The purpose of the viewer is to be able to freely move the camera and see the reconstruction from novel viewpoints. It can also be used to draw various primitives (e.g., bounding boxes, camera frustums, etc.).

The viewer is built using ThreeJS and packaged into a ReactJS application. This client viewer application will connect via a websocket to a server running on your machine. The following figure helps to illustrate how our viewer framework works:

visualize_dataset

Run hosted web viewer

  1. Open the Client App Viewer at ... https://viewer.nerf.studio/latest/?localhost:7007 but make sure to change localhost:7007 accordingly.

  2. Run training script with viewer enabled. Note that you should only use the viewer with a fast pipeline, such as instant ngp.

    python scripts/train.py --config-name=graph_instant_ngp.yaml viewer.enable=True
    

This pulls up a hosted web-viewer which is the fastest way to get started with visualizing your nerfstudio training progress!

viewer

If you want to host the viewer locally/yourself, please proceed to "For devleopers" section.