ilya16 commited on
Commit
cb3e646
·
verified ·
1 Parent(s): 90e3dde

Update README.md

Browse files

Add arXiv link and Quick Start section

Files changed (1) hide show
  1. README.md +66 -3
README.md CHANGED
@@ -140,12 +140,13 @@ The pipeline ensures perfect note-by-note score-performance synchronization for
140
 
141
  ## Related Resources
142
 
143
- * **Publication:** https://transactions.ismir.net/articles/10.5334/tismir.333
 
144
  * **GitHub:** https://github.com/ilya16/PianoCoRe
145
- * **Zenodo:** https://zenodo.org/records/19186016
146
 
147
  **Note**: This Hugging Face version stores data in compressed Parquet files with raw bytes.
148
- If you prefer plain MIDI files in a directory structure, please use the [Zenodo Mirror](https://doi.org/10.5281/zenodo.19186016).
149
 
150
  ## Dataset Tiers
151
 
@@ -171,6 +172,68 @@ To support different research applications, the dataset is organized into tiered
171
 
172
  *Applications*: expressive piano performance rendering, performance-to-score transcription.
173
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
174
  ---
175
 
176
  ## Dataset Metadata
 
140
 
141
  ## Related Resources
142
 
143
+ * **TISMIR:** https://doi.org/10.5334/tismir.333
144
+ * **arXiv:** https://arxiv.org/abs/2605.06627
145
  * **GitHub:** https://github.com/ilya16/PianoCoRe
146
+ * **Zenodo:** https://doi.org/10.5281/zenodo.19186016
147
 
148
  **Note**: This Hugging Face version stores data in compressed Parquet files with raw bytes.
149
+ If you prefer the original MIDI files in a directory structure, please use the [Zenodo Mirror](https://doi.org/10.5281/zenodo.19186016).
150
 
151
  ## Dataset Tiers
152
 
 
172
 
173
  *Applications*: expressive piano performance rendering, performance-to-score transcription.
174
 
175
+ ## Quick Start
176
+
177
+ Use the following example code to access the metadata:
178
+ ```python
179
+ from datasets import load_dataset
180
+
181
+ # Load the train split of the PianoCoRe dataset (streaming mode)
182
+ dataset = load_dataset("SyMuPe/PianoCoRe", split="train", streaming=True)
183
+
184
+ # Optionally drop heavy columns with bytes (e.g., MusicXML/MXL data)
185
+ # dataset = dataset.remove_columns(["score_xml_bytes"])
186
+
187
+ # Filter for high-confidence samples (PianoCoRe-A*)
188
+ dataset_a_star = dataset.filter(lambda x: x["tier_a_star"])
189
+
190
+ # Take one sample
191
+ sample = next(iter(dataset_a_star))
192
+ print(f"ID: {sample['id']}")
193
+ print(f"Work: {sample['composer']} - {sample['composition']}" + (f" - {sample['movement']}" if sample["movement"] else ""))
194
+ print(f"Score: {sample['score_midi_path']}")
195
+ print(f"Performance: {sample['performance_midi_path']}\n")
196
+ ```
197
+
198
+ The **raw** MIDI data and alignments can be accessed using:
199
+ ```python
200
+ from symusic import Score
201
+ from symupe import Alignment
202
+
203
+ # Load raw score and performance MIDI data
204
+ score_midi = Score.from_midi(sample["score_midi_bytes"]) if sample["score_midi_bytes"] is not None else None
205
+ performance_midi = Score.from_midi(sample["performance_midi_bytes"])
206
+ print(f"Score MIDI: {score_midi}")
207
+ print(f"Performance MIDI: {performance_midi}")
208
+
209
+ # Load raw alignment
210
+ if sample['raw_alignment_bytes'] is not None:
211
+ raw_alignment = Alignment.from_bytes(sample["raw_alignment_bytes"])
212
+ print(f"Raw alignment: {len(raw_alignment)} total and {raw_alignment.num_full_pairs} matched pairs")
213
+
214
+ # Save in a human-readable format
215
+ # raw_alignment.save("alignment.txt")
216
+ ```
217
+
218
+ The **refined** MIDI data and alignments can be accessed using:
219
+ ```python
220
+ import io
221
+ import numpy as np
222
+ from symusic import Score
223
+
224
+ if sample["refined_performance_midi_bytes"] is not None:
225
+ # Load refined score and performance MIDI data
226
+ score_midi = Score.from_midi(sample["refined_score_midi_bytes"])
227
+ performance_midi = Score.from_midi(sample["refined_performance_midi_bytes"])
228
+ print(f"Refined Score MIDI: {score_midi}")
229
+ print(f"Refined Performance MIDI: {performance_midi}")
230
+
231
+ # Load refined alignment
232
+ refined_alignment = np.load(io.BytesIO(sample["refined_alignment_bytes"]))
233
+ print(f"Refined Alignment:")
234
+ print(f" performance indices: {refined_alignment['perf_idx']}")
235
+ print(f" interpolation mask: {refined_alignment['interpolated']}")
236
+ ```
237
  ---
238
 
239
  ## Dataset Metadata