cubec commited on
Commit
7231195
·
verified ·
1 Parent(s): bbc05d0

Keep project documentation outside frozen evaluation archives

Browse files
evaluation/README.md CHANGED
@@ -25,7 +25,7 @@ The complete benchmark requires `evaluation/index.json` and all 26 archives list
25
  | File or files | Count | Contents |
26
  | --- | ---: | --- |
27
  | `evaluation/index.json` | 1 | Archive inventory and SHA-256 checksums |
28
- | `evaluation/metadata.tar` | 1 | Portable manifests, original selections, and dataset documentation |
29
  | `evaluation/picasso-00000.tar` | 1 | All 100 PICASSO images, masks, previews, and GT meshes |
30
  | `evaluation/messykitchen-00001.tar` through `messykitchen-00022.tar` | 22 | All 1,503 MessyKitchens images, masks, previews, and 100 shared GT meshes |
31
  | `evaluation/3dfront-00023.tar` and `3dfront-00024.tar` | 2 | The selected 1,000 3D-FRONT test images, masks, previews, and GT meshes |
@@ -34,6 +34,11 @@ The downloader restores every archive and checks its checksum.
34
  Each view requires its RGB image, instance mask, and referenced GT mesh.
35
  Older project checkouts also require `code/evaluation.patch` before restoration.
36
 
 
 
 
 
 
37
  ## Optional files
38
 
39
  These separate Hub components are optional for this benchmark:
@@ -67,16 +72,53 @@ The required evaluation bundle restores to `datasets/evaluation/`.
67
  Default training downloads exclude this bundle.
68
  The source manifest at `code/evaluation_manifest.json` records the loader files and patch checksum.
69
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
70
  ## Geometry-only inference
71
 
72
  The benchmark compares geometry meshes.
73
  Comparison baselines disable independent appearance decoding, UV generation, and texture baking.
74
- Geometry checks must confirm unchanged surfaces, object placement, indices, units, and coordinate frames.
75
  Native geometry settings remain fixed.
76
 
77
- Save raw prediction GLBs and their input and model provenance.
78
- Keep RGB, masks, GT references, shared depth, and scoring results with those predictions.
79
- These artifacts support additional geometry metrics without repeating inference.
 
80
 
81
  ## Read samples
82
 
 
25
  | File or files | Count | Contents |
26
  | --- | ---: | --- |
27
  | `evaluation/index.json` | 1 | Archive inventory and SHA-256 checksums |
28
+ | `evaluation/metadata.tar` | 1 | Portable manifests, original selections, and source provenance |
29
  | `evaluation/picasso-00000.tar` | 1 | All 100 PICASSO images, masks, previews, and GT meshes |
30
  | `evaluation/messykitchen-00001.tar` through `messykitchen-00022.tar` | 22 | All 1,503 MessyKitchens images, masks, previews, and 100 shared GT meshes |
31
  | `evaluation/3dfront-00023.tar` and `3dfront-00024.tar` | 2 | The selected 1,000 3D-FRONT test images, masks, previews, and GT meshes |
 
34
  Each view requires its RGB image, instance mask, and referenced GT mesh.
35
  Older project checkouts also require `code/evaluation.patch` before restoration.
36
 
37
+ The project README stays outside the data archives.
38
+ The Hub stores it separately at `evaluation/README.md`.
39
+ Restoration preserves the local project README, including local edits.
40
+ Metadata archives retain dataset provenance files such as `messykitchen/SOURCE_README.md`.
41
+
42
  ## Optional files
43
 
44
  These separate Hub components are optional for this benchmark:
 
72
  Default training downloads exclude this bundle.
73
  The source manifest at `code/evaluation_manifest.json` records the loader files and patch checksum.
74
 
75
+ ## Refresh Hub metadata
76
+
77
+ Use this procedure to remove the project README from an earlier archive.
78
+ The refresh command downloads only the evaluation index and metadata archive.
79
+ It preserves every other member and every data archive record.
80
+ It publishes the project README separately.
81
+ It requires no transfer of image, mask, or mesh archives.
82
+
83
+ Prepare the update without uploading:
84
+
85
+ ```bash
86
+ python -m preprocess.evaluation refresh-metadata \
87
+ --output outputs/huggingface/evaluation_metadata
88
+ ```
89
+
90
+ Publish the three prepared metadata files:
91
+
92
+ ```bash
93
+ python -m preprocess.evaluation refresh-metadata \
94
+ --output outputs/huggingface/evaluation_metadata --upload
95
+ ```
96
+
97
+ The publication uses a pinned parent commit.
98
+ A concurrent Hub change stops the update.
99
+ Archive checksums and existing data checks remain mandatory.
100
+
101
+ Refresh the task catalog after publication:
102
+
103
+ ```bash
104
+ python -m preprocess.tasks publish --repo cubec/PartProbe3D-preprocessed \
105
+ --output outputs/huggingface/tasks
106
+ ```
107
+
108
+ The catalog records the current Git revision.
109
+ Use a revision available on the Git remote.
110
+
111
  ## Geometry-only inference
112
 
113
  The benchmark compares geometry meshes.
114
  Comparison baselines disable independent appearance decoding, UV generation, and texture baking.
115
+ Geometry checks must show unchanged surfaces, object placement, indices, units, and coordinate frames.
116
  Native geometry settings remain fixed.
117
 
118
+ Save raw prediction GLBs, stable sample identities, the pinned dataset revision, and scoring settings.
119
+ Keep source snapshots, dependency versions, and metric results for portable reevaluation.
120
+ Restore RGB, masks, and GT meshes from the pinned Hub release when required.
121
+ Geometry metric reevaluation needs no model weights or native working files.
122
 
123
  ## Read samples
124
 
evaluation/index.json CHANGED
@@ -30,10 +30,10 @@
30
  "archives": [
31
  {
32
  "file": "metadata.tar",
33
- "bytes": 13086720,
34
- "sha256": "89f5bd7e4f42224122cb517d2bcf93f301b1d58e1241316962004b2fb0143164",
35
- "identity": "f6f58b739c0892c8771c79da79af51589e8aba907fe0bdc946a517c988fb2c26",
36
- "files": 9,
37
  "views": 0
38
  },
39
  {
@@ -237,7 +237,8 @@
237
  "views": 449
238
  }
239
  ],
240
- "bytes": 23404277760,
241
  "archive_prefix": "datasets/evaluation/indoor",
242
- "required_for_evaluation": true
 
243
  }
 
30
  "archives": [
31
  {
32
  "file": "metadata.tar",
33
+ "bytes": 13076480,
34
+ "sha256": "a0b695a62cbc646a5e350482574892dba7fe2a6af75a55c75b194cfdec3d0274",
35
+ "identity": "853dfc93d9b120e4be2efbc3eb5828d672b4c421597c2fc14b91cd1f978f0c3b",
36
+ "files": 8,
37
  "views": 0
38
  },
39
  {
 
237
  "views": 449
238
  }
239
  ],
240
+ "bytes": 23404267520,
241
  "archive_prefix": "datasets/evaluation/indoor",
242
+ "required_for_evaluation": true,
243
+ "project_readme_included": false
244
  }
evaluation/metadata.tar CHANGED
@@ -1,3 +1,3 @@
1
  version https://git-lfs.github.com/spec/v1
2
- oid sha256:89f5bd7e4f42224122cb517d2bcf93f301b1d58e1241316962004b2fb0143164
3
- size 13086720
 
1
  version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a0b695a62cbc646a5e350482574892dba7fe2a6af75a55c75b194cfdec3d0274
3
+ size 13076480