zsysuyang commited on
Commit
8f677cd
·
verified ·
1 Parent(s): a38691f

Polish SPT card navigation and resource badges

Browse files
README.md CHANGED
@@ -33,9 +33,18 @@ configs:
33
 
34
  <p align="center">Suyang Zhong, Boying Huang, Pengwei Xu, Fanjie Xu, Yuhao Zhao,<br>Jun Cheng, Fujie Tang, Weinan E, Zhong-Qun Tian</p>
35
 
 
 
 
 
 
 
 
36
  <p align="center"><a href="https://github.com/zsy-suyang/SPT">Code &amp; experiments</a> · <a href="#dataset-overview">Overview</a> · <a href="#download-and-use">Download &amp; use</a> · <a href="datasets/DATA_INDEX.csv">Data index</a> · <a href="#citation">Citation</a></p>
37
 
38
- ## Dataset overview
 
 
39
 
40
  This is the dataset collection for the Spectral Pattern Translator (SPT), which infers electronic, local-geometric and crystallographic descriptors from X-ray absorption near-edge structure (XANES). It contains computed oxide spectra with structure-derived labels, prepared measured spectra with their source information, fixed data partitions and model reference predictions. The release supports the benchmark, spectral-control, application and transfer-learning experiments in the accompanying manuscript.
41
 
@@ -53,7 +62,9 @@ The main benchmark contains **54,744 computed spectra** and **12 site-specific d
53
 
54
  **Framework overview.** SPT combines multiscale spectral processing with relationships between spectral energy points. The example input is a computed Co K-edge spectrum; internal features, connections and descriptor glyphs are schematic. Implementation details and experiment commands are in the [code repository](https://github.com/zsy-suyang/SPT).
55
 
56
- ## Release
 
 
57
 
58
  | Dataset release | Compatible SPT code | Contents |
59
  | --- | --- | --- |
@@ -61,7 +72,9 @@ The main benchmark contains **54,744 computed spectra** and **12 site-specific d
61
 
62
  Model checkpoints and configurations are distributed separately in the [SPT model repository](https://huggingface.co/zsysuyang/XAS_SPT), with the matching release `2026-10-25`. This dataset can be downloaded and inspected independently of the weights.
63
 
64
- ## Repository contents
 
 
65
 
66
  | Directory or file | Contents |
67
  | --- | --- |
@@ -79,7 +92,9 @@ Model checkpoints and configurations are distributed separately in the [SPT mode
79
 
80
  The [data index](datasets/DATA_INDEX.csv) describes individual files. The [asset manifest](ASSET_MANIFEST.json) lists numerical assets and their sizes. Reference prediction files contain **model outputs**, distinct from structure-derived labels and experimental comparison values.
81
 
82
- ## Computed benchmark
 
 
83
 
84
  ### Tables and partitions
85
 
@@ -126,7 +141,9 @@ The spectrum columns are numeric lists stored as CSV strings. Parse them with `a
126
 
127
  The benchmark has eight classification and four regression tasks. The retained `NNAS` columns and oxygen-site `OS` column are not benchmark targets. Negative oxidation-state values are valid labels, not missing-value codes. Encoded prediction indices must be decoded with the corresponding model's class map.
128
 
129
- ## Application spectra and sources
 
 
130
 
131
  | Cohort directory | Type | Spectra | Source |
132
  | --- | --- | ---: | --- |
@@ -154,13 +171,17 @@ Prepared spectra use long-format CSV:
154
 
155
  Cohort-specific metadata include voltage, state of charge, scan number, sample name or activation state. The prepared inputs preserve the energy referencing and resampling used in the reported applications. [Application documentation](https://github.com/zsy-suyang/SPT/blob/main/docs/application-data.md) gives the preparation and source details. Application NNRS and MOOD predictions are in ångströms.
156
 
157
- ## Transfer data and reference results
 
 
158
 
159
  `datasets/transfer/` separates the crystalline computed source data, computed disordered target data and task-specific training subsets. The OS, CN and OCN target tables provide entry points to the same 399-spectrum target collection. The fixed transfer partition contains 285 training-pool spectra and 114 evaluation spectra; the training subsets contain 29, 72 or 143 spectra. Partition and subset definitions are in `data/splits/transfer/`. These are computed spectra, not experimental measurements.
160
 
161
  `reference_predictions/` contains per-spectrum outputs for the computed benchmark, transfer experiments and uncertainty analyses. `reference_results/` contains numerical summaries. Use the [experiment guides](https://github.com/zsy-suyang/SPT/blob/main/docs/reproduce.md) and [transfer guide](https://github.com/zsy-suyang/SPT/blob/main/docs/transfer.md) to select the corresponding inputs and models.
162
 
163
- ## Download and use
 
 
164
 
165
  ### Download the collection
166
 
@@ -218,15 +239,21 @@ spt application --cohort ni_fe_activation \
218
 
219
  The Ni applications use their registered CPU settings. Other cohorts and the computed reference experiments use the environments specified in the [application guide](https://github.com/zsy-suyang/SPT/blob/main/docs/applications.md) and [numerical-experiment guide](https://github.com/zsy-suyang/SPT/blob/main/docs/reproduce.md). The model registry maps each experiment to its data and checkpoint.
220
 
221
- ## Intended use
 
 
222
 
223
  The collection supports descriptor-learning benchmarks, spectral sensitivity analysis and evaluation on the supplied application cohorts. Computed labels derive from the corresponding structures; measured-data comparison labels and EXAFS values are identified in the cohort source information. Reference predictions are not substitutes for experimental ground truth. Apply the supplied partitions, descriptor eligibility and preprocessing when comparing with the reported results.
224
 
225
- ## Licence and attribution
 
 
226
 
227
  The repository retains its existing **Apache-2.0** licence for author-provided material; see [LICENSE](LICENSE). Third-party spectra, structures and source files retain their original terms and attribution requirements. In particular, retain the [NIST licence notice](datasets/applications/ti_nist_standards/source_context/NIST_LICENSE). The repository-level licence does not override these source-specific terms.
228
 
229
- ## Citation
 
 
230
 
231
  Please cite this dataset collection and the accompanying manuscript. Dataset metadata are provided in [CITATION.cff](CITATION.cff).
232
 
 
33
 
34
  <p align="center">Suyang Zhong, Boying Huang, Pengwei Xu, Fanjie Xu, Yuhao Zhao,<br>Jun Cheng, Fujie Tang, Weinan E, Zhong-Qun Tian</p>
35
 
36
+ <p align="center">
37
+ <a href="https://github.com/zsy-suyang/SPT"><img src="images/badge-code.svg" alt="GitHub code"></a>
38
+ <a href="https://huggingface.co/datasets/zsysuyang/XAS_SPT"><img src="images/badge-data.svg" alt="Hugging Face dataset"></a>
39
+ <a href="https://huggingface.co/zsysuyang/XAS_SPT"><img src="images/badge-weights.svg" alt="Hugging Face model weights"></a>
40
+ <a href="LICENSE"><img src="images/badge-license.svg" alt="Repo license: Apache-2.0"></a>
41
+ </p>
42
+
43
  <p align="center"><a href="https://github.com/zsy-suyang/SPT">Code &amp; experiments</a> · <a href="#dataset-overview">Overview</a> · <a href="#download-and-use">Download &amp; use</a> · <a href="datasets/DATA_INDEX.csv">Data index</a> · <a href="#citation">Citation</a></p>
44
 
45
+ <a id="dataset-overview"></a>
46
+
47
+ ## 📖 Dataset overview
48
 
49
  This is the dataset collection for the Spectral Pattern Translator (SPT), which infers electronic, local-geometric and crystallographic descriptors from X-ray absorption near-edge structure (XANES). It contains computed oxide spectra with structure-derived labels, prepared measured spectra with their source information, fixed data partitions and model reference predictions. The release supports the benchmark, spectral-control, application and transfer-learning experiments in the accompanying manuscript.
50
 
 
62
 
63
  **Framework overview.** SPT combines multiscale spectral processing with relationships between spectral energy points. The example input is a computed Co K-edge spectrum; internal features, connections and descriptor glyphs are schematic. Implementation details and experiment commands are in the [code repository](https://github.com/zsy-suyang/SPT).
64
 
65
+ <a id="release"></a>
66
+
67
+ ## 📦 Release
68
 
69
  | Dataset release | Compatible SPT code | Contents |
70
  | --- | --- | --- |
 
72
 
73
  Model checkpoints and configurations are distributed separately in the [SPT model repository](https://huggingface.co/zsysuyang/XAS_SPT), with the matching release `2026-10-25`. This dataset can be downloaded and inspected independently of the weights.
74
 
75
+ <a id="repository-contents"></a>
76
+
77
+ ## 🗂️ Repository contents
78
 
79
  | Directory or file | Contents |
80
  | --- | --- |
 
92
 
93
  The [data index](datasets/DATA_INDEX.csv) describes individual files. The [asset manifest](ASSET_MANIFEST.json) lists numerical assets and their sizes. Reference prediction files contain **model outputs**, distinct from structure-derived labels and experimental comparison values.
94
 
95
+ <a id="computed-benchmark"></a>
96
+
97
+ ## 📊 Computed benchmark
98
 
99
  ### Tables and partitions
100
 
 
141
 
142
  The benchmark has eight classification and four regression tasks. The retained `NNAS` columns and oxygen-site `OS` column are not benchmark targets. Negative oxidation-state values are valid labels, not missing-value codes. Encoded prediction indices must be decoded with the corresponding model's class map.
143
 
144
+ <a id="application-spectra-and-sources"></a>
145
+
146
+ ## 🔬 Application spectra and sources
147
 
148
  | Cohort directory | Type | Spectra | Source |
149
  | --- | --- | ---: | --- |
 
171
 
172
  Cohort-specific metadata include voltage, state of charge, scan number, sample name or activation state. The prepared inputs preserve the energy referencing and resampling used in the reported applications. [Application documentation](https://github.com/zsy-suyang/SPT/blob/main/docs/application-data.md) gives the preparation and source details. Application NNRS and MOOD predictions are in ångströms.
173
 
174
+ <a id="transfer-data-and-reference-results"></a>
175
+
176
+ ## 🔄 Transfer data and reference results
177
 
178
  `datasets/transfer/` separates the crystalline computed source data, computed disordered target data and task-specific training subsets. The OS, CN and OCN target tables provide entry points to the same 399-spectrum target collection. The fixed transfer partition contains 285 training-pool spectra and 114 evaluation spectra; the training subsets contain 29, 72 or 143 spectra. Partition and subset definitions are in `data/splits/transfer/`. These are computed spectra, not experimental measurements.
179
 
180
  `reference_predictions/` contains per-spectrum outputs for the computed benchmark, transfer experiments and uncertainty analyses. `reference_results/` contains numerical summaries. Use the [experiment guides](https://github.com/zsy-suyang/SPT/blob/main/docs/reproduce.md) and [transfer guide](https://github.com/zsy-suyang/SPT/blob/main/docs/transfer.md) to select the corresponding inputs and models.
181
 
182
+ <a id="download-and-use"></a>
183
+
184
+ ## 📥 Download and use
185
 
186
  ### Download the collection
187
 
 
239
 
240
  The Ni applications use their registered CPU settings. Other cohorts and the computed reference experiments use the environments specified in the [application guide](https://github.com/zsy-suyang/SPT/blob/main/docs/applications.md) and [numerical-experiment guide](https://github.com/zsy-suyang/SPT/blob/main/docs/reproduce.md). The model registry maps each experiment to its data and checkpoint.
241
 
242
+ <a id="intended-use"></a>
243
+
244
+ ## 🎯 Intended use
245
 
246
  The collection supports descriptor-learning benchmarks, spectral sensitivity analysis and evaluation on the supplied application cohorts. Computed labels derive from the corresponding structures; measured-data comparison labels and EXAFS values are identified in the cohort source information. Reference predictions are not substitutes for experimental ground truth. Apply the supplied partitions, descriptor eligibility and preprocessing when comparing with the reported results.
247
 
248
+ <a id="licence-and-attribution"></a>
249
+
250
+ ## ⚖️ Licence and attribution
251
 
252
  The repository retains its existing **Apache-2.0** licence for author-provided material; see [LICENSE](LICENSE). Third-party spectra, structures and source files retain their original terms and attribution requirements. In particular, retain the [NIST licence notice](datasets/applications/ti_nist_standards/source_context/NIST_LICENSE). The repository-level licence does not override these source-specific terms.
253
 
254
+ <a id="citation"></a>
255
+
256
+ ## 📝 Citation
257
 
258
  Please cite this dataset collection and the accompanying manuscript. Dataset metadata are provided in [CITATION.cff](CITATION.cff).
259
 
images/badge-code.svg ADDED
images/badge-data.svg ADDED
images/badge-license.svg ADDED
images/badge-weights.svg ADDED