pipeline¶
Training-loop behavior is described in Training loop.
mlkit.pipeline
¶
BaseCallback
¶
Source code in src/mlkit/pipeline/callback.py
35 36 37 38 39 40 41 42 43 44 | |
on_event(event, *args, **kwargs)
abstractmethod
¶
Handle one pipeline lifecycle event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
CallbackEvent
|
Callback event. |
required |
*args
|
Positional payload for the event. |
()
|
|
**kwargs
|
Keyword payload for the event. |
{}
|
Source code in src/mlkit/pipeline/callback.py
36 37 38 39 40 41 42 43 44 | |
CallbackManager
¶
Source code in src/mlkit/pipeline/callback.py
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 | |
add_callback(callback)
¶
Append one callback.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
callback
|
BaseCallback
|
Callback instance to register. |
required |
Source code in src/mlkit/pipeline/callback.py
51 52 53 54 55 56 57 58 | |
add_callbacks(callbacks)
¶
Append multiple callbacks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
callbacks
|
Optional[List[BaseCallback]]
|
Callbacks to register. |
required |
Source code in src/mlkit/pipeline/callback.py
60 61 62 63 64 65 66 67 | |
trigger(event, *args, **kwargs)
¶
Invoke every registered callback for event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
CallbackEvent
|
Callback event. |
required |
*args
|
Positional payload. |
()
|
|
**kwargs
|
Keyword payload. |
{}
|
Source code in src/mlkit/pipeline/callback.py
69 70 71 72 73 74 75 76 77 78 | |
DistributedPipeline
¶
Bases: BasePipeline
Source code in src/mlkit/pipeline/distributed_pipeline.py
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 | |
__init__(model, dataset, optimizers, training_config, log_config, logger, collate_fn=None, seed=42, callbacks=None, **kwargs)
¶
Build an :class:Accelerator, prepare modules, and resume if configured.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
seed
|
int
|
RNG seed applied before |
42
|
Source code in src/mlkit/pipeline/distributed_pipeline.py
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 | |
trigger_callbacks(event, **kwargs)
¶
Trigger all callbacks for a given event
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
CallbackEvent
|
the event to trigger |
required |
**kwargs
|
the keyword arguments to pass to the callback |
{}
|
Source code in src/mlkit/pipeline/distributed_pipeline.py
341 342 343 344 345 346 347 348 349 350 351 352 | |
DistributedTrainingConfig
¶
Bases: TrainingConfig
Source code in src/mlkit/pipeline/distributed_pipeline.py
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 | |
__init__(n_epochs=100, batch_size=4, device='cuda', save_strategy='epochs', save_dir=None, save_steps=10, save_epochs=1, save_total_limit=5, num_workers=4, train_shuffle=True, eval_strategy=None, eval_steps=500, eval_epochs=1, grad_clip_strategy='norm', max_grad_norm=1.0, max_grad_value=1.0, gradient_accumulation_steps=1, mixed_precision='fp16', find_unused_parameters=False, **kwargs)
¶
Accelerate-specific training settings (mixed precision, DDP flags).
Shared schedule fields are documented on :class:TrainingConfig.
Source code in src/mlkit/pipeline/distributed_pipeline.py
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 | |
BasePipeline
¶
Source code in src/mlkit/pipeline/pipeline.py
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 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 | |
halted
property
¶
Whether a shared or local failure stopped training on this rank.
__init__(model, dataset, optimizers, training_config, log_config, logger, collate_fn=None, callbacks=None, load_checkpoint=True, *_args, **_kwargs)
¶
Wire model, data, optimizers, configs, callbacks, and optional checkpoint resume.
Source code in src/mlkit/pipeline/pipeline.py
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 | |
compute_loss(model, batch)
abstractmethod
¶
Compute loss for one batch.
Source code in src/mlkit/pipeline/pipeline.py
169 170 171 | |
train()
¶
Run the epoch-based training loop until n_epochs or halt.
Source code in src/mlkit/pipeline/pipeline.py
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 | |
train_an_epoch()
¶
Train one epoch.
Returns:
| Type | Description |
|---|---|
bool
|
True when every step in the epoch ran. A halt after that still |
bool
|
counts as complete. A halt inside the step loop does not. |
Source code in src/mlkit/pipeline/pipeline.py
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 | |
train_a_step(batch)
¶
Run forward, backward, optional clip/step, and logging for one batch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
batch
|
Dict[str, Any]
|
Training batch moved to |
required |
Source code in src/mlkit/pipeline/pipeline.py
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 | |
gradient_clip()
¶
Clip gradients when grad_clip_strategy is norm or value.
Source code in src/mlkit/pipeline/pipeline.py
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | |
eval()
¶
Evaluate the model; subclasses implement distributed gathering.
Source code in src/mlkit/pipeline/pipeline.py
315 316 | |
log(metrics, *, step=None)
¶
Record one metric payload on the global main process.
Callbacks receive a LOG event. A callback failure is remembered, and
the text line is still written when a logger is attached.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
metrics
|
Mapping[str, Any]
|
values to record. |
required |
step
|
int | None
|
step index for this payload. |
None
|
Source code in src/mlkit/pipeline/pipeline.py
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 | |
save()
¶
Write model, optimizer, and training state under save_dir.
Source code in src/mlkit/pipeline/pipeline.py
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 | |
load()
¶
Restore the latest checkpoint from save_dir when present.
Source code in src/mlkit/pipeline/pipeline.py
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | |
add_callbacks(callbacks)
¶
Register extra pipeline callbacks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
callbacks
|
List[BaseCallback] | None
|
Callbacks to append, or |
required |
Source code in src/mlkit/pipeline/pipeline.py
538 539 540 541 542 543 544 | |
trigger_callbacks(event, **kwargs)
¶
Dispatch one callback event with training context and extra keywords.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
CallbackEvent
|
Callback lifecycle event. |
required |
**kwargs
|
Event-specific payload for callbacks. |
{}
|
Source code in src/mlkit/pipeline/pipeline.py
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 | |
LogConfig
¶
Source code in src/mlkit/pipeline/pipeline.py
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 | |
__init__(log_dir='logs', log_steps=100, log_epochs=1, log_strategy='epochs', *_args, **_kwargs)
¶
Directory and interval for file logging during training.
Source code in src/mlkit/pipeline/pipeline.py
74 75 76 77 78 79 80 81 82 83 84 85 86 87 | |
TrainingConfig
¶
Source code in src/mlkit/pipeline/pipeline.py
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 | |
__init__(n_epochs=100, batch_size=4, device='cuda', save_strategy='epochs', save_dir=None, save_steps=10, save_epochs=1, save_total_limit=5, num_workers=4, train_shuffle=True, eval_strategy=None, eval_steps=500, eval_epochs=1, grad_clip_strategy='norm', max_grad_norm=1.0, max_grad_value=1.0, gradient_accumulation_steps=1, *_args, **_kwargs)
¶
Training hyperparameters and checkpoint, eval, and save scheduling.
See the Training loop guide (docs/training.md) for how each field drives
the epoch and step clocks.
Source code in src/mlkit/pipeline/pipeline.py
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 | |
TrainingState
¶
Source code in src/mlkit/pipeline/pipeline.py
90 91 92 93 94 95 96 97 98 99 100 | |
__init__(current_epoch=0, current_step_in_epoch=0, current_global_step=0)
¶
Epoch, in-epoch step, and global step counters for resume and intervals.
Source code in src/mlkit/pipeline/pipeline.py
91 92 93 94 95 96 97 98 99 100 | |