tink/nerfstudio
4
0
Fork 0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-11 02:24:38 +08:00
Code
e96f7c0617
nerfstudio/docs/tutorials/viewer/viewer_quickstart.md
Ethan Weber 55ebaaf1b5
Hosting the viewer & webrtc logging (#271) 
* might fix the stun server issue

* still debugging webrtc

* another turn server

* working on github actions

* updating actions file

* fixing actions

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* ga

* updating viewer

* update docs
2022-08-14 00:15:34 -07:00

1.3 KiB
Raw Blame History

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.nerfactory.com/branch/master/?localhost:8051 but make sure to change localhost:8051 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/run_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 nerfactory training progress!

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