mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-16 12:53:44 +08:00
doc refactoring (#267)
* reformatted docs; moved visualizer section; added references to top; hiding some doctrees etc. * changed realtime viewer tab
This commit is contained in:
1 parent
841e03a9a3
commit
3cb44f3a8e
25 files changed
+884
-761
No files matched your search
@@ -0,0 +1,22 @@
|
||||
# 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](https://threejs.org/) and packaged into a [ReactJS](https://reactjs.org/) 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:
|
||||
|
||||

|
||||
|
||||
|
||||
## Run hosted web viewer
|
||||
[WOP: This sections is not ready. Please proceed to the "For developers" section.]
|
||||
|
||||
1. Open the Client App Viewer at ... `TODO(ethan): host the static website`.
|
||||
|
||||
2. Run training script with viewer enabled. Note that you should only use the viewer with a fast pipeline, such as instant ngp.
|
||||
```shell
|
||||
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.
|
||||
Reference in new issue
Block a user