Complete training-data provenance and Braindecode software citation
Browse filesREADME-only metadata audit, 2026-11-09. Braindecode Zenodo citation. No weights, config, license, or upstream paper citations changed.
README.md
CHANGED
|
@@ -32,3 +32,38 @@ accessions, Hub ids otherwise). `nm`/`on` ids are datasets on [NEMAR](https://ne
|
|
| 32 |
- Supervised AttnSleep (5 classes), channel Fpz-Cz only. SleepPhysionet subject_ids=[0..5], recording_ids=[1, 2] -> 12 recordings, but split ids are recording indices: train = indices 0-3 = subjects 0 and 1, both nights (SC4001, SC4002, SC4011, SC4012); valid = indices 4-5 = subject 2, both nights (SC4021, SC4022), used by EarlyStopping(monitor='valid_bal_acc', patience 20, load_best=True). Subjects 3, 4, 5 are loaded but never used. The tutorial text and the trainer's W&B config say 'subjects 0-3 train / 4-5 valid', which is not what the code does. 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...; braindecode a283ae09:braindecode/datasets/base.py (BaseConcatDataset.split); W/bd/examples/applied_examples/plot_sleep_staging_eldele2021.py; braindecode check: https://huggingface.co/braindecode/plot_sleep_staging_eldele2021/resolve/main/history.json (summed batch sizes, epoch 1).
|
| 34 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
- Supervised AttnSleep (5 classes), channel Fpz-Cz only. SleepPhysionet subject_ids=[0..5], recording_ids=[1, 2] -> 12 recordings, but split ids are recording indices: train = indices 0-3 = subjects 0 and 1, both nights (SC4001, SC4002, SC4011, SC4012); valid = indices 4-5 = subject 2, both nights (SC4021, SC4022), used by EarlyStopping(monitor='valid_bal_acc', patience 20, load_best=True). Subjects 3, 4, 5 are loaded but never used. The tutorial text and the trainer's W&B config say 'subjects 0-3 train / 4-5 valid', which is not what the code does. 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...; braindecode a283ae09:braindecode/datasets/base.py (BaseConcatDataset.split); W/bd/examples/applied_examples/plot_sleep_staging_eldele2021.py; braindecode check: https://huggingface.co/braindecode/plot_sleep_staging_eldele2021/resolve/main/history.json (summed batch sizes, epoch 1).
|
| 34 |
|
| 35 |
+
|
| 36 |
+
|
| 37 |
+
## Cite Braindecode
|
| 38 |
+
|
| 39 |
+
If you use this braindecode port in scientific work, cite the software on Zenodo,
|
| 40 |
+
[doi:10.5281/zenodo.17699192](https://doi.org/10.5281/zenodo.17699192),
|
| 41 |
+
and the original model and datasets cited above.
|
| 42 |
+
|
| 43 |
+
```bibtex
|
| 44 |
+
@software{braindecode,
|
| 45 |
+
author = {Aristimunha, Bruno and
|
| 46 |
+
Guetschel, Pierre and
|
| 47 |
+
Wimpff, Martin and
|
| 48 |
+
Gemein, Lukas and
|
| 49 |
+
Rommel, Cedric and
|
| 50 |
+
Banville, Hubert and
|
| 51 |
+
Sliwowski, Maciej and
|
| 52 |
+
Wilson, Daniel and
|
| 53 |
+
Brandt, Simon and
|
| 54 |
+
Gnassounou, Théo and
|
| 55 |
+
Paillard, Joseph and
|
| 56 |
+
{Junqueira Lopes}, Bruna and
|
| 57 |
+
Sedlar, Sara and
|
| 58 |
+
Moreau, Thomas and
|
| 59 |
+
Chevallier, Sylvain and
|
| 60 |
+
Gramfort, Alexandre and
|
| 61 |
+
Schirrmeister, Robin Tibor},
|
| 62 |
+
title = {Braindecode: toolbox for decoding raw electrophysiological brain data
|
| 63 |
+
with deep learning models},
|
| 64 |
+
url = {https://github.com/braindecode/braindecode},
|
| 65 |
+
doi = {10.5281/zenodo.17699192},
|
| 66 |
+
publisher = {Zenodo},
|
| 67 |
+
license = {BSD-3-Clause},
|
| 68 |
+
}
|
| 69 |
+
```
|