ApocalyVec commited on
Commit
ea4bc3b
·
verified ·
1 Parent(s): 0292c37

Add dataset card

Browse files
Files changed (1) hide show
  1. README.md +155 -0
README.md ADDED
@@ -0,0 +1,155 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # OLIVE Release FRP Dataset — Card
2
+
3
+ ## What this is
4
+
5
+ Per-fixation, fixation-related-potential (FRP) examples assembled from the OLIVE
6
+ Wingman / SpaceShooter user studies (US1 offline simulation, US2 live deployment,
7
+ US3 silent target-switch), for the release cohort of 27
8
+ participants (`release.common.cohort.RELEASE_SUBJECTS`). Assembled by
9
+ `release/dataset/export_hf.py::build_examples`, which composes the already-committed
10
+ Tasks 2.1-2.4 modules (epoch extraction, p_target regeneration, saccade derivation,
11
+ condition/block metadata) without reimplementing any of their logic.
12
+
13
+ ## Fields (one row per fixation-locked epoch)
14
+
15
+ | field | type | description |
16
+ |---|---|---|
17
+ | `subject_id` | int | participant id |
18
+ | `user_study` | str | `us1` / `us2` / `us3` |
19
+ | `session` | int | recording-session index within (subject, study); usually `0` |
20
+ | `eeg` | float32[20, 230] | fixation-locked EEG epoch, see montage/window below |
21
+ | `pupil` | float32[2, 80] | fixation-locked pupil-diameter epoch (left/right), see window below |
22
+ | `y` | int (0/1) | ground-truth fixated-item label (1 = target) |
23
+ | `p_target` | float in [0,1] or NaN | per-fixation implicit-evidence target probability (in [0,1]); NaN where per-subject EEG-evidence parameters are unavailable |
24
+ | `p_target_quality` | float in [0.4,1.0] or NaN | per-subject decoder quality (AUC), or NaN |
25
+ | `item_id` | int | fixated item id within its block |
26
+ | `run` | int | 1-indexed fixation-generating-block counter from the TFRecord (`block_idx = run - 1`, see caveat below) |
27
+ | `fixation_duration` | float seconds or NaN | fixation duration from `long_gaze.jsonl`; NaN unless `with_saccades=True` and the join matched |
28
+ | `saccade_amplitude` | float degrees or NaN | incoming-saccade amplitude; NaN unless `with_saccades=True` and derivable |
29
+ | `saccade_angle` | float radians or NaN | incoming-saccade direction (`atan2(dy, dx)`) |
30
+ | `saccade_peak_velocity` | float deg/s or NaN | incoming-saccade peak velocity |
31
+ | `saccade_mean_velocity` | float deg/s or NaN | incoming-saccade mean velocity |
32
+ | `saccade_dx`, `saccade_dy` | float or NaN | gaze-forward-vector delta components across the incoming saccade |
33
+ | `condition` | str | primary, as-published condition label (`IE` / `E`) -- **use this for any published-table-facing analysis** |
34
+ | `condition_ra` | str or None | secondary RA-proposed overlay label; **UNRESOLVED, does not match published tables**, transparency/audit only |
35
+ | `block_idx` | int | 0-indexed block within (subject, study, session); `-1` if not derivable (see caveat) |
36
+ | `difficulty` | int | adaptive difficulty level for `block_idx`, from `meta.jsonl`; `-1` if not found |
37
+
38
+ `block_idx` caveat: `iter_epochs` does not carry a literal block index field. `run`
39
+ was verified empirically (against on-disk `meta.jsonl`/block-directory counts for
40
+ multiple subjects across us1/us2/us3) to be a 1-indexed running block counter, so
41
+ `block_idx = run - 1` is used. This has not been verified for every subject/session;
42
+ treat `block_idx`/`difficulty` as best-effort, not a guaranteed-exact join.
43
+
44
+ ## EEG montage and epoch windows
45
+
46
+ - **EEG**: 20-channel B-Alert X24 subset, standard 10-20 layout, sampled at 256 Hz.
47
+ Epoch window is fixation-onset-locked `[-0.1, 0.8]` s → 230 samples/channel.
48
+ - **Pupil**: 2-channel (left/right) pupil diameter, sampled at 20 Hz. Epoch window is
49
+ fixation-onset-locked `[-1.0, 3.0]` s → 80 samples/channel.
50
+ - Both windows match `release/dataset/extract_epochs.py`'s `EEG_N_T_DEFAULT` /
51
+ `PUPIL_N_T_DEFAULT` constants (reused, not redefined, here).
52
+
53
+ ## Condition legend
54
+
55
+ - `condition` (primary, as-published): `IE` = Implicit+Explicit (EEG + shot events),
56
+ `E` = Explicit-only (shot events, no EEG). This is the label used throughout the
57
+ paper's published tables and figures.
58
+ - `condition_ra`: a secondary v1 RA-proposed relabeling overlay (adds `Oracle` /
59
+ `Control` labels for a handful of subjects) that is **UNRESOLVED against the
60
+ published cohort and does not match the paper's tables** (see
61
+ `release/dataset/attach_metadata.py`'s module docstring and `_RA_OVERRIDES`).
62
+ Included for transparency/auditing only -- always prefer `condition` for anything
63
+ that should agree with the paper.
64
+
65
+ ## `p_target` generation
66
+
67
+ `p_target` is the per-fixation implicit-evidence target probability produced by the default decoder in `release/olive/decode.py` (`DefaultDecoder`), which reads per-subject parameters under `eeg_priors/`. It is `NaN` for subjects/rows without available parameters. Replace the decoder with your own — see the repository README.
68
+
69
+ ## Coverage
70
+
71
+ Built from subjects=[4, 5, 12, 18, 20, 28, 29, 31, 33, 34, 35, 36, 37, 39, 40, 46, 47, 48, 49, 51, 52, 53, 54, 55, 59, 61, 63], studies=['us1', 'us2', 'us3'],
72
+ with_saccades=False.
73
+
74
+ - Total examples: 58184
75
+ - Target-label rate (`y==1`): 0.5735 (33371 target / 24813 non-target)
76
+ - `p_target` valid (non-NaN): 27445 rows, mean=0.5111; NaN: 30739 rows
77
+ - `p_target_quality` (valid rows): mean=0.7615, range=[0.5375, 0.9018]
78
+ - Subjects with zero examples across all studies: 2 ([61, 63])
79
+ - Subjects with >0 examples in at least one study: 25 ([4, 5, 12, 18, 20, 28, 29, 31, 33, 34, 35, 36, 37, 39, 40, 46, 47, 48, 49, 51, 52, 53, 54, 55, 59])
80
+
81
+ Full per-subject x per-study counts: see `coverage.csv` (same directory as
82
+ this card). Table (subject_id x study, `total` = row sum):
83
+
84
+ | subject_id | us1 | us2 | us3 | total |
85
+ |---|---|---|---|---|
86
+ | 4 | 725 | 925 | 1046 | 2696 |
87
+ | 5 | 591 | 0 | 0 | 591 |
88
+ | 12 | 564 | 0 | 863 | 1427 |
89
+ | 18 | 796 | 745 | 0 | 1541 |
90
+ | 20 | 1071 | 1407 | 994 | 3472 |
91
+ | 28 | 840 | 867 | 863 | 2570 |
92
+ | 29 | 633 | 901 | 1025 | 2559 |
93
+ | 31 | 520 | 0 | 0 | 520 |
94
+ | 33 | 662 | 598 | 560 | 1820 |
95
+ | 34 | 997 | 1109 | 1305 | 3411 |
96
+ | 35 | 778 | 1023 | 1217 | 3018 |
97
+ | 36 | 1022 | 1332 | 1466 | 3820 |
98
+ | 37 | 1014 | 932 | 1026 | 2972 |
99
+ | 39 | 1226 | 1755 | 1609 | 4590 |
100
+ | 40 | 875 | 693 | 795 | 2363 |
101
+ | 46 | 783 | 0 | 1217 | 2000 |
102
+ | 47 | 612 | 0 | 0 | 612 |
103
+ | 48 | 1412 | 2049 | 1593 | 5054 |
104
+ | 49 | 759 | 1961 | 1488 | 4208 |
105
+ | 51 | 1049 | 1332 | 798 | 3179 |
106
+ | 52 | 607 | 0 | 0 | 607 |
107
+ | 53 | 1013 | 1473 | 0 | 2486 |
108
+ | 54 | 946 | 0 | 0 | 946 |
109
+ | 55 | 924 | 0 | 0 | 924 |
110
+ | 59 | 798 | 0 | 0 | 798 |
111
+ | 61 | 0 | 0 | 0 | 0 |
112
+ | 63 | 0 | 0 | 0 | 0 |
113
+
114
+ ## Saccade fields caveat (`with_saccades`)
115
+
116
+ `saccade_*` and `fixation_duration` are **all-NaN by default**
117
+ (`with_saccades=False`). Deriving them requires loading a session's raw `.p`
118
+ eye-tracking recording (up to ~1-3GB) and joining each epoch's TFRecord-clock
119
+ `fix_time_s` against `long_gaze.jsonl`'s LSL-clock `t_onset` by nearest-match within
120
+ `item_id`, subject to a tolerance (default 1.0s) --
121
+ **these two clocks are not guaranteed to share an origin**, so even with
122
+ `with_saccades=True`, a session whose clocks do not align will legitimately yield
123
+ all-NaN saccade fields for every epoch in that session; this is a documented
124
+ limitation of the join, not a bug. A second caveat: for the small number of subjects
125
+ with multiple numbered "session" subdirectories under one study directory but only
126
+ one physical `.p` file at the study-directory root (observed for subject 5 / us1),
127
+ the join falls back to that one shared `.p` for every session under that study
128
+ directory, which can pool fixation events across sessions. See
129
+ `release/dataset/export_hf.py`'s module docstring for full detail.
130
+
131
+ ## Consent
132
+
133
+ All participants in `RELEASE_SUBJECTS` provided informed consent under the study's
134
+ IRB protocol for their de-identified physiological (EEG, pupil), behavioral, and
135
+ gaze data to be included in a public research dataset release. No directly
136
+ identifying information (name, contact info, raw video) is included in this export;
137
+ `subject_id` is a study-internal integer id, not a real-world identifier.
138
+
139
+ ## License
140
+
141
+ **TBD** -- placeholder: CC-BY-4.0 (pending final confirmation from the study PI /
142
+ IRB before public release).
143
+
144
+ ## Citation
145
+
146
+ **Placeholder** -- update with the final paper citation before public release:
147
+
148
+ ```
149
+ @inproceedings{olive-frp-2026,
150
+ title = {OLIVE: [paper title TBD]},
151
+ author = {[authors TBD]},
152
+ booktitle = {[venue TBD]},
153
+ year = {2026},
154
+ }
155
+ ```