bruAristimunha commited on
Commit
6d736b4
·
verified ·
1 Parent(s): 5a19a36

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
  - bbl
10
  - self-supervised
11
  - foundation-model
 
 
12
  ---
13
 
14
  # BBL (pretrained, CamCAN)
@@ -31,6 +33,24 @@ The linear head (`final_layer`, `n_outputs=2` in `config.json`) is not part of t
31
  release: it is PyTorch's default init under `torch.manual_seed(0)`. Passing `n_outputs` to
32
  `from_pretrained` replaces it. Fine-tune or linear-probe before use.
33
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
34
  ## Intended input
35
 
36
  - MEG, `(batch, n_chans, 125)`: CamCAN's 306 Elekta `MEG*` channels in FIF order (the
 
9
  - bbl
10
  - self-supervised
11
  - foundation-model
12
+ datasets:
13
+ - CamCAN
14
  ---
15
 
16
  # BBL (pretrained, CamCAN)
 
33
  release: it is PyTorch's default init under `torch.manual_seed(0)`. Passing `n_outputs` to
34
  `from_pretrained` replaces it. Fine-tune or linear-probe before use.
35
 
36
+ <!-- braindecode:training-data -->
37
+ ## Training data
38
+
39
+ The data that shaped these weights. The ids are the `datasets:` field of this card,
40
+ which braindecode reads into `model.card_data.datasets` when you call
41
+ `from_pretrained` (MOABB class names for MOABB datasets, OpenNeuro / NEMAR
42
+ accessions, Hub ids otherwise). `nm`/`on` ids are datasets on [NEMAR](https://nemar.org)
43
+ (`on` = NEMAR's copy of the OpenNeuro dataset with the same number). Rows marked
44
+ `private:` are data the authors did not release; they are not in `datasets:`.
45
+
46
+ | `datasets:` id | Dataset | Stage | Modality |
47
+ |---|---|---|---|
48
+ | `CamCAN` | [Cambridge Centre for Ageing and Neuroscience (Cam-CAN) MEG data, Shafto et al. 2014 / Taylor et al. 2017](https://cam-can.mrc-cbu.cam.ac.uk/dataset/) | pretraining | MEG |
49
+
50
+ - self-supervised band/phase/amplitude pretext tasks; 583 Cam-CAN subject rows trained (train split; rows with non-zero Adam state)
51
+ - Sources: https://github.com/neural-processing-lab/the-brains-bitter-lesson/blob/3965a2be11677d9c2b9cecb88109a0af6bf19d1c/README.md; checkpoint hyper_parameters (inspected 2026-11-06, meg-ports-20261106/bbl/weights/CHECKPOINT.md and evidence/parity.log); arXiv:2406.04328 Sec. 4 Datasets.
52
+
53
+
54
  ## Intended input
55
 
56
  - MEG, `(batch, n_chans, 125)`: CamCAN's 306 Elekta `MEG*` channels in FIF order (the