Card: list the training data (datasets:, base_model:) and add a Training data section
Browse filesFollow-up to braindecode PR #1493: `from_pretrained` reads `datasets:` into `model.card_data`. Ids: MOABB names, NEMAR nm/on ids, OpenNeuro ds ids; evidence per checkpoint.
README.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# plot_sleep_staging_usleep
|
| 2 |
|
| 3 |
Pretrained artifacts for the Braindecode tutorial `examples/applied_examples/plot_sleep_staging_usleep.py`.
|
|
@@ -9,3 +14,21 @@ These files are meant to be loaded by the tutorial so the docs can show stable p
|
|
| 9 |
- `params.safetensors`: classifier parameters
|
| 10 |
- `history.json`: Skorch training history used by the tutorial plots
|
| 11 |
- `metadata.json`: summary metrics for the stored checkpoint
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
datasets:
|
| 3 |
+
- nm000185
|
| 4 |
+
---
|
| 5 |
+
|
| 6 |
# plot_sleep_staging_usleep
|
| 7 |
|
| 8 |
Pretrained artifacts for the Braindecode tutorial `examples/applied_examples/plot_sleep_staging_usleep.py`.
|
|
|
|
| 14 |
- `params.safetensors`: classifier parameters
|
| 15 |
- `history.json`: Skorch training history used by the tutorial plots
|
| 16 |
- `metadata.json`: summary metrics for the stored checkpoint
|
| 17 |
+
|
| 18 |
+
<!-- braindecode:training-data -->
|
| 19 |
+
## Training data
|
| 20 |
+
|
| 21 |
+
The data that shaped these weights. The ids are the `datasets:` field of this card,
|
| 22 |
+
which braindecode reads into `model.card_data.datasets` when you call
|
| 23 |
+
`from_pretrained` (MOABB class names for MOABB datasets, OpenNeuro / NEMAR
|
| 24 |
+
accessions, Hub ids otherwise). `nm`/`on` ids are datasets on [NEMAR](https://nemar.org)
|
| 25 |
+
(`on` = NEMAR's copy of the OpenNeuro dataset with the same number). Rows marked
|
| 26 |
+
`private:` are data the authors did not release; they are not in `datasets:`.
|
| 27 |
+
|
| 28 |
+
| `datasets:` id | Dataset | Stage | Modality |
|
| 29 |
+
|---|---|---|---|
|
| 30 |
+
| [`nm000185`](https://nemar.org/dataset/nm000185) | [Sleep-EDF Database Expanded, Sleep Cassette study (PhysioNet sleep-edfx 1.0.0), loaded with braindecode SleepPhysionet (EEG channels Fpz-Cz / Pz-Oz only)](https://physionet.org/content/sleep-edfx/1.0.0/) | training | EEG |
|
| 31 |
+
|
| 32 |
+
- Supervised USleep (5 classes). SleepPhysionet subject_ids=[0, 1], recording_ids=[2], crop_wake_mins=30, then crop=(0, 12000 s) (first 400 30-s windows) -> subject 0 night 2 trains, subject 1 night 2 is the validation recording for EarlyStopping(load_best=True). Split is BaseConcatDataset.split(dict(train=..., valid=...)), whose values are RECORDING INDICES into the concatenated dataset, not subject ids (braindecode/datasets/base.py split: `[self.datasets[ds_ind] for ds_ind in ds_inds]`); SleepPhysionet orders recordings subject by subject, night 1 before night 2 (mne fetch_data loops `for subject in subjects`).
|
| 33 |
+
- Sources: braindecode git 05e606dd^:scripts/train_and_push_tutorial_checkpoints.py (offline trainer that produced the tutorial checkpoints; removed from the repo in 05e606dd, 2026-04-19, and moved to https://gist.github.com/bru...; W/bd/examples/applied_examples/plot_sleep_staging_usleep.py; https://huggingface.co/braindecode/plot_sleep_staging_usleep/resolve/main/metadata.json.
|
| 34 |
+
|