yuanze1024 commited on
Commit
fb73352
·
verified ·
1 Parent(s): 78cee4f

Fix viewer file:// loading; correct image licensing in NOTICE

Browse files
Files changed (5) hide show
  1. NOTICE +56 -9
  2. README.md +39 -14
  3. viewer.html +16 -11
  4. viewer_assets/cards.js +0 -0
  5. viewer_assets/cards.json +0 -0
NOTICE CHANGED
@@ -48,14 +48,37 @@ MatSynth is CC0 with a CC-BY subset. Cite the upstream work:
48
 
49
 
50
  images/cands/procedural/**
51
- images/human_pairs/**
52
  --------------------------
53
  Renders of procedural Blender materials, including node graphs that
54
- ShaderAgent itself wrote. These renders are released under CC BY 4.0.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
55
 
56
- Some of the material names under `images/human_pairs/` come from procedural
57
- material sources in the BlenderKit catalogue; as above, only renders are
58
- published.
 
 
 
 
 
 
59
 
60
 
61
  images/queries/**
@@ -63,6 +86,14 @@ images/queries/**
63
  Reference ("query") renders: an object from HY3D-Bench placed in a scene, with
64
  one part's material swapped, plus the corresponding part mask.
65
 
 
 
 
 
 
 
 
 
66
  The 3D objects come from Tencent Hunyuan 3D. Their use is governed by the
67
  **Tencent Hunyuan 3D 2.1 Community License**, which, among other terms:
68
 
@@ -78,7 +109,8 @@ https://github.com/Tencent-Hunyuan/Hunyuan3D-2.1
78
  The meshes themselves are **not** redistributed here — only renders.
79
 
80
  The scene files used as backgrounds are third-party and are **not**
81
- redistributed. Only the renders are published.
 
82
 
83
 
84
  images/eval/**
@@ -86,7 +118,17 @@ images/eval/**
86
  Renders produced by ShaderAgent and by the baseline methods it was compared
87
  against (BlenderAlchemy, VLMaterial, a Gemini-generation variant, and a
88
  retrieval-only "search" variant), all run by the dataset author on the author's
89
- own hardware. Released under CC BY 4.0.
 
 
 
 
 
 
 
 
 
 
90
 
91
  `images/eval/refs/**` holds the reference images the evaluation was run
92
  against, in four groups: `blender` (renders), `sd` and `aigen` (generated
@@ -110,11 +152,16 @@ Summary table
110
  (Royalty Free or CC0 upstream)
111
  images/cands/matsynth/** renders of MatSynth (CC0 / CC-BY)
112
  images/cands/procedural/** CC BY 4.0
113
- images/human_pairs/** CC BY 4.0
 
114
  images/queries/** renders of Hunyuan 3D objects
115
  (Tencent Hunyuan 3D 2.1
116
  Community License applies)
117
- images/eval/** CC BY 4.0
 
 
 
 
118
  images/eval/refs/realworld/** third-party photographs,
119
  no license granted
120
 
 
48
 
49
 
50
  images/cands/procedural/**
 
51
  --------------------------
52
  Renders of procedural Blender materials, including node graphs that
53
+ ShaderAgent itself wrote. Released under CC BY 4.0.
54
+
55
+
56
+ images/human_pairs/**
57
+ ---------------------
58
+ This directory mixes two things, and they do not carry the same terms.
59
+
60
+ images/human_pairs/<material>/ref.png renders of BlenderKit
61
+ materials; see the
62
+ BlenderKit section above
63
+
64
+ 455 files, one per material directory. These are the *reference*
65
+ images — the material each pair was asked to reproduce. Each was made
66
+ by appending a BlenderKit material datablock into a scene and
67
+ rendering it, so treat these the way you would treat anything under
68
+ `images/cands/blenderkit/`: a rendered depiction, not a redistribution
69
+ of the asset, and not CC BY 4.0. (All 455 directory names are exact
70
+ BlenderKit catalogue entries, and each render's own build log records
71
+ the material being appended from that catalogue's `.blend`.)
72
 
73
+ images/human_pairs/<material>/positive_*.png CC BY 4.0
74
+ images/human_pairs/<material>/neg_*.png CC BY 4.0
75
+
76
+ 5,130 files. These are ShaderAgent's own procedural attempts at
77
+ reproducing the reference — node graphs the system wrote itself.
78
+
79
+ The `eval` config's `stage2` and `stage2_extra` splits score rollouts of
80
+ procedural materials, so their candidate views also live in this directory and
81
+ the same split applies.
82
 
83
 
84
  images/queries/**
 
86
  Reference ("query") renders: an object from HY3D-Bench placed in a scene, with
87
  one part's material swapped, plus the corresponding part mask.
88
 
89
+ Each of these renders therefore combines three third-party things: the object
90
+ mesh, the background scene, and **the material applied to the swapped part**.
91
+ That material is a BlenderKit material in 11,558 of the 12,891 query renders
92
+ (90%) and a procedural material in the remaining 1,333 — it is the same
93
+ material as the record's `positive` candidate, whose `source` field names the
94
+ catalogue. So the BlenderKit terms described above apply to most of these
95
+ renders as well, on top of the object terms below.
96
+
97
  The 3D objects come from Tencent Hunyuan 3D. Their use is governed by the
98
  **Tencent Hunyuan 3D 2.1 Community License**, which, among other terms:
99
 
 
109
  The meshes themselves are **not** redistributed here — only renders.
110
 
111
  The scene files used as backgrounds are third-party and are **not**
112
+ redistributed. Only the renders are published. The same applies to the 52
113
+ background scenes behind `images/human_pairs/**/ref.png`.
114
 
115
 
116
  images/eval/**
 
118
  Renders produced by ShaderAgent and by the baseline methods it was compared
119
  against (BlenderAlchemy, VLMaterial, a Gemini-generation variant, and a
120
  retrieval-only "search" variant), all run by the dataset author on the author's
121
+ own hardware. Released under CC BY 4.0, with one exception:
122
+
123
+ images/eval/method/*/search/** depicts a retrieved material
124
+
125
+ 114 files. The "search" variant does not synthesise a material; it
126
+ retrieves one from the material catalogue and renders it. The render is
127
+ the author's own (none of them is byte-identical to any catalogue
128
+ render), but the material depicted is whatever was retrieved, which is
129
+ usually a BlenderKit material. Treat these the way you would treat
130
+ `images/cands/blenderkit/`. The other methods generate or optimise their
131
+ own materials, so their renders are CC BY 4.0.
132
 
133
  `images/eval/refs/**` holds the reference images the evaluation was run
134
  against, in four groups: `blender` (renders), `sd` and `aigen` (generated
 
152
  (Royalty Free or CC0 upstream)
153
  images/cands/matsynth/** renders of MatSynth (CC0 / CC-BY)
154
  images/cands/procedural/** CC BY 4.0
155
+ images/human_pairs/**/ref.png renders of BlenderKit assets
156
+ images/human_pairs/**/positive_*, neg_* CC BY 4.0
157
  images/queries/** renders of Hunyuan 3D objects
158
  (Tencent Hunyuan 3D 2.1
159
  Community License applies)
160
+ carrying a BlenderKit material
161
+ in 90% of cases
162
+ images/eval/** CC BY 4.0, except:
163
+ images/eval/method/*/search/** depicts a retrieved
164
+ (usually BlenderKit) material
165
  images/eval/refs/realworld/** third-party photographs,
166
  no license granted
167
 
README.md CHANGED
@@ -47,21 +47,37 @@ procedural materials against a region of a reference image. The trained adapter
47
  lives at
48
  [yuanze1024/ShaderAgent-MatScorer-Qwen3VLReranker-LoRA](https://huggingface.co/yuanze1024/ShaderAgent-MatScorer-Qwen3VLReranker-LoRA).
49
 
50
- **Read [NOTICE](NOTICE) before use.** The images are renders derived from
51
- several upstream collections with different terms (BlenderKit, MatSynth,
52
- Tencent Hunyuan 3D), which is why the dataset is labeled `license: other`.
53
- The reference photographs under `images/eval/refs/realworld/` were collected
54
- from assorted sources and carry no license grant here. If you hold rights to
55
- any image in this dataset and want it removed, open an issue or a discussion
56
- and it will be removed promptly.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
57
 
58
  ## Browse it first
59
 
60
  Open **[`viewer.html`](viewer.html)** — a self-contained page that renders a
61
  sample of every config with the query bbox drawn over the reference image and
62
  the candidate views beside it. Clone the repo (or download `viewer.html` plus
63
- `viewer_assets/`) and open the file in a browser; it needs no server and no
64
- network.
65
 
66
  The Hub's own Dataset Viewer shows the `images/**` fields as *strings*, because
67
  the images are stored as plain files rather than embedded in parquet. Embedding
@@ -128,9 +144,11 @@ the evaluation data rather than with `human_pairs`. Their groups do not overlap
128
  ```
129
 
130
  - **`bbox` is pixel `[x1, y1, x2, y2]`** on the query image. Reference
131
- resolutions are not uniform (512×512 dominates, but 400×400 up to 2048×2048
132
- occur), so **always read `image_size` alongside it** rather than assuming a
133
- size. All 14,308 boxes are within bounds.
 
 
134
  - **`label_source`** is `retrieval` (automatic), `human_forced_choice`, or
135
  `human_ranking`.
136
  - **`source`** on a candidate is `blenderkit`, `matsynth`, `procedural`, or
@@ -170,7 +188,9 @@ ref = Image.open(os.path.join(root, row["query"]["image"]))
170
  views = [Image.open(os.path.join(root, v)) for v in row["positive"]["views"]]
171
  ```
172
 
173
- To fetch only part of the 42 GiB, use `allow_patterns`:
 
 
174
 
175
  ```python
176
  snapshot_download(
@@ -179,6 +199,11 @@ snapshot_download(
179
  )
180
  ```
181
 
 
 
 
 
 
182
  ## Contents
183
 
184
  | path | what | files |
@@ -191,7 +216,7 @@ snapshot_download(
191
  | `images/queries/masks/**` | part masks for those references | 11,543 |
192
  | `images/human_pairs/**` | S2 rollout renders, per material (train + eval) | 5,585 |
193
  | `images/eval/**` | evaluation references and method outputs | 1,036 |
194
- | `viewer_assets/**` | WebP thumbnails + `cards.json` for `viewer.html` | — |
195
 
196
  59,441 images, 42.35 GiB, all PNG. Query paths are sharded two levels deep by
197
  content hash to keep any one directory well under the Hub's 10k-file guidance.
 
47
  lives at
48
  [yuanze1024/ShaderAgent-MatScorer-Qwen3VLReranker-LoRA](https://huggingface.co/yuanze1024/ShaderAgent-MatScorer-Qwen3VLReranker-LoRA).
49
 
50
+ **Read [NOTICE](NOTICE) before use — the images are not uniformly licensed.**
51
+ They are renders derived from several upstream collections with different terms
52
+ (BlenderKit, MatSynth, Tencent Hunyuan 3D), which is why the dataset is labeled
53
+ `license: other`. In particular:
54
+
55
+ - **BlenderKit terms reach further than the `images/cands/blenderkit/`
56
+ directory.** At least 18,839 files (32%) are renders of BlenderKit materials,
57
+ counting the candidate views, the 455 `human_pairs/*/ref.png` references and
58
+ the 114 `eval/method/*/search/` renders. On top of that, 11,558 of the 12,891
59
+ query renders (90%) show a BlenderKit material applied to the object. No
60
+ BlenderKit asset file is redistributed — only renders — but do not treat these
61
+ as openly licensed.
62
+ - **`images/eval/refs/realworld/`** holds photographs collected from assorted
63
+ sources; no copyright is claimed and no license is granted for them.
64
+ - **`images/queries/`** renders contain Tencent Hunyuan 3D objects, whose
65
+ community license excludes the EU, the UK and South Korea from its territory.
66
+
67
+ What is cleanly CC BY 4.0: the annotations, `viewer.html`, and the renders that
68
+ ShaderAgent produced itself — `images/cands/procedural/`, the 5,130
69
+ `human_pairs` rollouts, and the non-`search` method outputs under `images/eval/`.
70
+
71
+ If you hold rights to any image here and want it removed, open an issue or a
72
+ discussion and it will be removed promptly.
73
 
74
  ## Browse it first
75
 
76
  Open **[`viewer.html`](viewer.html)** — a self-contained page that renders a
77
  sample of every config with the query bbox drawn over the reference image and
78
  the candidate views beside it. Clone the repo (or download `viewer.html` plus
79
+ `viewer_assets/`) and open the file in a browser — straight off disk, no server
80
+ and no network needed.
81
 
82
  The Hub's own Dataset Viewer shows the `images/**` fields as *strings*, because
83
  the images are stored as plain files rather than embedded in parquet. Embedding
 
144
  ```
145
 
146
  - **`bbox` is pixel `[x1, y1, x2, y2]`** on the query image. Reference
147
+ resolutions are not uniform: 22 distinct sizes occur, 512×512 covering 13,570
148
+ of the 14,308 rows, the rest ranging from 400×400 to 2048×2048 and including
149
+ non-square ones (1800×800, 639×1512, 1920×1256). **Always read `image_size`
150
+ alongside the bbox** rather than assuming a size or a square aspect. All
151
+ 14,308 boxes are within their image bounds.
152
  - **`label_source`** is `retrieval` (automatic), `human_forced_choice`, or
153
  `human_ranking`.
154
  - **`source`** on a candidate is `blenderkit`, `matsynth`, `procedural`, or
 
188
  views = [Image.open(os.path.join(root, v)) for v in row["positive"]["views"]]
189
  ```
190
 
191
+ To fetch only part of the 42 GiB, use `allow_patterns`. Everything the
192
+ `human_pairs` and `eval` configs reference is **2.1 GiB** — all 6,621 of their
193
+ images plus the annotations:
194
 
195
  ```python
196
  snapshot_download(
 
199
  )
200
  ```
201
 
202
+ Note that `eval/stage2` and `eval/stage2_extra` score rollouts of procedural
203
+ materials, so their candidate views live under `images/human_pairs/` rather than
204
+ `images/eval/` — both patterns are needed. The `synthetic` config is the other
205
+ 40 GiB (`images/cands/**` and `images/queries/**`).
206
+
207
  ## Contents
208
 
209
  | path | what | files |
 
216
  | `images/queries/masks/**` | part masks for those references | 11,543 |
217
  | `images/human_pairs/**` | S2 rollout renders, per material (train + eval) | 5,585 |
218
  | `images/eval/**` | evaluation references and method outputs | 1,036 |
219
+ | `viewer_assets/**` | WebP thumbnails + `cards.js` for `viewer.html` | — |
220
 
221
  59,441 images, 42.35 GiB, all PNG. Query paths are sharded two levels deep by
222
  content hash to keep any one directory well under the Hub's 10k-file guidance.
viewer.html CHANGED
@@ -54,20 +54,21 @@ footer{color:var(--muted);font-size:11px;text-align:center;padding:24px}
54
  <div class="controls" id="controls">
55
  <span class="sub">config</span>
56
  <button data-kind="cfg" data-v="all" class="on">all</button>
57
- <span class="sub" style="margin-left:10px">label</span>
58
  <button data-kind="lab" data-v="all" class="on">all</button>
59
  <input id="q" type="search" placeholder="filter by id / scene / material / group…">
60
  </div>
61
  </header>
62
  <main>
63
  <div class="stats" id="stats">loading…</div>
64
- <div id="cards"><div class="skeleton">loading viewer_assets/cards.json …</div></div>
65
  </main>
66
  <footer>
67
  images shown are lossy WebP thumbnails · full-resolution PNGs are the
68
  <code>images/…</code> paths referenced by the annotations ·
69
  <a href="https://huggingface.co/datasets/yuanze1024/ShaderAgent-MatScorer-Data">dataset card</a>
70
  </footer>
 
71
  <script>
72
  const $ = (s, r=document) => r.querySelector(s);
73
  const $$ = (s, r=document) => [...r.querySelectorAll(s)];
@@ -126,7 +127,8 @@ function buildFilters(){
126
  const cfg = [...new Set(CARDS.map(c => CFG_OF_SPLIT(c.split)))].sort();
127
  const lab = [...new Set(CARDS.map(c => c.label_source))].sort();
128
  const host = $('#controls');
129
- cfg.forEach(v => host.insertBefore(mkBtn('cfg', v), host.querySelector('span[style]')));
 
130
  lab.forEach(v => host.appendChild(mkBtn('lab', v)));
131
  $$('button').forEach(b => b.onclick = () => {
132
  $$(`button[data-kind=${b.dataset.kind}]`).forEach(x => x.classList.toggle('on', x === b));
@@ -140,17 +142,20 @@ function mkBtn(kind, v){
140
  return b;
141
  }
142
 
143
- fetch('viewer_assets/cards.json').then(r => {
144
- if (!r.ok) throw new Error('cards.json missing — was the dataset packaged?');
145
- return r.json();
146
- }).then(d => {
147
- CARDS = d.cards || [];
 
 
 
148
  buildFilters();
149
  render();
150
- }).catch(e => {
151
- $('#cards').innerHTML = `<div class="skeleton">could not load cards.json: ${esc(e.message)}</div>`;
152
  $('#stats').textContent = '';
153
- });
154
  $('#q').addEventListener('input', ev => { TEXT = ev.target.value.trim().toLowerCase(); render(); });
155
  </script>
156
  </body>
 
54
  <div class="controls" id="controls">
55
  <span class="sub">config</span>
56
  <button data-kind="cfg" data-v="all" class="on">all</button>
57
+ <span class="sub" id="lab-label" style="margin-left:10px">label</span>
58
  <button data-kind="lab" data-v="all" class="on">all</button>
59
  <input id="q" type="search" placeholder="filter by id / scene / material / group…">
60
  </div>
61
  </header>
62
  <main>
63
  <div class="stats" id="stats">loading…</div>
64
+ <div id="cards"><div class="skeleton">loading viewer_assets/cards.js …</div></div>
65
  </main>
66
  <footer>
67
  images shown are lossy WebP thumbnails · full-resolution PNGs are the
68
  <code>images/…</code> paths referenced by the annotations ·
69
  <a href="https://huggingface.co/datasets/yuanze1024/ShaderAgent-MatScorer-Data">dataset card</a>
70
  </footer>
71
+ <script src="viewer_assets/cards.js"></script>
72
  <script>
73
  const $ = (s, r=document) => r.querySelector(s);
74
  const $$ = (s, r=document) => [...r.querySelectorAll(s)];
 
127
  const cfg = [...new Set(CARDS.map(c => CFG_OF_SPLIT(c.split)))].sort();
128
  const lab = [...new Set(CARDS.map(c => c.label_source))].sort();
129
  const host = $('#controls');
130
+ const anchor = $('#lab-label');
131
+ cfg.forEach(v => host.insertBefore(mkBtn('cfg', v), anchor));
132
  lab.forEach(v => host.appendChild(mkBtn('lab', v)));
133
  $$('button').forEach(b => b.onclick = () => {
134
  $$(`button[data-kind=${b.dataset.kind}]`).forEach(x => x.classList.toggle('on', x === b));
 
142
  return b;
143
  }
144
 
145
+ // cards.js assigns this global. A <script src> works from file://, which is how
146
+ // the dataset card tells people to open this page; fetch() would be blocked.
147
+ try {
148
+ const d = window.__MATSCORER_CARDS__;
149
+ if (!d || !Array.isArray(d.cards)) {
150
+ throw new Error('viewer_assets/cards.js did not load — keep it next to this file');
151
+ }
152
+ CARDS = d.cards;
153
  buildFilters();
154
  render();
155
+ } catch (e) {
156
+ $('#cards').innerHTML = `<div class="skeleton">could not load the card data: ${esc(e.message)}</div>`;
157
  $('#stats').textContent = '';
158
+ }
159
  $('#q').addEventListener('input', ev => { TEXT = ev.target.value.trim().toLowerCase(); render(); });
160
  </script>
161
  </body>
viewer_assets/cards.js ADDED
The diff for this file is too large to render. See raw diff
 
viewer_assets/cards.json DELETED
The diff for this file is too large to render. See raw diff