xbb083 commited on
Commit
4137c98
·
verified ·
1 Parent(s): 8ee519c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +43 -12
README.md CHANGED
@@ -38,8 +38,8 @@ No original EEG or PSG recordings are distributed in this repository. Users must
38
  |---|---|---:|---:|---|
39
  | Foundational Analysis | `foundational_analysis` | 40 | 950 | Released |
40
  | Sleep Assessment | `sleep_assessment` | 43 | 1,025 | Released |
41
- | Neurocognitive Assessment | `neurocognitive_assessment` | - | - | In progress |
42
- | Physiological Integration | `physiological_integration` | - | - | In progress |
43
 
44
  The current release contains 1,975 fixed evaluation instances across the first two subsets.
45
 
@@ -49,16 +49,28 @@ The current release contains 1,975 fixed evaluation instances across the first t
49
  <root>/
50
  ├── foundational_analysis/
51
  │ └── cases/
52
- │ ├── case01/
53
- │ │ ├── case01_01.json
54
  │ │ └── ...
55
  │ └── ...
56
  └── sleep_assessment/
57
- └── cases/
58
- ├── case01/
59
- │ ├── case01_01.json
60
- │ └── ...
61
- └── ...
 
 
 
 
 
 
 
 
 
 
 
 
62
  ```
63
 
64
  Conventions:
@@ -127,11 +139,30 @@ hf download xbb083/BrainBench \
127
  --local-dir ./benchmarks
128
  ```
129
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
130
  When `--local-dir ./benchmarks` is used from the BrainBench code repository, cases are placed directly at:
131
 
132
  ```text
133
  benchmarks/foundational_analysis/cases/
134
  benchmarks/sleep_assessment/cases/
 
 
135
  ```
136
 
137
  ## Use with BrainBench
@@ -144,7 +175,7 @@ The complete workflow is:
144
  4. Run the subset prepare command to create local benchmark inputs.
145
  5. Run the subset with the built-in CodeAct paradigm or a custom Agent adapter.
146
 
147
- Example commands after the code repository is released:
148
 
149
  ```bash
150
  # Prepare all Foundational Analysis inputs from locally downloaded source data.
@@ -175,7 +206,7 @@ import json
175
  from pathlib import Path
176
 
177
  case_path = Path(
178
- "benchmarks/foundational_analysis/cases/case01/case01_01.json"
179
  )
180
  case = json.loads(case_path.read_text(encoding="utf-8"))
181
 
@@ -189,7 +220,7 @@ List available tasks and count instances:
189
  ```python
190
  from pathlib import Path
191
 
192
- for subset in ("foundational_analysis", "sleep_assessment"):
193
  case_root = Path("benchmarks") / subset / "cases"
194
  tasks = sorted(path.name for path in case_root.iterdir() if path.is_dir())
195
  instances = list(case_root.rglob("*.json"))
 
38
  |---|---|---:|---:|---|
39
  | Foundational Analysis | `foundational_analysis` | 40 | 950 | Released |
40
  | Sleep Assessment | `sleep_assessment` | 43 | 1,025 | Released |
41
+ | Neurocognitive Assessment | `neurocognitive_assessment` | 50 | 1035 | Released |
42
+ | Physiological Integration | `physiological_integration` | 39 | 1095 | Released |
43
 
44
  The current release contains 1,975 fixed evaluation instances across the first two subsets.
45
 
 
49
  <root>/
50
  ├── foundational_analysis/
51
  │ └── cases/
52
+ │ ├── case1/
53
+ │ │ ├── case1_01.json
54
  │ │ └── ...
55
  │ └── ...
56
  └── sleep_assessment/
57
+ └── cases/
58
+ ├── case1/
59
+ ├── case1_01.json
60
+ └── ...
61
+ └── ...
62
+ └── neurocognitive_assessment/
63
+ │ └── cases/
64
+ │ ├── case1/
65
+ │ │ ├── case1_01.json
66
+ │ │ └── ...
67
+ │ └── ...
68
+ └── physiological_integration/
69
+ │ └── cases/
70
+ │ ├── case1/
71
+ │ │ ├── case1_01.json
72
+ │ │ └── ...
73
+ │ └── ...
74
  ```
75
 
76
  Conventions:
 
139
  --local-dir ./benchmarks
140
  ```
141
 
142
+ Download only Neurocognitive Assessment:
143
+
144
+ ```bash
145
+ hf download xbb083/BrainBench \
146
+ --repo-type dataset \
147
+ --include "neurocognitive_assessment/**" \
148
+ --local-dir ./benchmarks
149
+ ```
150
+
151
+ Download only Physiological Integration:
152
+
153
+ ```bash
154
+ hf download xbb083/BrainBench \
155
+ --repo-type dataset \
156
+ --include "physiological_integration/**" \
157
+ --local-dir ./benchmarks
158
+ ```
159
  When `--local-dir ./benchmarks` is used from the BrainBench code repository, cases are placed directly at:
160
 
161
  ```text
162
  benchmarks/foundational_analysis/cases/
163
  benchmarks/sleep_assessment/cases/
164
+ benchmarks/neurocognitive_assessment/cases/
165
+ benchmarks/physiological_integration/cases/
166
  ```
167
 
168
  ## Use with BrainBench
 
175
  4. Run the subset prepare command to create local benchmark inputs.
176
  5. Run the subset with the built-in CodeAct paradigm or a custom Agent adapter.
177
 
178
+ Example commands:
179
 
180
  ```bash
181
  # Prepare all Foundational Analysis inputs from locally downloaded source data.
 
206
  from pathlib import Path
207
 
208
  case_path = Path(
209
+ "benchmarks/foundational_analysis/cases/case1/case1_01.json"
210
  )
211
  case = json.loads(case_path.read_text(encoding="utf-8"))
212
 
 
220
  ```python
221
  from pathlib import Path
222
 
223
+ for subset in ("foundational_analysis", "sleep_assessment", "neurocognitive_assessment", "physiological_integration"):
224
  case_root = Path("benchmarks") / subset / "cases"
225
  tasks = sorted(path.name for path in case_root.iterdir() if path.is_dir())
226
  instances = list(case_root.rglob("*.json"))