ilkhamfy commited on
Commit
b4906e9
·
verified ·
1 Parent(s): de22afe

Add README.md

Browse files
Files changed (1) hide show
  1. README.md +159 -0
README.md ADDED
@@ -0,0 +1,159 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ license:
5
+ - cc-by-4.0
6
+ - cc-by-sa-4.0
7
+ tags:
8
+ - chemistry
9
+ - spectroscopy
10
+ - infrared
11
+ - nmr
12
+ - structure-elucidation
13
+ - cheminformatics
14
+ size_categories:
15
+ - 100K<n<1M
16
+ pretty_name: IRexp
17
+ dataset_info:
18
+ features:
19
+ - name: id
20
+ dtype: string
21
+ description: InChIKey (full)
22
+ - name: inchikey
23
+ dtype: string
24
+ - name: smiles
25
+ dtype: string
26
+ - name: selfies
27
+ dtype: string
28
+ - name: ir_bands_cm-1
29
+ sequence: float64
30
+ description: Experimental IR wavenumbers (cm⁻¹), author-transcribed or peak-picked
31
+ - name: h_nmr
32
+ dtype: string
33
+ description: ¹H shift list as printed in the source paper
34
+ - name: c_nmr
35
+ dtype: string
36
+ description: ¹³C shift list as printed in the source paper
37
+ - name: ir_source
38
+ dtype: string
39
+ description: Always "experimental"
40
+ - name: source_doi
41
+ dtype: string
42
+ description: DOI or accession of the source publication
43
+ - name: license
44
+ dtype: string
45
+ description: CC-BY-4.0 (PMC) or CC-BY-SA-4.0 (Chemotion)
46
+ ---
47
+
48
+ # IRexp — experimental IR band lists from open-access literature
49
+
50
+ **Paper:** [IRSpectra-Bench and IRexp: candidate recall, not verification, limits LLM elucidation from real experimental IR and NMR](https://github.com/IlkhamFY/spectro-agent) (*Digital Discovery*, 2026)
51
+
52
+ IRexp is the largest **openly redistributable** collection of **experimental infrared band lists** mined from open-access chemistry papers, often with co-reported ¹H/¹³C shift lists and resolved structures.
53
+
54
+ > **Important:** IRexp contains **band lists** (peak positions in cm⁻¹), not digitised absorbance traces. This is the form reported in publication text — the regime IRSpectra-Bench evaluates — and is not directly comparable to SDBS or NIST full spectra.
55
+
56
+ ## Dataset summary
57
+
58
+ | Split / file | Records | Description |
59
+ |---|---:|---|
60
+ | `irexp.jsonl.gz` | 121,233 | All IR band-list records |
61
+ | `irexp_resolved.jsonl.gz` | 43,060 | Structure-linked (100%) |
62
+ | … full IR + ¹H + ¹³C + structure | 33,201 | Multimodal quadruples |
63
+ | `train_no_bench.jsonl.gz` | 42,808 | **Recommended for training** — `irexp_resolved` minus all IRSpectra-Bench InChIKey-14 |
64
+ | `train_no_bench_nmr.jsonl.gz` | 32,949 | Same, requiring both ¹H and ¹³C |
65
+
66
+ **Provenance:** 119,345 records from PMC Open-Access (CC-BY-4.0); 1,888 from Chemotion/RADAR4Chem (CC-BY-SA-4.0). Use `scripts/split_license_pools.py` to separate pools.
67
+
68
+ **Companion benchmark:** [IRSpectra-Bench](https://github.com/IlkhamFY/spectro-agent/blob/main/docs/LEADERBOARD.md) — 194 blind elucidation problems built from IRexp; score submissions with `scripts/score_submission.py`.
69
+
70
+ ## Load in three lines
71
+
72
+ ```python
73
+ from datasets import load_dataset
74
+
75
+ # Full structure-linked corpus (43,060 records)
76
+ ds = load_dataset("ilkhamfy/IRexp", data_files="data/irexp_resolved.jsonl.gz", split="train")
77
+
78
+ row = ds[0]
79
+ print(row["ir_bands_cm-1"][:5], row["smiles"][:40])
80
+ ```
81
+
82
+ For **fine-tuning without benchmark leakage**, use `train_no_bench.jsonl.gz` (not the legacy `irexp_release/train.jsonl.gz`, which overlaps 117/200 benchmark compounds):
83
+
84
+ ```python
85
+ ds = load_dataset("ilkhamfy/IRexp", data_files="data/train_no_bench.jsonl.gz", split="train")
86
+ ```
87
+
88
+ Or clone the GitHub repo / Zenodo deposit and read locally:
89
+
90
+ ```python
91
+ import gzip, json
92
+
93
+ with gzip.open("irexp_resolved.jsonl.gz", "rt") as f:
94
+ row = json.loads(f.readline())
95
+ ```
96
+
97
+ ## Record schema
98
+
99
+ Each JSONL row:
100
+
101
+ ```json
102
+ {
103
+ "id": "AJCQUIFRMABSOZ-UHFFFAOYSA-N",
104
+ "inchikey": "AJCQUIFRMABSOZ-UHFFFAOYSA-N",
105
+ "smiles": "Cc1ccccc1NC(=O)Cn1cc...",
106
+ "selfies": "[C][C][=C]...",
107
+ "ir_bands_cm-1": [3318.0, 3146.0, 1704.0],
108
+ "h_nmr": "9.79 (s, 1H, NH-amide), ...",
109
+ "c_nmr": "164.87, 161.57, ...",
110
+ "ir_source": "experimental",
111
+ "source_doi": "10.1038/..."
112
+ }
113
+ ```
114
+
115
+ ## Training vs benchmarking
116
+
117
+ | Use case | File | Benchmark overlap |
118
+ |---|---|---|
119
+ | Pretrain IR encoder | `pretrain_ir.jsonl.gz` or all `ir_bands_cm-1` | N/A (mostly unlabeled) |
120
+ | Supervised IR→structure | `train_no_bench.jsonl.gz` | **None** (248 IK-14 held out) |
121
+ | Evaluate elucidation | [IRSpectra-Bench](https://github.com/IlkhamFY/spectro-agent/blob/main/docs/LEADERBOARD.md) | — |
122
+ | ⚠️ Legacy split | `irexp_release/train.jsonl.gz` | **117/200 IK-14 overlap** — do not use for benchmark evaluation |
123
+
124
+ Rebuild the held-out training pool:
125
+
126
+ ```bash
127
+ python scripts/build_train_no_bench.py # 42,808 rows
128
+ python scripts/build_train_no_bench.py --require-nmr # 32,949 rows (H+C required)
129
+ ```
130
+
131
+ ## Limitations (read before citing)
132
+
133
+ - **Band lists, not spectra** — median 9 bands (PMC) vs 39 (Chemotion peak-picked).
134
+ - **Literature-transcribed** — heterogeneous labs/instruments; not raw `.jdx` files.
135
+ - **Structure resolution 35%** of all records; use `irexp_resolved` for supervised tasks.
136
+ - **Extraction recall** of IR strings per paper not yet human-audited (transcription fidelity audited: 560/560 bands on n=60).
137
+
138
+ ## Citation
139
+
140
+ ```bibtex
141
+ @article{yabbarov2026irspectra,
142
+ title = {IRSpectra-Bench and {IRexp}: candidate recall, not verification,
143
+ limits {LLM} elucidation from real experimental {IR} and {NMR}},
144
+ author = {Yabbarov, Ilkham and Sondhi, Rudra and Vargas-Hern{\'a}ndez, Rodrigo A.},
145
+ journal = {Digital Discovery},
146
+ year = {2026},
147
+ note = {Zenodo DOI to be assigned at publication}
148
+ }
149
+ ```
150
+
151
+ ## Links
152
+
153
+ - **Dataset (Hugging Face):** https://huggingface.co/datasets/ilkhamfy/IRexp
154
+ - **Code & benchmark:** https://github.com/IlkhamFY/spectro-agent
155
+ - **Leaderboard:** https://github.com/IlkhamFY/spectro-agent/blob/main/docs/LEADERBOARD.md
156
+ - **Zenodo:** DOI minted at publication
157
+ - **Licence details:** `NOTICE` in this repository (and `data/NOTICE` in the GitHub mirror)
158
+
159
+ When uploading to Hugging Face, this file is the repository `README.md`.