bruAristimunha commited on
Commit
b4651fd
·
verified ·
1 Parent(s): 5c01842

Delete README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +0 -102
README.md DELETED
@@ -1,102 +0,0 @@
1
- ---
2
- tags:
3
- - braindecode
4
- - eeg
5
- - neuroscience
6
- - brain-computer-interface
7
- - deep-learning
8
- license: unknown
9
- ---
10
-
11
- # EEG Dataset
12
-
13
- This dataset was created using [braindecode](https://braindecode.org), a deep
14
- learning library for EEG/MEG/ECoG signals.
15
-
16
- ## Dataset Information
17
-
18
- | Property | Value |
19
- |----------|------:|
20
- | Recordings | 1 |
21
- | Type | Windowed (from Raw object) |
22
- | Channels | 26 |
23
- | Sampling frequency | 250 Hz |
24
- | Total duration | 0:06:26 |
25
- | Windows/samples | 48 |
26
- | Size | 19.22 MB |
27
- | Format | zarr |
28
-
29
- ## Quick Start
30
-
31
- ```python
32
- from braindecode.datasets import BaseConcatDataset
33
-
34
- # Load from Hugging Face Hub
35
- dataset = BaseConcatDataset.pull_from_hub("username/dataset-name")
36
-
37
- # Access a sample
38
- X, y, metainfo = dataset[0]
39
- # X: EEG data [n_channels, n_times]
40
- # y: target label
41
- # metainfo: window indices
42
- ```
43
-
44
- ## Training with PyTorch
45
-
46
- ```python
47
- from torch.utils.data import DataLoader
48
-
49
- loader = DataLoader(dataset, batch_size=32, shuffle=True, num_workers=4)
50
-
51
- for X, y, metainfo in loader:
52
- # X: [batch_size, n_channels, n_times]
53
- # y: [batch_size]
54
- pass # Your training code
55
- ```
56
-
57
- ## BIDS-inspired Structure
58
-
59
- This dataset uses a **BIDS-inspired** organization. Metadata files follow BIDS
60
- conventions, while data is stored in Zarr format for efficient deep learning.
61
-
62
- **BIDS-style metadata:**
63
- - `dataset_description.json` - Dataset information
64
- - `participants.tsv` - Subject metadata
65
- - `*_events.tsv` - Trial/window events
66
- - `*_channels.tsv` - Channel information
67
- - `*_eeg.json` - Recording parameters
68
-
69
- **Data storage:**
70
- - `dataset.zarr/` - Zarr format (optimized for random access)
71
-
72
- ```
73
- sourcedata/braindecode/
74
- ├── dataset_description.json
75
- ├── participants.tsv
76
- ├── dataset.zarr/
77
- └── sub-<label>/
78
- └── eeg/
79
- ├── *_events.tsv
80
- ├── *_channels.tsv
81
- └── *_eeg.json
82
- ```
83
-
84
- ### Accessing Metadata
85
-
86
- ```python
87
- # Participants info
88
- if hasattr(dataset, "participants"):
89
- print(dataset.participants)
90
-
91
- # Events for a recording
92
- if hasattr(dataset.datasets[0], "bids_events"):
93
- print(dataset.datasets[0].bids_events)
94
-
95
- # Channel info
96
- if hasattr(dataset.datasets[0], "bids_channels"):
97
- print(dataset.datasets[0].bids_channels)
98
- ```
99
-
100
- ---
101
-
102
- *Created with [braindecode](https://braindecode.org)*