bruAristimunha commited on
Commit
72c10fa
·
verified ·
1 Parent(s): acecf04

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 +25 -0
README.md CHANGED
@@ -7,6 +7,10 @@ tags:
7
  - sleep
8
  - foundation-model
9
  - braindecode
 
 
 
 
10
  ---
11
 
12
  # SleepFM — pretrained encoder
@@ -40,6 +44,27 @@ time. Loading either way gives bit-identical outputs.
40
  Note that the released encoder is contrastive and carries **no classification head**:
41
  `final_layer` is randomly initialised and must be fine-tuned.
42
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
43
  ## Usage
44
 
45
  ```python
 
7
  - sleep
8
  - foundation-model
9
  - braindecode
10
+ datasets:
11
+ - SSC
12
+ - MESA
13
+ - MrOS
14
  ---
15
 
16
  # SleepFM — pretrained encoder
 
44
  Note that the released encoder is contrastive and carries **no classification head**:
45
  `final_layer` is randomly initialised and must be fine-tuned.
46
 
47
+ <!-- braindecode:training-data -->
48
+ ## Training data
49
+
50
+ The data that shaped these weights. The ids are the `datasets:` field of this card,
51
+ which braindecode reads into `model.card_data.datasets` when you call
52
+ `from_pretrained` (MOABB class names for MOABB datasets, OpenNeuro / NEMAR
53
+ accessions, Hub ids otherwise). `nm`/`on` ids are datasets on [NEMAR](https://nemar.org)
54
+ (`on` = NEMAR's copy of the OpenNeuro dataset with the same number). Rows marked
55
+ `private:` are data the authors did not release; they are not in `datasets:`.
56
+
57
+ | `datasets:` id | Dataset | Stage | Modality |
58
+ |---|---|---|---|
59
+ | `SSC` | [Stanford Sleep Clinic PSG cohort (Stanford Sleep Dataset)](https://sleepdata.org/datasets/ssc) | pretraining | PSG |
60
+ | `private:BioSerenity` | [BioSerenity / SleepMed proprietary PSG collection (18,869 overnight recordings)](https://doi.org/10.1038/s41591-025-04133-4) | pretraining | PSG |
61
+ | `MESA` | [Multi-Ethnic Study of Atherosclerosis (sleep ancillary, NSRR)](https://sleepdata.org/datasets/mesa) | pretraining | PSG |
62
+ | `MrOS` | [Outcomes of Sleep Disorders in Older Men (MrOS Sleep, NSRR)](https://sleepdata.org/datasets/mros) | pretraining | PSG |
63
+
64
+ - Leave-one-out multimodal contrastive pretraining on the 'pretrain' split of the four cohorts (>585,000 h, ~65,000 participants); SHHS explicitly held out. Upstream model_base/config.json: mode=leave_one_out, epochs=1.
65
+ - Sources: Thapa et al., Nature Medicine 2026, doi:10.1038/s41591-025-04133-4, Results 'Dataset and SleepFM architecture'; https://github.com/zou-group/sleepfm-clinical README (main); braindecode SleepFM docstring (W/bd/braindecode/models/sleepfm.py).
66
+
67
+
68
  ## Usage
69
 
70
  ```python