bruAristimunha commited on
Commit
b05db05
·
verified ·
1 Parent(s): d5abbde

Card: list the training data (datasets:, base_model:) and add a Training data section

Browse files

Follow-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.

Files changed (1) hide show
  1. README.md +20 -0
README.md CHANGED
@@ -9,6 +9,8 @@ tags:
9
  - foundation-model
10
  - model_hub_mixin
11
  - pytorch_model_hub_mixin
 
 
12
  ---
13
 
14
  # BrainBERT — Foundation Model for Intracranial Neural Signals
@@ -74,6 +76,24 @@ freely change `n_chans` and `n_outputs` (the classification head is task-specifi
74
  and randomly initialized — fine-tune it on your downstream task). `n_times` only
75
  needs to be long enough to yield at least one spectrogram frame.
76
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
77
  ## Usage
78
 
79
  ```python
 
9
  - foundation-model
10
  - model_hub_mixin
11
  - pytorch_model_hub_mixin
12
+ datasets:
13
+ - nm000253
14
  ---
15
 
16
  # BrainBERT — Foundation Model for Intracranial Neural Signals
 
76
  and randomly initialized — fine-tune it on your downstream task). `n_times` only
77
  needs to be long enough to yield at least one spectrogram frame.
78
 
79
+ <!-- braindecode:training-data -->
80
+ ## Training data
81
+
82
+ The data that shaped these weights. The ids are the `datasets:` field of this card,
83
+ which braindecode reads into `model.card_data.datasets` when you call
84
+ `from_pretrained` (MOABB class names for MOABB datasets, OpenNeuro / NEMAR
85
+ accessions, Hub ids otherwise). `nm`/`on` ids are datasets on [NEMAR](https://nemar.org)
86
+ (`on` = NEMAR's copy of the OpenNeuro dataset with the same number). Rows marked
87
+ `private:` are data the authors did not release; they are not in `datasets:`.
88
+
89
+ | `datasets:` id | Dataset | Stage | Modality |
90
+ |---|---|---|---|
91
+ | [`nm000253`](https://nemar.org/dataset/nm000253) | [Brain Treebank: large-scale intracranial recordings from naturalistic language stimuli (Wang et al., NeurIPS 2024 D&B; 10 subjects, 26 movie sessions, ~43.5 h sEEG)](https://braintreebank.dev/) | pretraining | iEEG |
92
+
93
+ - self-supervised masked spectrogram modelling; 19 of 26 sessions (all 10 subjects); 7 sessions held out for decoding tasks
94
+ - Sources: arXiv:2302.14367 (ICLR 2023) p.4, Data; arXiv:2302.14367 p.4-5, Section 3; https://github.com/czlwang/BrainBERT README; arXiv:2411.08343 (Brain Treebank) p.1.
95
+
96
+
97
  ## Usage
98
 
99
  ```python