bruAristimunha commited on
Commit
ae927f4
·
verified ·
1 Parent(s): f1f8563

Complete training-data provenance and Braindecode software citation

Browse files

README-only metadata audit, 2026-11-09. datasets and verified inherited/trained corpus; Braindecode Zenodo citation. No weights, config, license, or upstream paper citations changed.

Files changed (1) hide show
  1. README.md +83 -0
README.md CHANGED
@@ -9,6 +9,19 @@ tags:
9
  - ecog
10
  - finger-flexion
11
  - pytorch_model_hub_mixin
 
 
 
 
 
 
 
 
 
 
 
 
 
12
  ---
13
 
14
  # CORTEG, Stanford finger flexion (pooled)
@@ -37,6 +50,41 @@ the authors' `load_corteg` on the two release files to 1.5e-06
37
  in float32 on CPU, for montages of 8 and 46
38
  contacts.
39
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
40
  ## Usage
41
 
42
  The model reads two streams of the same 1 s window, as the paper's Stanford
@@ -91,3 +139,38 @@ cohort mean of 0.554 (manifest, `paper.verified`).
91
 
92
  The adapter and the ST-EEGFormer backbone are both released by Liuyin Yang
93
  under the MIT licence (`LICENSE`). Braindecode's code is BSD-3-Clause.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  - ecog
10
  - finger-flexion
11
  - pytorch_model_hub_mixin
12
+ datasets:
13
+ - nm000245
14
+ - nm000172
15
+ - nm000139
16
+ - nm000135
17
+ - Kaya2018
18
+ - Won2022
19
+ - nm000129
20
+ - nm000339
21
+ - SparrKULee
22
+ - SEED-V
23
+ - Stanford-FingerFlex
24
+
25
  ---
26
 
27
  # CORTEG, Stanford finger flexion (pooled)
 
50
  in float32 on CPU, for montages of 8 and 46
51
  contacts.
52
 
53
+
54
+ <!-- braindecode:training-data -->
55
+ ## Training data
56
+
57
+ The data that shaped these weights. The ids are the `datasets:` field of this card,
58
+ which braindecode reads into `model.card_data.datasets` when you call
59
+ `from_pretrained` (MOABB class names for MOABB datasets, OpenNeuro / NEMAR
60
+ accessions, Hub ids otherwise). `nm`/`on` ids are datasets on [NEMAR](https://nemar.org)
61
+ (`on` = NEMAR's copy of the OpenNeuro dataset with the same number). Rows marked
62
+ `private:` are data the authors did not release; they are not in `datasets:`.
63
+
64
+ | `datasets:` id | Dataset | Stage | Modality |
65
+ |---|---|---|---|
66
+ | [`nm000245`](https://nemar.org/dataset/nm000245) | [EEG-MI-BCI: Cho et al. 2017, EEG datasets for motor imagery BCI (52 subjects, 64 ch, left/right-hand MI; GigaDB 100295); MOABB Cho2017](http://gigadb.org/dataset/100295) | pretraining | EEG |
67
+ | [`nm000172`](https://nemar.org/dataset/nm000172) | [High Gamma Dataset (HGD), Schirrmeister et al. 2017 (20 subjects, 128 ch, executed movements); MOABB Schirrmeister2017](https://gin.g-node.org/robintibor/high-gamma-dataset) | pretraining | EEG |
68
+ | [`nm000139`](https://nemar.org/dataset/nm000139) | [BCI Competition IV dataset 2a (9 subjects, 22 ch, 4-class MI); MOABB BNCI2014_001](https://www.bbci.de/competition/iv/#dataset2a) | pretraining | EEG |
69
+ | [`nm000135`](https://nemar.org/dataset/nm000135) | [BCI Competition IV dataset 2b (9 subjects, 3 ch, 2-class MI); MOABB BNCI2014_004](https://www.bbci.de/competition/iv/#dataset2b) | pretraining | EEG |
70
+ | `Kaya2018` | [Kaya et al. 2018, A large electroencephalographic motor imagery dataset for EEG BCIs (Sci. Data 5:180211; Figshare collection 3917698). Paper uses two subsets, 'Large-MI-Classic' and 'Large-MI-5F'. MOABB Kaya2018 (moabb>=1.7.2) loads only the 17 CLA files, not the 5F (or HaLT) files](https://figshare.com/collections/A_large_electroencephalographic_motor_imagery_dataset_for_electroencephalographic_brain_computer_interfaces/3917698) (NEMAR [nm000137](https://nemar.org/dataset/nm000137) holds a subset of it) | pretraining | EEG |
71
+ | `Won2022` | [Won et al. 2022, EEG dataset for RSVP and P300 speller BCIs (Sci. Data 9:388; 55 participants P300 speller, 50 RSVP; Figshare collection 5769449); not in MOABB](https://doi.org/10.6084/m9.figshare.c.5769449.v1) | pretraining | EEG |
72
+ | [`nm000129`](https://nemar.org/dataset/nm000129) | [BETA: large benchmark database toward SSVEP-BCI application, Liu et al. 2020 (70 subjects, 40 targets); MOABB Liu2020BETA](https://doi.org/10.3389/fnins.2020.00627) | pretraining | EEG |
73
+ | [`nm000339`](https://nemar.org/dataset/nm000339) | [Stieger et al. 2021, continuous sensorimotor-rhythm BCI learning in a large population (62 subjects, ~600 h, 62 ch; Figshare 13123148); MOABB Stieger2021](https://doi.org/10.6084/m9.figshare.13123148.v1) | pretraining | EEG |
74
+ | `SparrKULee` | [SparrKULee: speech-evoked auditory response repository of KU Leuven (Bollens et al. 2023; 85 participants, 64 ch BioSemi); called 'KUL Auditory Decoding Dataset' in the paper](https://doi.org/10.48804/K3VSND) (NEMAR [nm000238](https://nemar.org/dataset/nm000238) holds a subset of it) | pretraining | EEG |
75
+ | `SEED-V` | [SEED-V emotion EEG dataset (Liu et al. 2022; 16 subjects x 3 sessions, 62 ch, five emotions)](https://bcmi.sjtu.edu.cn/home/seed/seed-v.html) | pretraining | EEG |
76
+ | `private:KU-Leuven-in-house-EEG` | In-house EEG recorded in the authors' lab (KU Leuven Laboratory for Neuro- & Psychophysiology), multiple paradigms (e.g. MI and SSVEP) and diverse montages; not released, not itemised | pretraining | EEG |
77
+
78
+ | `Stanford-FingerFlex` | [Stanford ECoG Library finger-flexion recordings](https://exhibits.stanford.edu/data/catalog/zk881ps0522) (9 patients; NEMAR [nm000352](https://nemar.org/dataset/nm000352) is a broader multi-task copy) | fine-tuning | ECoG |
79
+
80
+ - MAE self-supervised pre-training, 300 epochs (release note). MAE pre-training corpus of App. E.2 (pp. 25-26), '11 public datasets' + an in-house set, as the paper lists them: 1) EEG-MI-BCI (Cho et al., 2017) -> Cho2017; 2) HGD (Schirrmeister et al., 2017) -> Schirrmeister2017; 3) BCI-Comp-IV2a (Tangermann et al., 2012) -> BNCI2014_001 (official training session only; the official test session was the validation split, E.4 p.26); 4) BCI-Comp-IV2b (Tangermann et al., 2012) -> BNCI2014_004; 5) Large-MI-Classic and 6) Large-MI-5F (both Kaya et al., 2018) -> Kaya2018 (one dataset, two paradigm subsets); 7) P300 (Won et al., 2022: P300 speller + RSVP) -> Won2022; 8) SSVEP (Liu et al., 2020 = BETA) -> Liu2020BETA; 9) Online MI BCI Classification (Stieger et al., 2021) -> Stieger2021; 10) KUL Auditory Decoding Dataset (Bollens et al., 2023 = SparrKULee) -> SparrKULee; 11) SEED-V (Liu et al., 2022) -> SEED-V; plus in-house EEG recorded in the authors' lab (multiple paradigms, e.g. MI and SSVEP) -> private:KU-Leuven-in-house-EEG. Preprocessing: notch, 0.1-64 Hz band-pass, 128 Hz, per-channel z-score (E.3). Windows: 6 s / 0.5 s hop for continuous sets, 6 s / 2.5 s hop for the three large MI sets, 2 s / 0.125 s hop for SSVEP (E.4). Validation: BCI-Comp-IV2a official test set; 20% held out for every other set; >8M overlapping segments overall.
81
+ - Sources: Yang et al., ICLR 2026, https://openreview.net/forum?id=5Xwm8e6vbh; PDF via Wayback snapshot http://web.archive.org/web/20260609032700/https://openreview.net/pdf?id=5Xwm8e6vbh App. E.2, p.25; https://github.com/LiuyinYang1101/STEEGFormer/releases/tag/ST-EEGFormer-small (release body).
82
+
83
+ ### CORTEG fine-tuning stage
84
+
85
+ The inheritance chain is `corteg-stanford-pooled` → `corteg-small-pretrained` → `STEEGFormer-small`. In addition to the inherited MAE corpus, the released adapter was trained on the training split of all nine Stanford finger-flexion patients (first 400 s per recording; two thirds for recordings shorter than 600 s). The readout remained at its random initialization, as documented in the authors’ release manifest; the adapter learned around it. Source: [CORTEG release code and manifest](https://github.com/LiuyinYang1101/CORTEG/tree/caafb78fbebdd9448814f96d7e61083a3eb62663), `checkpoints/corteg_stanford_pooled.json`.
86
+
87
+
88
  ## Usage
89
 
90
  The model reads two streams of the same 1 s window, as the paper's Stanford
 
139
 
140
  The adapter and the ST-EEGFormer backbone are both released by Liuyin Yang
141
  under the MIT licence (`LICENSE`). Braindecode's code is BSD-3-Clause.
142
+
143
+
144
+ ## Cite Braindecode
145
+
146
+ If you use this braindecode port in scientific work, cite the software on Zenodo,
147
+ [doi:10.5281/zenodo.17699192](https://doi.org/10.5281/zenodo.17699192),
148
+ and the original model and datasets cited above.
149
+
150
+ ```bibtex
151
+ @software{braindecode,
152
+ author = {Aristimunha, Bruno and
153
+ Guetschel, Pierre and
154
+ Wimpff, Martin and
155
+ Gemein, Lukas and
156
+ Rommel, Cedric and
157
+ Banville, Hubert and
158
+ Sliwowski, Maciej and
159
+ Wilson, Daniel and
160
+ Brandt, Simon and
161
+ Gnassounou, Théo and
162
+ Paillard, Joseph and
163
+ {Junqueira Lopes}, Bruna and
164
+ Sedlar, Sara and
165
+ Moreau, Thomas and
166
+ Chevallier, Sylvain and
167
+ Gramfort, Alexandre and
168
+ Schirrmeister, Robin Tibor},
169
+ title = {Braindecode: toolbox for decoding raw electrophysiological brain data
170
+ with deep learning models},
171
+ url = {https://github.com/braindecode/braindecode},
172
+ doi = {10.5281/zenodo.17699192},
173
+ publisher = {Zenodo},
174
+ license = {BSD-3-Clause},
175
+ }
176
+ ```