BaldFatTiger commited on
Commit
dbadafc
·
verified ·
1 Parent(s): 8b61dfc

Add ControlFlow3D arXiv reference and BibTeX citation

Browse files
Files changed (1) hide show
  1. README.md +209 -195
README.md CHANGED
@@ -1,195 +1,209 @@
1
- ---
2
- pretty_name: ShapeNetPU
3
- task_categories:
4
- - other
5
- tags:
6
- - 3d
7
- - point-cloud
8
- - point-cloud-upsampling
9
- - shapenet
10
- - multi-view
11
- - geometry
12
- size_categories:
13
- - 10K<n<100K
14
- license: other
15
- license_name: shapenet-terms-of-use
16
- license_link: https://huggingface.co/spaces/ShapeNet/README/blob/main/TERMS.md
17
- ---
18
-
19
- # ShapeNetPU
20
-
21
- **ShapeNetPU** is a ShapeNet-derived dataset for **point cloud upsampling**, covering **13 object categories**. It provides paired sparse and dense point clouds, multi-view training images, and test-set reference meshes.
22
-
23
- **Project / Code:** [ControlFlow3D](https://github.com/BaldFatTiger/ControlFlow3D) — **Code coming soon.**
24
-
25
- [Dataset summary](#dataset-summary) · [Download](#download) · [Directory structure](#directory-structure) · [Point groupings](#point-groupings) · [Point cloud format](#point-cloud-format) · [Citation](#citation-and-acknowledgments)
26
-
27
- ## Dataset Summary
28
-
29
- | Property | Training split | Test split |
30
- | :--- | ---: | ---: |
31
- | Shapes | 30,395 | 5,367 |
32
- | Object categories | 13 | 13 |
33
- | Sparse input points per shape | 2,048 | 2,048 |
34
- | Dense reference points per shape | 8,192 | 8,192 |
35
- | Upsampling factor | 4× | 4× |
36
- | Contiguous blocks per shape (derived) | 8 | 8 |
37
- | Overlapping patches per PLY file (stored) | 10 | 10 |
38
- | Rendered views per shape | 8 | Not included |
39
- | Reference meshes | Not included | OBJ |
40
-
41
- There are **35,762 shapes** in total. Each shape is identified by its ShapeNet category ID and model ID. The supplied training and test splits have no shared category/model IDs; no separate validation split is provided.
42
-
43
- ## Categories and Splits
44
-
45
- | Synset ID | Category | Train | Test |
46
- | :--- | :--- | ---: | ---: |
47
- | `02691156` | airplane | 2,705 | 478 |
48
- | `02828884` | bench | 1,154 | 204 |
49
- | `02933112` | cabinet | 1,128 | 200 |
50
- | `02958343` | car | 6,085 | 1,074 |
51
- | `03001627` | chair | 4,116 | 727 |
52
- | `03211117` | display | 899 | 159 |
53
- | `03636649` | lamp | 857 | 151 |
54
- | `03691459` | loudspeaker | 1,114 | 197 |
55
- | `04090263` | rifle | 1,933 | 341 |
56
- | `04256520` | sofa | 2,578 | 455 |
57
- | `04379243` | table | 5,729 | 1,011 |
58
- | `04401088` | telephone | 868 | 153 |
59
- | `04530566` | watercraft | 1,229 | 217 |
60
- | **Total** | **13 categories** | **30,395** | **5,367** |
61
-
62
- ## Download
63
-
64
- Install the Hub client and the dependencies for the minimal reading example, then download the dataset:
65
-
66
- ```bash
67
- pip install -U huggingface_hub numpy plyfile
68
- hf download BaldFatTiger/ShapeNetPU --repo-type dataset --local-dir ShapeNetPU
69
- ```
70
-
71
- For the test split only, append `--include "test/*"` to the download command. For reproducibility, pin a Hub commit with `--revision <commit>`.
72
-
73
- ## Directory Structure
74
-
75
- ```text
76
- ShapeNetPU/
77
- ├── train/
78
- │ └── <category_id>/
79
- │ └── <model_id>/
80
- │ ├── input/
81
- │ │ ├── sparse_xyz.ply
82
- │ │ └── rendering/
83
- │ │ ├── <view_id>.png # 8 selected views
84
- │ │ ├── renderings.txt # Ordered view filenames
85
- │ │ └── rendering_metadata.txt
86
- │ └── gt/
87
- │ └── gt_xyz.ply
88
- └── test/
89
- └── <category_id>/
90
- └── <model_id>/
91
- ├── input/
92
- │ └── sparse_xyz.ply
93
- └── gt/
94
- ├── gt_xyz.ply
95
- └── gt_mesh.obj
96
- ```
97
-
98
- - `<category_id>` is a ShapeNet synset ID; `<model_id>` is the original model identifier.
99
- - `input/sparse_xyz.ply` contains the sparse input cloud.
100
- - `gt/gt_xyz.ply` contains the dense reference cloud.
101
- - `input/rendering/` is included in the **training split only**.
102
- - `gt/gt_mesh.obj` is included in the **test split only** and can be used for mesh-based evaluation, such as point-to-surface distance.
103
-
104
- ## Point Groupings
105
-
106
- The same stored points support two complementary grouping views:
107
-
108
- | Grouping | Groups per shape | Definition | Overlap | Points per group: sparse / dense |
109
- | :--- | ---: | :--- | :--- | ---: |
110
- | **Contiguous blocks** | 8 | Equal-sized consecutive ranges in the original vertex order | No | 256 / 1,024 |
111
- | **Overlapping patches** | 10 | Groups specified by the stored `patch.vertex_indices` lists | Yes | 256 / 1,024 |
112
-
113
- - **Blocks are implicit:** split the original vertex array into eight consecutive groups. Each point belongs to exactly one block; no separate block element is stored in the PLY.
114
- - **Patches are explicit:** gather points using the zero-based index lists in the PLY `patch` element. Indices refer to vertices in the **same file**, and a point can belong to multiple patches.
115
- - The loader names these modes `part` and `patch`, respectively. They are grouping conventions, **not semantic part labels**.
116
-
117
- Preserve the original vertex order when constructing blocks. If vertices are reordered, carry their block memberships and remap patch indices to the new vertex positions.
118
-
119
- ## Point Cloud Format
120
-
121
- Point clouds use **binary little-endian PLY** with the following fields:
122
-
123
- | Element | Property | Meaning |
124
- | :--- | :--- | :--- |
125
- | `vertex` | `x`, `y`, `z` | Float32 point coordinates |
126
- | `vertex` | `dense_index` | Per-file integer indexing metadata; not a sparse-to-GT correspondence map |
127
- | `patch` | `center_x`, `center_y`, `center_z` | Float32 patch-center coordinates |
128
- | `patch` | `vertex_indices` | List of zero-based indices into this file's vertex array |
129
-
130
- The header comment `patch_index_space local_vertex` records this indexing convention.
131
-
132
- ### Minimal Reading Example
133
-
134
- After downloading, this example reads one sparse cloud and constructs both grouping views:
135
-
136
- ```python
137
- import numpy as np
138
- from plyfile import PlyData
139
-
140
- ply = PlyData.read("ShapeNetPU/test/02691156/10155655850468db78d106ce0a280f87/input/sparse_xyz.ply")
141
- v = ply["vertex"].data
142
- points = np.column_stack([v["x"], v["y"], v["z"]])
143
- blocks = points.reshape(8, -1, 3) # 8 contiguous, non-overlapping blocks
144
- patches = [points[idx] for idx in ply["patch"].data["vertex_indices"]]
145
- ```
146
-
147
- Use the corresponding `gt/gt_xyz.ply` file to read the dense reference cloud. Blocks have shape `(8, 256, 3)` for sparse inputs and `(8, 1024, 3)` for dense references; `patches` contains ten point arrays.
148
-
149
- ## Multi-View Renderings
150
-
151
- Each training shape has **eight 137 × 137 RGBA PNG images**, selected from the source 24-view rendering set. Selected filenames range from `00.png` to `23.png` and can differ between shapes. Renderings are included in the training split only.
152
-
153
- | File | Contents |
154
- | :--- | :--- |
155
- | `<view_id>.png` | A selected rendered view |
156
- | `renderings.txt` | The eight selected image filenames, in view order |
157
- | `rendering_metadata.txt` | Eight rows of camera parameters, aligned with `renderings.txt` |
158
-
159
- The five metadata columns are **azimuth, elevation, in-plane rotation, distance, and field of view**, following the [upstream rendering convention](https://github.com/chrischoy/3D-R2N2/issues/12#issuecomment-339119416).
160
-
161
- ## Usage Notes
162
-
163
- - Use the supplied train/test split. If validation data are needed, derive them from the training split.
164
- - For point-cloud-only evaluation, use sparse test clouds as inputs; dense clouds and meshes are evaluation references.
165
- - Apply consistent coordinate transforms to inputs, predictions, references, and meshes when computing distances, and report normalization and metric scaling.
166
-
167
- ## Citation and Acknowledgments
168
-
169
- If you use ShapeNetPU in your research, please acknowledge the dataset and cite the associated **ControlFlow3D** work. A complete BibTeX entry for ControlFlow3D will be added here when available.
170
-
171
- Please also cite ShapeNet, the source of the underlying 3D models:
172
-
173
- ```bibtex
174
- @misc{chang2015shapenetinformationrich3dmodel,
175
- title={ShapeNet: An Information-Rich 3D Model Repository},
176
- author={Angel X. Chang and Thomas Funkhouser and Leonidas Guibas and Pat Hanrahan and Qixing Huang and Zimo Li and Silvio Savarese and Manolis Savva and Shuran Song and Hao Su and Jianxiong Xiao and Li Yi and Fisher Yu},
177
- year={2015},
178
- eprint={1512.03012},
179
- archivePrefix={arXiv},
180
- primaryClass={cs.GR},
181
- url={https://arxiv.org/abs/1512.03012},
182
- }
183
- ```
184
-
185
- We thank the ShapeNet contributors and the original 3D model creators for the source assets.
186
-
187
- ## License and Terms of Use
188
-
189
- ShapeNetPU is derived from [ShapeNet](https://shapenet.org/). The underlying assets remain subject to the [ShapeNet Terms of Use](https://huggingface.co/spaces/ShapeNet/README/blob/main/TERMS.md), which restrict use to **non-commercial research and educational purposes**, and to any applicable licenses of the original model sources.
190
-
191
- Users must review and comply with the upstream terms before using the data. ShapeNet's terms permit sharing with research associates and colleagues only if they first agree to be bound by those terms. This dataset card does not grant unrestricted redistribution rights or additional rights to the underlying third-party assets.
192
-
193
- ## Contact
194
-
195
- For questions about ShapeNetPU or to report a data issue, please open an issue in the [ControlFlow3D repository](https://github.com/BaldFatTiger/ControlFlow3D/issues). Include the split, category ID, and model ID when reporting a sample-specific issue.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pretty_name: ShapeNetPU
3
+ task_categories:
4
+ - other
5
+ tags:
6
+ - 3d
7
+ - point-cloud
8
+ - point-cloud-upsampling
9
+ - shapenet
10
+ - multi-view
11
+ - geometry
12
+ size_categories:
13
+ - 10K<n<100K
14
+ license: other
15
+ license_name: shapenet-terms-of-use
16
+ license_link: https://huggingface.co/spaces/ShapeNet/README/blob/main/TERMS.md
17
+ ---
18
+
19
+ # ShapeNetPU
20
+
21
+ **ShapeNetPU** is a ShapeNet-derived dataset for **point cloud upsampling**, covering **13 object categories**. It provides paired sparse and dense point clouds, multi-view training images, and test-set reference meshes.
22
+
23
+ **Project / Code:** [ControlFlow3D](https://github.com/BaldFatTiger/ControlFlow3D) — **Code coming soon.**
24
+
25
+ **Paper:** [arXiv:2610.21190](https://arxiv.org/abs/2610.21190)
26
+
27
+ [Dataset summary](#dataset-summary) · [Download](#download) · [Directory structure](#directory-structure) · [Point groupings](#point-groupings) · [Point cloud format](#point-cloud-format) · [Citation](#citation-and-acknowledgments)
28
+
29
+ ## Dataset Summary
30
+
31
+ | Property | Training split | Test split |
32
+ | :--- | ---: | ---: |
33
+ | Shapes | 30,395 | 5,367 |
34
+ | Object categories | 13 | 13 |
35
+ | Sparse input points per shape | 2,048 | 2,048 |
36
+ | Dense reference points per shape | 8,192 | 8,192 |
37
+ | Upsampling factor | 4× | 4× |
38
+ | Contiguous blocks per shape (derived) | 8 | 8 |
39
+ | Overlapping patches per PLY file (stored) | 10 | 10 |
40
+ | Rendered views per shape | 8 | Not included |
41
+ | Reference meshes | Not included | OBJ |
42
+
43
+ There are **35,762 shapes** in total. Each shape is identified by its ShapeNet category ID and model ID. The supplied training and test splits have no shared category/model IDs; no separate validation split is provided.
44
+
45
+ ## Categories and Splits
46
+
47
+ | Synset ID | Category | Train | Test |
48
+ | :--- | :--- | ---: | ---: |
49
+ | `02691156` | airplane | 2,705 | 478 |
50
+ | `02828884` | bench | 1,154 | 204 |
51
+ | `02933112` | cabinet | 1,128 | 200 |
52
+ | `02958343` | car | 6,085 | 1,074 |
53
+ | `03001627` | chair | 4,116 | 727 |
54
+ | `03211117` | display | 899 | 159 |
55
+ | `03636649` | lamp | 857 | 151 |
56
+ | `03691459` | loudspeaker | 1,114 | 197 |
57
+ | `04090263` | rifle | 1,933 | 341 |
58
+ | `04256520` | sofa | 2,578 | 455 |
59
+ | `04379243` | table | 5,729 | 1,011 |
60
+ | `04401088` | telephone | 868 | 153 |
61
+ | `04530566` | watercraft | 1,229 | 217 |
62
+ | **Total** | **13 categories** | **30,395** | **5,367** |
63
+
64
+ ## Download
65
+
66
+ Install the Hub client and the dependencies for the minimal reading example, then download the dataset:
67
+
68
+ ```bash
69
+ pip install -U huggingface_hub numpy plyfile
70
+ hf download BaldFatTiger/ShapeNetPU --repo-type dataset --local-dir ShapeNetPU
71
+ ```
72
+
73
+ For the test split only, append `--include "test/*"` to the download command. For reproducibility, pin a Hub commit with `--revision <commit>`.
74
+
75
+ ## Directory Structure
76
+
77
+ ```text
78
+ ShapeNetPU/
79
+ ├── train/
80
+ │ └── <category_id>/
81
+ │ └── <model_id>/
82
+ │ ├── input/
83
+ │ │ ├── sparse_xyz.ply
84
+ │ │ └── rendering/
85
+ │ │ ├── <view_id>.png # 8 selected views
86
+ │ │ ├── renderings.txt # Ordered view filenames
87
+ │ │ └── rendering_metadata.txt
88
+ │ └── gt/
89
+ │ └── gt_xyz.ply
90
+ └── test/
91
+ └── <category_id>/
92
+ └── <model_id>/
93
+ ├── input/
94
+ │ └── sparse_xyz.ply
95
+ └── gt/
96
+ ├── gt_xyz.ply
97
+ └── gt_mesh.obj
98
+ ```
99
+
100
+ - `<category_id>` is a ShapeNet synset ID; `<model_id>` is the original model identifier.
101
+ - `input/sparse_xyz.ply` contains the sparse input cloud.
102
+ - `gt/gt_xyz.ply` contains the dense reference cloud.
103
+ - `input/rendering/` is included in the **training split only**.
104
+ - `gt/gt_mesh.obj` is included in the **test split only** and can be used for mesh-based evaluation, such as point-to-surface distance.
105
+
106
+ ## Point Groupings
107
+
108
+ The same stored points support two complementary grouping views:
109
+
110
+ | Grouping | Groups per shape | Definition | Overlap | Points per group: sparse / dense |
111
+ | :--- | ---: | :--- | :--- | ---: |
112
+ | **Contiguous blocks** | 8 | Equal-sized consecutive ranges in the original vertex order | No | 256 / 1,024 |
113
+ | **Overlapping patches** | 10 | Groups specified by the stored `patch.vertex_indices` lists | Yes | 256 / 1,024 |
114
+
115
+ - **Blocks are implicit:** split the original vertex array into eight consecutive groups. Each point belongs to exactly one block; no separate block element is stored in the PLY.
116
+ - **Patches are explicit:** gather points using the zero-based index lists in the PLY `patch` element. Indices refer to vertices in the **same file**, and a point can belong to multiple patches.
117
+ - The loader names these modes `part` and `patch`, respectively. They are grouping conventions, **not semantic part labels**.
118
+
119
+ Preserve the original vertex order when constructing blocks. If vertices are reordered, carry their block memberships and remap patch indices to the new vertex positions.
120
+
121
+ ## Point Cloud Format
122
+
123
+ Point clouds use **binary little-endian PLY** with the following fields:
124
+
125
+ | Element | Property | Meaning |
126
+ | :--- | :--- | :--- |
127
+ | `vertex` | `x`, `y`, `z` | Float32 point coordinates |
128
+ | `vertex` | `dense_index` | Per-file integer indexing metadata; not a sparse-to-GT correspondence map |
129
+ | `patch` | `center_x`, `center_y`, `center_z` | Float32 patch-center coordinates |
130
+ | `patch` | `vertex_indices` | List of zero-based indices into this file's vertex array |
131
+
132
+ The header comment `patch_index_space local_vertex` records this indexing convention.
133
+
134
+ ### Minimal Reading Example
135
+
136
+ After downloading, this example reads one sparse cloud and constructs both grouping views:
137
+
138
+ ```python
139
+ import numpy as np
140
+ from plyfile import PlyData
141
+
142
+ ply = PlyData.read("ShapeNetPU/test/02691156/10155655850468db78d106ce0a280f87/input/sparse_xyz.ply")
143
+ v = ply["vertex"].data
144
+ points = np.column_stack([v["x"], v["y"], v["z"]])
145
+ blocks = points.reshape(8, -1, 3) # 8 contiguous, non-overlapping blocks
146
+ patches = [points[idx] for idx in ply["patch"].data["vertex_indices"]]
147
+ ```
148
+
149
+ Use the corresponding `gt/gt_xyz.ply` file to read the dense reference cloud. Blocks have shape `(8, 256, 3)` for sparse inputs and `(8, 1024, 3)` for dense references; `patches` contains ten point arrays.
150
+
151
+ ## Multi-View Renderings
152
+
153
+ Each training shape has **eight 137 × 137 RGBA PNG images**, selected from the source 24-view rendering set. Selected filenames range from `00.png` to `23.png` and can differ between shapes. Renderings are included in the training split only.
154
+
155
+ | File | Contents |
156
+ | :--- | :--- |
157
+ | `<view_id>.png` | A selected rendered view |
158
+ | `renderings.txt` | The eight selected image filenames, in view order |
159
+ | `rendering_metadata.txt` | Eight rows of camera parameters, aligned with `renderings.txt` |
160
+
161
+ The five metadata columns are **azimuth, elevation, in-plane rotation, distance, and field of view**, following the [upstream rendering convention](https://github.com/chrischoy/3D-R2N2/issues/12#issuecomment-339119416).
162
+
163
+ ## Usage Notes
164
+
165
+ - Use the supplied train/test split. If validation data are needed, derive them from the training split.
166
+ - For point-cloud-only evaluation, use sparse test clouds as inputs; dense clouds and meshes are evaluation references.
167
+ - Apply consistent coordinate transforms to inputs, predictions, references, and meshes when computing distances, and report normalization and metric scaling.
168
+
169
+ ## Citation and Acknowledgments
170
+
171
+ If you use ShapeNetPU in your research, please cite [ControlFlow3D](https://arxiv.org/abs/2610.21190):
172
+
173
+ ```bibtex
174
+ @misc{liu2026controlflow3ddistillingmultiviewknowledge,
175
+ title={ControlFlow3D: Distilling Multi-View Knowledge into Latent Flow Matching for Point Cloud Upsampling},
176
+ author={Yuang Liu and Zhi Zuo and Zhengkai Zhao and Lirui Zhang and Pan Gao and Hao Feng and Zhengzhe Liu},
177
+ year={2026},
178
+ eprint={2610.21190},
179
+ archivePrefix={arXiv},
180
+ primaryClass={cs.CV},
181
+ url={https://arxiv.org/abs/2610.21190},
182
+ }
183
+ ```
184
+
185
+ Please also cite ShapeNet, the source of the underlying 3D models:
186
+
187
+ ```bibtex
188
+ @misc{chang2015shapenetinformationrich3dmodel,
189
+ title={ShapeNet: An Information-Rich 3D Model Repository},
190
+ author={Angel X. Chang and Thomas Funkhouser and Leonidas Guibas and Pat Hanrahan and Qixing Huang and Zimo Li and Silvio Savarese and Manolis Savva and Shuran Song and Hao Su and Jianxiong Xiao and Li Yi and Fisher Yu},
191
+ year={2015},
192
+ eprint={1512.03012},
193
+ archivePrefix={arXiv},
194
+ primaryClass={cs.GR},
195
+ url={https://arxiv.org/abs/1512.03012},
196
+ }
197
+ ```
198
+
199
+ We thank the ShapeNet contributors and the original 3D model creators for the source assets.
200
+
201
+ ## License and Terms of Use
202
+
203
+ ShapeNetPU is derived from [ShapeNet](https://shapenet.org/). The underlying assets remain subject to the [ShapeNet Terms of Use](https://huggingface.co/spaces/ShapeNet/README/blob/main/TERMS.md), which restrict use to **non-commercial research and educational purposes**, and to any applicable licenses of the original model sources.
204
+
205
+ Users must review and comply with the upstream terms before using the data. ShapeNet's terms permit sharing with research associates and colleagues only if they first agree to be bound by those terms. This dataset card does not grant unrestricted redistribution rights or additional rights to the underlying third-party assets.
206
+
207
+ ## Contact
208
+
209
+ For questions about ShapeNetPU or to report a data issue, please open an issue in the [ControlFlow3D repository](https://github.com/BaldFatTiger/ControlFlow3D/issues). Include the split, category ID, and model ID when reporting a sample-specific issue.