chrischoy commited on
Commit
131dc9d
Β·
verified Β·
1 Parent(s): 920537a

License: weights are CC-BY-NC-4.0 (non-commercial); add dataset usage notice; Replica is eval-only

Browse files
Files changed (1) hide show
  1. README.md +35 -13
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- license: apache-2.0
3
  library_name: warpconvnet
4
  pipeline_tag: image-segmentation
5
  tags:
@@ -20,10 +20,11 @@ tags:
20
  **SpaceFormer** performs **proposal-free, open-vocabulary 3D instance segmentation**.
21
  A Mask2Former-style query decoder (learned queries + rotary position embeddings) runs
22
  on top of the WarpConvNet [`SpaCeFormer`](https://github.com/NVlabs/WarpConvNet) sparse
23
- convnet transformer backbone. A single forward pass over an RGB point cloud produces a fixed set of
24
  query masks plus a per-query CLIP feature; each mask is labeled by comparing its CLIP
25
  feature against text embeddings of **arbitrary class names** (SigLIP2 text encoder, with
26
- prompt ensembling).
 
27
 
28
  Project page: https://nvlabs.github.io/SpaCeFormer/
29
 
@@ -45,17 +46,17 @@ Project page: https://nvlabs.github.io/SpaCeFormer/
45
  Test-set mAP with the released recipe (**prompt ensembling on, TTA off, default
46
  proposal-free post-processing**):
47
 
48
- | Benchmark | mAP |
49
- |---|---:|
50
- | ScanNet200 | **0.1265** |
51
- | ScanNet++ | 0.2217 |
52
- | Replica | 0.2644 |
53
 
54
  ## How to use
55
 
56
  The model lives in WarpConvNet as `warpconvnet.models.spaceformer` (the backbone needs
57
  WarpConvNet's compiled CUDA extension β€” install a pre-built wheel or build from source).
58
- It returns **raw** predictions; open-vocab CLIP feature + mask post-processing live in the
59
  demo repo / HuggingFace Space, not in WarpConvNet.
60
 
61
  ```python
@@ -85,8 +86,9 @@ e.g. its `inference.py` CLI or the Gradio `app.py`.
85
  point clouds (ScanNet-like) against custom class vocabularies.
86
  - **Open-vocab mAP is semantics-bottlenecked:** rare/fine-grained classes are weaker than
87
  head classes; class-agnostic mask recall is higher than the open-vocab mAP.
88
- - **Domain:** trained on indoor scenes (ScanNet200 / ScanNet++ / ARKit);
89
- outdoor or very different sensor domains are out of distribution.
 
90
  - **Large scenes:** very large clouds can exceed memory in the eval forward; the
91
  inference code skips such a scene (single-process) rather than crashing.
92
 
@@ -97,6 +99,26 @@ e.g. its `inference.py` CLI or the Gradio `app.py`.
97
  `load_spaceformer_checkpoint` (strips the `net.` prefix, `strict=False`).
98
  - `spaceformer_512_siglip2_ssccc.ckpt.provenance.json` β€” architecture, eval numbers, md5.
99
 
100
- ## License
101
 
102
- Apache-2.0.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: cc-by-nc-4.0
3
  library_name: warpconvnet
4
  pipeline_tag: image-segmentation
5
  tags:
 
20
  **SpaceFormer** performs **proposal-free, open-vocabulary 3D instance segmentation**.
21
  A Mask2Former-style query decoder (learned queries + rotary position embeddings) runs
22
  on top of the WarpConvNet [`SpaCeFormer`](https://github.com/NVlabs/WarpConvNet) sparse
23
+ point backbone. A single forward pass over an RGB point cloud produces a fixed set of
24
  query masks plus a per-query CLIP feature; each mask is labeled by comparing its CLIP
25
  feature against text embeddings of **arbitrary class names** (SigLIP2 text encoder, with
26
+ prompt ensembling). The vocabulary is chosen at inference time β€” it is not baked into the
27
+ weights β€” so the model can be queried with any label set.
28
 
29
  Project page: https://nvlabs.github.io/SpaCeFormer/
30
 
 
46
  Test-set mAP with the released recipe (**prompt ensembling on, TTA off, default
47
  proposal-free post-processing**):
48
 
49
+ | Benchmark | mAP | mAP50 | recall (class-agnostic) |
50
+ |---|---:|---:|---:|
51
+ | ScanNet200 | **0.1265** | 0.210 | 0.756 |
52
+ | ScanNet++ | 0.2217 | β€” | β€” |
53
+ | Replica | 0.2644 | β€” | β€” |
54
 
55
  ## How to use
56
 
57
  The model lives in WarpConvNet as `warpconvnet.models.spaceformer` (the backbone needs
58
  WarpConvNet's compiled CUDA extension β€” install a pre-built wheel or build from source).
59
+ It returns **raw** predictions; open-vocab labeling + mask post-processing live in the
60
  demo repo / HuggingFace Space, not in WarpConvNet.
61
 
62
  ```python
 
86
  point clouds (ScanNet-like) against custom class vocabularies.
87
  - **Open-vocab mAP is semantics-bottlenecked:** rare/fine-grained classes are weaker than
88
  head classes; class-agnostic mask recall is higher than the open-vocab mAP.
89
+ - **Domain:** trained on indoor scenes (ScanNet, ScanNet++, ARKitScenes, Matterport3D)
90
+ and evaluated on ScanNet200 / ScanNet++ / Replica (Replica zero-shot); outdoor or very
91
+ different sensor domains are out of distribution.
92
  - **Large scenes:** very large clouds can exceed memory in the eval forward; the
93
  inference code skips such a scene (single-process) rather than crashing.
94
 
 
99
  `load_spaceformer_checkpoint` (strips the `net.` prefix, `strict=False`).
100
  - `spaceformer_512_siglip2_ssccc.ckpt.provenance.json` β€” architecture, eval numbers, md5.
101
 
102
+ ## License & usage
103
 
104
+ **These weights are released for non-commercial research use only, under
105
+ [CC-BY-NC-4.0](https://creativecommons.org/licenses/by-nc/4.0/).** They are a derivative
106
+ of datasets governed by non-commercial research Terms of Use, so they are **not** released
107
+ under the permissive Apache-2.0 license that covers the *code*.
108
+
109
+ The model was trained on the following datasets, each of which restricts use to
110
+ **non-commercial research/education** under its own terms β€” by using these weights you
111
+ agree to comply with all of them:
112
+
113
+ - **ScanNet / ScanNet200** β€” [ScanNet Terms of Use](http://kaldir.vc.in.tum.de/scannet/ScanNet_TOS.pdf)
114
+ - **ScanNet++** β€” [ScanNet++ Terms of Use](https://kaldir.vc.in.tum.de/scannetpp/static/scannetpp-terms-of-use.pdf)
115
+ - **ARKitScenes** β€” [Apple ARKitScenes license](https://github.com/apple/ARKitScenes/blob/main/LICENSE) (non-commercial)
116
+ - **Matterport3D** β€” [Matterport3D Terms of Use](https://kaldir.vc.in.tum.de/matterport/MP_TOS.pdf) (non-commercial academic)
117
+
118
+ Evaluation additionally used **Replica** ([Replica Research Terms](https://github.com/facebookresearch/Replica-Dataset/blob/main/LICENSE), non-commercial), zero-shot.
119
+
120
+ The accompanying **code** in [WarpConvNet](https://github.com/NVlabs/WarpConvNet) is
121
+ licensed separately under **Apache-2.0**.
122
+
123
+ > Note: this is not legal advice; for commercial use, consult the individual dataset
124
+ > licensors. Please also cite the datasets above and the SpaceFormer project.