Scandiumlabs commited on
Commit
1688793
·
verified ·
1 Parent(s): 10b03e6

Release v1.9.0: CHANGELOG.md

Browse files
Files changed (1) hide show
  1. CHANGELOG.md +67 -1
CHANGELOG.md CHANGED
@@ -1,11 +1,77 @@
1
 
2
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  ## [v1.9.0-hf] — 2026-08-07 (Hugging Face publication)
4
 
5
  - **Published to Hugging Face Hub**: `Scandium-Labs/solid-state-electrolyte-conductivity` (public, tagged `v1.9.0`) — https://huggingface.co/datasets/Scandium-Labs/solid-state-electrolyte-conductivity.
6
  - **Multi-config layout** (auto-detected by the HF dataset viewer): `default` (30,838 canonical records × 246 columns), `verified` (183 literature-verified transport labels), `consensus` (427-material cross-paper consensus DB), `gold_benchmark` (165-record gold subset).
7
  - **SEO dataset card** (`README.md` on HF): YAML frontmatter (`task_categories`, `tags`, `size_categories`, `configs`) + first-paragraph/highlight framing for search; honest scope caveat (183 verified vs 30,838 bulk) above the fold; per-source licensing section.
8
- - **Stale docs fixed before publish**: `docs_output/datasheet.md` regenerated from current data (was 676 records / 24 labels → 30,838 / 183); `CITATION.cff` bumped to v1.9.0 / 2026-08-07 / correct `Scandium-Labs` GitHub org; datasheet + citation generators updated to match.
9
  - **New tooling**: `scripts/publish_hf_dataset.py` — deterministic staging (`hf_publish/`) + per-file upload (resumable, independent commits) + `create_tag`.
10
  - **Verified end-to-end**: all four config parquet files download + read from the hub (default 30,838×246, verified 183×246, consensus 427×22, gold 165×298). **Tests: 869 pass.**
11
 
 
1
 
2
 
3
+ ## [v1.9.0-guide] — 2026-08-07 (improving-scandium-ssb-dataset guide §5, actions 1–10)
4
+
5
+ Implements the methodology-improvement guide (`guides/improving-scandium-ssb-dataset.md`)
6
+ benchmarked against OBELiX (Therrien et al. 2025) and LiIon (Hargreaves et al.
7
+ 2023). All 10 prioritized actions shipped as deterministic tooling + artifacts.
8
+ No LLM calls. **890 tests pass.** RELEASE READY — staged in `release/v1.9.0/`.
9
+
10
+ - **A1 — OBELiX-style leakage-free split now canonical**:
11
+ `ml_features.split_assignment` + `split_group_key` are finally populated on
12
+ all 30,838 rows (they were schema fields that had been null since v0.6). New
13
+ `paper_ood` split regime (`src/ssb_dataset/benchmarks/splits.py`): union-find
14
+ connected components over (source DOI, reduced formula) — any two entries
15
+ sharing a paper *or* a composition land in the same split, so a paper
16
+ reporting a doping series can never straddle train/test. Test fraction 20.3%
17
+ (OBELiX's 20–30% target). Backfilled by `scripts/backfill_split_assignment.py`
18
+ (gold rows preserved as `gold_benchmark`), wired into the release build chain.
19
+ paper_ood OOD gap vs random is visible in the leaderboard (e.g. formation
20
+ energy MAE 0.067 → 0.156, density 0.118 → 0.402).
21
+ - **A3 — experimental noise floor published**: `scripts/compute_noise_floor.py`
22
+ → `validation_output/noise_floor_report.{json,md}`. **76 repeat-measurement
23
+ groups (206 entries), RMS 0.354 / MAD 0.153 log10 σ** — from a repeat tier
24
+ ~1.6× larger than OBELiX's 48 groups, and ~2.7× tighter than their 0.63/0.41.
25
+ Bulk vs total conductivities are never pooled (grouped by
26
+ composition::conductivity_type). Any model beating MAD 0.153 log10 σ is
27
+ likely overfit.
28
+ - **A4 — bulk/total conductivity enum-leak fixed**:
29
+ `scripts/normalize_conductivity_type.py` — `"ConductivityType.total"` and
30
+ `"total"` were silently different strings (71 rows), same for bulk; fixed to
31
+ clean `total`/`bulk`/`grain_boundary`, and labeled rows with no stated type
32
+ are stamped `unknown` (never guessed). Audit at
33
+ `validation_output/conductivity_type_audit.json`.
34
+ - **A5 — rejection-rate statistic published**:
35
+ `scripts/compute_rejection_stats.py` → `validation_output/rejection_statistics.{json,md}`.
36
+ Review funnel: 402 submitted, 215 approved / 178 rejected / 9 pending →
37
+ **rejection rate 45.3%**. Top reasons (deterministic categorization of human
38
+ review notes): duplicate/DUP_VALUE 80, hallucination/value-not-in-paper 25,
39
+ unit errors (mS/cm→S/cm) 18, evidence-missing 17, composition-series
40
+ hallucinated variants 13.
41
+ - **A6 — structure-to-label attribution audit**:
42
+ `scripts/audit_structure_attribution.py` → `validation_output/structure_attribution_audit.{json,md}`.
43
+ Honest finding: only 35/183 labeled rows (19%) have a reduced-formula-matched
44
+ MP structure; the other 148 (composites, glasses, off-stoichiometric LLTO
45
+ variants) have no single-phase MP match. The 35 attached structures are MP
46
+ DFT structures — a documented systematic borrow (structure from MP, label
47
+ from paper). 11 attached labels are polymorph-ambiguous (>1 MP structure).
48
+ - **A7 — disorder-aware occupancy note** added to the datasheet's Known
49
+ Limitations: `structure.li_site_occupancy` exists for disorder-aware models,
50
+ but the current harvest records fully-occupied sites only (all occupancies
51
+ 1.0); standard GNNs round partial occupancy to integers anyway — caveat
52
+ documented for downstream users.
53
+ - **A8 — compositional coverage UMAP**: `scripts/plot_compositional_coverage.py`
54
+ → `visualization_output/compositional_coverage.png` — 20,000 DFT-backbone
55
+ points vs 122 verified labels in Magpie-descriptor space (UMAP, seeded,
56
+ deterministic). Visualizes the accessible-but-unexplored regions (LiIon
57
+ Fig 3/4 style) at a scale neither LiIon nor OBELiX had.
58
+ - **A9 — Ea consistency audit**: `scripts/audit_ea_consistency.py` →
59
+ `validation_output/ea_consistency_audit.{json,md}`. Ea coverage 49.7%
60
+ (91/183), 74 rows with both σ+Ea, 7 multi-paper Ea materials with **0
61
+ inconsistent** (MAD ≤ 0.2 eV) → verdict: keep the field (unlike LiIon, who
62
+ dropped Ea).
63
+ - **A10 — Kaggle registration note** added to README (planned, human task —
64
+ requires a Kaggle account; HF card + datasheet are the submission materials).
65
+ - **Release pipeline** (`scripts/release.py`): 6 new build-chain steps + 13 new
66
+ staged artifacts (paper_ood split, noise floor, conductivity audit, rejection
67
+ stats, attribution audit, Ea audit, UMAP png/json).
68
+
69
  ## [v1.9.0-hf] — 2026-08-07 (Hugging Face publication)
70
 
71
  - **Published to Hugging Face Hub**: `Scandium-Labs/solid-state-electrolyte-conductivity` (public, tagged `v1.9.0`) — https://huggingface.co/datasets/Scandium-Labs/solid-state-electrolyte-conductivity.
72
  - **Multi-config layout** (auto-detected by the HF dataset viewer): `default` (30,838 canonical records × 246 columns), `verified` (183 literature-verified transport labels), `consensus` (427-material cross-paper consensus DB), `gold_benchmark` (165-record gold subset).
73
  - **SEO dataset card** (`README.md` on HF): YAML frontmatter (`task_categories`, `tags`, `size_categories`, `configs`) + first-paragraph/highlight framing for search; honest scope caveat (183 verified vs 30,838 bulk) above the fold; per-source licensing section.
74
+ - **Stale docs fixed before publish**: `docs_output/datasheet.md` regenerated from current data (was 676 records / 24 labels → 30,838 / 183); `CITATION.cff` bumped to v1.9.0 / 2026-08-07 / correct `ScandiumLabs-in` GitHub org; datasheet + citation generators updated to match.
75
  - **New tooling**: `scripts/publish_hf_dataset.py` — deterministic staging (`hf_publish/`) + per-file upload (resumable, independent commits) + `create_tag`.
76
  - **Verified end-to-end**: all four config parquet files download + read from the hub (default 30,838×246, verified 183×246, consensus 427×22, gold 165×298). **Tests: 869 pass.**
77