bruAristimunha commited on
Commit
9809c02
·
1 Parent(s): cbc3460

Redesign org card — inline SVG hero + catalog-shape chart + population×paradigm table

Browse files
Files changed (1) hide show
  1. org-readme/README.md +95 -42
org-readme/README.md CHANGED
@@ -1,4 +1,20 @@
1
- ![EEGDash the open catalog of EEG/MEG datasets](https://raw.githubusercontent.com/eegdash/EEGDash/main/docs/source/_static/eegdash_long.svg)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
 
3
  *The open catalog of EEG / MEG datasets — indexed, described, and loadable with one line of Python.*
4
 
@@ -6,27 +22,83 @@
6
  [![Python](https://img.shields.io/pypi/pyversions/eegdash?style=flat-square&color=0072B2)](https://pypi.org/project/eegdash/)
7
  [![License](https://img.shields.io/badge/license-BSD--3--Clause-009E73?style=flat-square)](https://github.com/eegdash/EEGDash/blob/main/LICENSE)
8
  [![Downloads](https://static.pepy.tech/badge/eegdash)](https://pepy.tech/project/eegdash)
9
- [![Stars](https://img.shields.io/github/stars/eegdash/EEGDash?style=flat-square&logo=github&color=E69F00)](https://github.com/eegdash/EEGDash)
10
 
11
- Welcome to the official Hugging Face org for **[EEGDash](https://eegdash.org)** an open archive of publicly shared EEG and MEG studies, built to remove the friction between the river of publicly funded neuroscience data and modern ML pipelines. Raw recordings never get rehosted here; every dataset on this page is a **pointer** to its canonical source (OpenNeuro, NEMAR, or the lab that collected it), and `EEGDashDataset` handles the download, caching, and conversion on demand.
12
 
13
  **[🗺️ Browse the interactive catalog](https://huggingface.co/spaces/EEGDash/catalog)** · [📚 Docs](https://eegdash.org) · [💻 GitHub](https://github.com/eegdash/EEGDash) · [📦 PyPI](https://pypi.org/project/eegdash/)
14
 
15
- ## The archive in one glance
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
- - **736** EEG / MEG datasets indexed, of which **600+** already mirrored on 🤗 and growing daily
18
- - **40,361** subjects · **222,750** recordings · **85,298 hours** of signal
19
- - **571 EEG** · **73 iEEG** · **55 MEG** · **22 fNIRS** · a handful of multimodal combos
20
- - Every dataset reachable by a stable slug (`ds002718`) *and* by canonical alias (`Wakeman2015`)
21
- - Sourced from **[OpenNeuro](https://openneuro.org)** (546) and **[NEMAR](https://nemar.org)** (190)
22
-
23
- ### Clinical populations covered
24
-
25
- Healthy controls (349) · Epilepsy (37) · Development — HBN releases (36+) · post-Surgery (17) · Dementia · Parkinson's · Schizophrenia · Depression · Dyslexia · ADHD · and more.
26
-
27
- ### Experimental paradigms
28
 
29
- Visual (300) · Auditory (59) · Multisensory (35) · Resting State (22) · Motor (17) · Tactile (16) · Sleep (13) · Anesthesia (4).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
 
31
  ## Get started in 30 seconds
32
 
@@ -39,9 +111,8 @@ from eegdash import EEGDashDataset
39
 
40
  # Load any dataset in the catalog by its ID…
41
  ds = EEGDashDataset(dataset="ds002718", cache_dir="./cache")
42
- print(len(ds), "recordings")
43
 
44
- # …or by canonical alias — every known name is registered as a class:
45
  from eegdash.dataset import Wakeman2015
46
  ds = Wakeman2015(cache_dir="./cache")
47
 
@@ -54,36 +125,18 @@ from torch.utils.data import DataLoader
54
  loader = DataLoader(ds, batch_size=32, shuffle=True)
55
  ```
56
 
57
- ## Featured datasets
58
-
59
- A handful of representative entries — the full catalog is at the [Space](https://huggingface.co/spaces/EEGDash/catalog).
60
-
61
- - **[`ds002718`](https://huggingface.co/datasets/EEGDash/ds002718)** — *Face processing EEG dataset for EEGLAB* (Wakeman & Henson, 2020). 18 healthy subjects, 250 Hz, CC0. Canonical alias: `Wakeman2015`.
62
- - **[`ds000117`](https://huggingface.co/datasets/EEGDash/ds000117)** — Multi-subject multimodal **MEG + EEG** face processing, source-localization-ready.
63
- - **[`EEG2025r1`](https://huggingface.co/datasets/EEGDash/eeg2025r1)** — **Healthy Brain Network** release 1 — 136 participants, 10 paradigms, 20 GB. The canonical developmental-EEG benchmark.
64
- - **[`ds003800`](https://huggingface.co/datasets/EEGDash/ds003800)** — EEG in **Parkinson's disease**.
65
- - **[`ds002799`](https://huggingface.co/datasets/EEGDash/ds002799)** — Patient-day recording in **dementia**.
66
- - **[`ds004551`](https://huggingface.co/datasets/EEGDash/ds004551)** — **iEEG** / intracranial recordings from neurosurgical patients.
67
-
68
- ## Spaces & tools
69
-
70
- - **[EEGDash Catalog](https://huggingface.co/spaces/EEGDash/catalog)** — interactive search with modality × population × source × license filters, plus live treemap / sankey / growth views of the whole archive.
71
-
72
  ## Backed by
73
 
74
- EEGDash is a **U.S.–Israel collaboration** funded by the **U.S. National Science Foundation** as part of the EEG-DaSh initiative:
75
 
76
- - **Swartz Center for Computational Neuroscience (SCCN)**, University of California, San Diego
77
- - **Ben-Gurion University of the Negev**, Beer-Sheva, Israel
78
 
79
- Built on and contributing back to the open-neuroscience ecosystem: [MNE-Python](https://mne.tools), [braindecode](https://braindecode.org), [EEGLAB](https://eeglab.org), [BIDS](https://bids.neuroimaging.io), [OpenNeuro](https://openneuro.org), [NEMAR](https://nemar.org).
80
 
81
  ## Contribute
82
 
83
- The entire catalog regenerates from **one CSV** (`eegdash/dataset/dataset_summary.csv`) plus the public EEGDash API. Missing a dataset? Wrong metadata? The fix surfaces everywhere at once.
84
-
85
- - Request a new dataset or report bad metadata → [open an issue](https://github.com/eegdash/EEGDash/issues).
86
- - Bigger contributions → [CONTRIBUTING.md](https://github.com/eegdash/EEGDash/blob/main/CONTRIBUTING.md).
87
 
88
  ## Cite
89
 
@@ -97,7 +150,7 @@ The entire catalog regenerates from **one CSV** (`eegdash/dataset/dataset_summar
97
  }
98
  ```
99
 
100
- When you use a specific dataset, **follow its upstream citation policy** — the link is in every dataset's HF card under *How to cite*.
101
 
102
  ---
103
 
 
1
+ <svg viewBox="0 0 900 150" xmlns="http://www.w3.org/2000/svg" width="900" height="150" role="img" aria-label="EEGDash catalog banner: 736 datasets, 40k subjects, 85k hours">
2
+ <!-- background -->
3
+ <rect x="0" y="0" width="900" height="150" fill="#F8FAFC"/>
4
+ <rect x="0" y="0" width="900" height="150" fill="#0072B2" fill-opacity="0.035"/>
5
+ <!-- wordmark left -->
6
+ <text x="28" y="48" font-family="Inter, system-ui, sans-serif" font-size="28" font-weight="700" fill="#0F172A">EEGDash</text>
7
+ <text x="28" y="74" font-family="Inter, system-ui, sans-serif" font-size="13" font-weight="400" fill="#64748B">open catalog of EEG / MEG datasets · load with one line of Python</text>
8
+ <!-- headline number center -->
9
+ <text x="28" y="118" font-family="Inter, system-ui, sans-serif" font-size="14" fill="#334155"><tspan font-weight="700" fill="#0F172A" font-size="22">736</tspan> datasets · <tspan font-weight="700" fill="#0F172A" font-size="22">40,361</tspan> subjects · <tspan font-weight="700" fill="#0F172A" font-size="22">85,298</tspan> hours</text>
10
+ <!-- waveform decoration right — 4 stacked traces suggesting EEG -->
11
+ <g stroke-width="1.6" fill="none" opacity="0.9">
12
+ <path stroke="#0072B2" d="M560 38 L580 42 L595 30 L612 48 L628 26 L644 40 L662 34 L680 46 L700 30 L720 42 L738 34 L756 44 L776 30 L796 44 L816 34 L836 42 L856 30 L876 40"/>
13
+ <path stroke="#009E73" d="M560 62 L582 66 L600 58 L618 72 L636 54 L654 66 L672 60 L692 72 L712 58 L732 68 L750 60 L770 70 L788 58 L810 68 L828 60 L848 66 L868 54 L888 64"/>
14
+ <path stroke="#E69F00" d="M560 86 L580 92 L598 82 L616 96 L634 80 L652 92 L670 86 L688 96 L708 82 L726 92 L744 86 L764 94 L782 84 L802 96 L820 86 L840 94 L860 82 L880 92"/>
15
+ <path stroke="#D55E00" d="M560 110 L582 114 L600 106 L620 118 L638 100 L656 112 L674 108 L694 116 L714 102 L734 112 L752 106 L772 116 L790 104 L812 114 L830 106 L850 112 L870 100 L890 110"/>
16
+ </g>
17
+ </svg>
18
 
19
  *The open catalog of EEG / MEG datasets — indexed, described, and loadable with one line of Python.*
20
 
 
22
  [![Python](https://img.shields.io/pypi/pyversions/eegdash?style=flat-square&color=0072B2)](https://pypi.org/project/eegdash/)
23
  [![License](https://img.shields.io/badge/license-BSD--3--Clause-009E73?style=flat-square)](https://github.com/eegdash/EEGDash/blob/main/LICENSE)
24
  [![Downloads](https://static.pepy.tech/badge/eegdash)](https://pepy.tech/project/eegdash)
25
+ [![GitHub](https://img.shields.io/github/stars/eegdash/EEGDash?style=flat-square&logo=github&color=E69F00)](https://github.com/eegdash/EEGDash)
26
 
27
+ Welcome to the official Hugging Face org for **[EEGDash](https://eegdash.org)**. Raw EEG/MEG recordings are never rehosted here each dataset on this page is a **pointer** to its canonical source (OpenNeuro, NEMAR, or the lab that collected it), and `EEGDashDataset` handles download, caching, and conversion to a PyTorch-ready [braindecode](https://braindecode.org) object. One CSV drives the whole catalog; every card you see here regenerates from it automatically.
28
 
29
  **[🗺️ Browse the interactive catalog](https://huggingface.co/spaces/EEGDash/catalog)** · [📚 Docs](https://eegdash.org) · [💻 GitHub](https://github.com/eegdash/EEGDash) · [📦 PyPI](https://pypi.org/project/eegdash/)
30
 
31
+ ## Catalog shape
32
+
33
+ <svg viewBox="0 0 900 60" xmlns="http://www.w3.org/2000/svg" width="900" height="60" role="img" aria-label="Datasets by experimental paradigm">
34
+ <!-- axis label -->
35
+ <text x="0" y="12" font-family="Inter, system-ui, sans-serif" font-size="11" font-weight="600" fill="#64748B" letter-spacing="1.2">EXPERIMENTAL PARADIGM</text>
36
+ <!-- stacked bar — widths proportional to counts out of 529 classified -->
37
+ <g>
38
+ <rect x="0" y="22" width="510" height="18" fill="#0072B2"/>
39
+ <rect x="510" y="22" width="100" height="18" fill="#009E73"/>
40
+ <rect x="610" y="22" width="60" height="18" fill="#E69F00"/>
41
+ <rect x="670" y="22" width="38" height="18" fill="#D55E00"/>
42
+ <rect x="708" y="22" width="30" height="18" fill="#CC79A7"/>
43
+ <rect x="738" y="22" width="28" height="18" fill="#56B4E9"/>
44
+ <rect x="766" y="22" width="23" height="18" fill="#F0E442"/>
45
+ <rect x="789" y="22" width="44" height="18" fill="#999999"/>
46
+ <rect x="833" y="22" width="67" height="18" fill="#E2E8F0"/>
47
+ </g>
48
+ <!-- inline legend row -->
49
+ <g font-family="Inter, system-ui, sans-serif" font-size="11" fill="#334155">
50
+ <text x="0" y="56">■ Visual 300</text>
51
+ <text x="110" y="56" fill="#334155">■ Auditory 59</text>
52
+ <text x="205" y="56">■ Multi. 35</text>
53
+ <text x="280" y="56">■ Other 26</text>
54
+ <text x="345" y="56">■ Rest. 22</text>
55
+ <text x="408" y="56">■ Motor 17</text>
56
+ <text x="468" y="56">■ Tactile 16</text>
57
+ <text x="535" y="56">■ Sleep 13</text>
58
+ <text x="595" y="56">■ Anesth. 4</text>
59
+ <text x="670" y="56" fill="#94A3B8">+ 207 unclassified</text>
60
+ </g>
61
+ </svg>
62
+
63
+ **In numbers:** the archive indexes **736** EEG / MEG datasets totalling **40,361** subjects, **222,750** recordings, and **85,298 hours** of signal. **600+** are already mirrored on 🤗 and growing daily, sourced from **[OpenNeuro](https://openneuro.org)** (546) and **[NEMAR](https://nemar.org)** (190). By recording type: **571 EEG · 73 iEEG · 55 MEG · 22 fNIRS**, plus a handful of multimodal combos.
64
 
65
+ ## Featured datasets
 
 
 
 
 
 
 
 
 
 
66
 
67
+ A handful of representative entries, grouped by population. Every slug links to its HF card; every card links back to the canonical source.
68
+
69
+ <table>
70
+ <thead>
71
+ <tr>
72
+ <th>🟢 Healthy / neurotypical</th>
73
+ <th>🟠 Clinical populations</th>
74
+ <th>🟡 Developmental (HBN)</th>
75
+ </tr>
76
+ </thead>
77
+ <tbody>
78
+ <tr>
79
+ <td><strong>ds002718</strong> · Visual, 18 subj<br>Face processing (Wakeman & Henson)<br><a href="https://huggingface.co/datasets/EEGDash/ds002718">HF</a> · <code>Wakeman2015</code></td>
80
+ <td><strong>ds003800</strong> · Resting, PD<br>EEG in Parkinson's disease<br><a href="https://huggingface.co/datasets/EEGDash/ds003800">HF</a></td>
81
+ <td><strong>EEG2025r1</strong> · 10 paradigms, 136 subj<br>Healthy Brain Network release 1<br><a href="https://huggingface.co/datasets/EEGDash/eeg2025r1">HF</a> · <code>HBN_r1_bdf</code></td>
82
+ </tr>
83
+ <tr>
84
+ <td><strong>ds000117</strong> · Visual, MEG + EEG<br>Multimodal face processing<br><a href="https://huggingface.co/datasets/EEGDash/ds000117">HF</a> · <code>WakemanHenson_MEEG</code></td>
85
+ <td><strong>ds002799</strong> · Clinical monitoring<br>Patient-day recording, dementia<br><a href="https://huggingface.co/datasets/EEGDash/ds002799">HF</a></td>
86
+ <td><strong>EEG2025r10</strong> · 8 paradigms, 533 subj<br>HBN release 10 — 32 GB<br><a href="https://huggingface.co/datasets/EEGDash/eeg2025r10">HF</a></td>
87
+ </tr>
88
+ <tr>
89
+ <td><strong>ds000246</strong> · Auditory, MEG<br>CTF 275-channel MEG<br><a href="https://huggingface.co/datasets/EEGDash/ds000246">HF</a></td>
90
+ <td><strong>ds004551</strong> · iEEG<br>Intracranial recordings, surgical<br><a href="https://huggingface.co/datasets/EEGDash/ds004551">HF</a></td>
91
+ <td><strong>EEG2025r10mini</strong> · 20 subj<br>HBN mini release for tutorials<br><a href="https://huggingface.co/datasets/EEGDash/eeg2025r10mini">HF</a></td>
92
+ </tr>
93
+ <tr>
94
+ <td><strong>ds003061</strong> · Auditory<br>Speech / naturalistic listening<br><a href="https://huggingface.co/datasets/EEGDash/ds003061">HF</a></td>
95
+ <td><strong>ds004598</strong> · Motor<br>Motor paradigm study<br><a href="https://huggingface.co/datasets/EEGDash/ds004598">HF</a></td>
96
+ <td>… 22 HBN releases total<br><a href="https://huggingface.co/EEGDash?search_datasets=eeg2025">browse all HBN</a></td>
97
+ </tr>
98
+ </tbody>
99
+ </table>
100
+
101
+ **[Browse all 600 mirrored datasets →](https://huggingface.co/EEGDash)**
102
 
103
  ## Get started in 30 seconds
104
 
 
111
 
112
  # Load any dataset in the catalog by its ID…
113
  ds = EEGDashDataset(dataset="ds002718", cache_dir="./cache")
 
114
 
115
+ # …or by canonical alias — every known name is a registered class:
116
  from eegdash.dataset import Wakeman2015
117
  ds = Wakeman2015(cache_dir="./cache")
118
 
 
125
  loader = DataLoader(ds, batch_size=32, shuffle=True)
126
  ```
127
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
128
  ## Backed by
129
 
130
+ A **U.S.–Israel collaboration** funded by the U.S. National Science Foundation:
131
 
132
+ - **[Swartz Center for Computational Neuroscience (SCCN)](https://sccn.ucsd.edu)** UC San Diego
133
+ - **[Ben-Gurion University of the Negev](https://in.bgu.ac.il)** Beer-Sheva, Israel
134
 
135
+ Built on and contributing back to [MNE-Python](https://mne.tools), [braindecode](https://braindecode.org), [EEGLAB](https://eeglab.org), [BIDS](https://bids.neuroimaging.io), [OpenNeuro](https://openneuro.org), and [NEMAR](https://nemar.org).
136
 
137
  ## Contribute
138
 
139
+ Missing a dataset? Wrong metadata? The whole catalog regenerates from one CSV — fix once, propagate everywhere. **[Open an issue](https://github.com/eegdash/EEGDash/issues)** or see **[CONTRIBUTING.md](https://github.com/eegdash/EEGDash/blob/main/CONTRIBUTING.md)**.
 
 
 
140
 
141
  ## Cite
142
 
 
150
  }
151
  ```
152
 
153
+ When you use a specific dataset, always follow its upstream citation policy — the link lives in every dataset's HF card under *How to cite*.
154
 
155
  ---
156