Tokenizer¶
The Tokenizer is the second stage of the pipeline. It takes the collated events
and turns them into per-subject integer sequences ("timelines"), learning a
vocabulary and numeric-binning scheme along the way. Its behavior is driven by a
tokenization config (tokenization.yaml).
Crucially, both the vocabulary and the numeric bins are learned only on the training split, so no information leaks from tuning or held-out subjects.
What it produces¶
Running the tokenizer (via save_all)
writes two files to the processed-data directory:
tokens_times.parquet— the tokenized timelines (tokens,times, and optionallynumeric_values) for each subject.tokenizer.yaml— the learned state (lookup table, bins, and config), sufficient to reconstruct the tokenizer.
How it works¶
The orchestrator get_all runs these steps
in order:
add_ends— insertBOS/EOSmarkers at the start and end of each subject's timeline.add_clocks— optionally insertCLCK//HHtokens at configured hours of the day.bin_data— discretize numeric values into quantile bins (Q0,Q1, …) using cut points learned byget_bins.insert_time_spacers— optionally insertTIME//…tokens encoding the gap between consecutive events.tokenize_data— map the vocabulary to integers via the lookup table fromget_lookup, sorting simultaneous events by the configuredorderingpriority.UNKis always token0.
Reusing a trained tokenizer¶
A tokenizer's learned state round-trips through
to_yaml and
from_yaml, so a tokenizer trained on one
dataset can be frozen (is_training=False) and applied to another — see the
Tokenizer Transfer recipe.
!!! tip "It behaves like a mapping" A Tokenizer is callable and dict-like:
tkzr("EOS") returns a token id (0 for out-of-vocabulary words),
"foo" in tkzr tests vocabulary membership, and len(tkzr) reports the
vocabulary size.
tokenizes collated data into integer sequences, creating bins & a lookup table
Tokenizer
¶
Bases: Configurable
converts collated data to tokenized timelines, learning bins and lookup table on training data
Source code in src/cocoa/tokenizer.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 | |
__call__(word)
¶
apply tokenizer to a single word
__contains__(word)
¶
__len__()
¶
add_clocks(df)
¶
add clock codes if configured
Source code in src/cocoa/tokenizer.py
add_ends(df)
staticmethod
¶
add BOS / EOS codes at appropriate places
Source code in src/cocoa/tokenizer.py
bin_data(df)
¶
discretize numeric values with learned cut points
Source code in src/cocoa/tokenizer.py
from_yaml(yaml_str, done_training=True)
¶
construct tokenizer from yaml representation places tokenizer into inference mode by default
Source code in src/cocoa/tokenizer.py
get_all(verbose=False)
¶
run all steps to convert collated data to tokenized timelines
Source code in src/cocoa/tokenizer.py
get_bins(df)
¶
calculate bins for numeric values on training data
Source code in src/cocoa/tokenizer.py
get_lookup(pt)
¶
create mapping from vocabulary to integer tokens on training data
Source code in src/cocoa/tokenizer.py
get_pretokenized(df)
¶
prepare codes for tokenization, depending on whether fusion is configured
Source code in src/cocoa/tokenizer.py
get_priority()
¶
insert_time_spacers(df)
¶
add time spacing tokens if configured; this should be done after clock tokens are inserted
Source code in src/cocoa/tokenizer.py
load(path, done_training=True)
¶
retrieve tokenizer from saved yaml representation
Source code in src/cocoa/tokenizer.py
save(path)
¶
write yaml representation of tokenizer to disc
Source code in src/cocoa/tokenizer.py
save_all(verbose=False)
¶
get tokenized timelines and save them to disc, along with artifacts created during tokenization
Source code in src/cocoa/tokenizer.py
to_yaml()
¶
yaml representation of tokenizer; sufficient for reconstruction
Source code in src/cocoa/tokenizer.py
tokenize_data(pt)
¶
apply lookup table to pretokenized data