chrischoy commited on
Commit
484c04d
·
verified ·
1 Parent(s): 131dc9d

card: add local viser demo section

Browse files
Files changed (1) hide show
  1. README.md +17 -0
README.md CHANGED
@@ -80,6 +80,23 @@ clean up masks (NMS/min-points), use the inference pipeline in the demo repo / S
80
  (`pipeline.py`, `clip_eval.py`, `text_encoder.py`, `postprocessing.py`, `labels.py`) —
81
  e.g. its `inference.py` CLI or the Gradio `app.py`.
82
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
83
  ## Intended use & limitations
84
 
85
  - **Intended:** research on open-vocabulary 3D scene understanding; segmenting indoor RGB
 
80
  (`pipeline.py`, `clip_eval.py`, `text_encoder.py`, `postprocessing.py`, `labels.py`) —
81
  e.g. its `inference.py` CLI or the Gradio `app.py`.
82
 
83
+ ## Demo (run locally)
84
+
85
+ A small local demo lives under [`demo/`](./demo) — no GPU cloud / HF Space needed, run it
86
+ on your own machine (requires WarpConvNet with its compiled extension). It takes text
87
+ class names, runs segmentation, and shows the result in an interactive 3D
88
+ [**viser**](https://viser.studio) viewer:
89
+
90
+ ```bash
91
+ pip install -r demo/requirements.txt # + warpconvnet (compiled)
92
+ python demo/demo_viser.py --port 8080 # uses a bundled sample point cloud
93
+ # your own scene + vocabulary:
94
+ python demo/demo_viser.py --ply my_scene.ply --class-names "chair" "table" "lamp" "other"
95
+ ```
96
+
97
+ Open the printed `http://localhost:8080` — each predicted instance is a distinct color.
98
+ A headless CLI (`demo/inference.py`) and a Gradio app (`demo/app.py`) are also included.
99
+
100
  ## Intended use & limitations
101
 
102
  - **Intended:** research on open-vocabulary 3D scene understanding; segmenting indoor RGB