Pipelines¶
taters.pipelines.run_pipeline ¶
Taters Pipeline Runner (robust templating + flexible call resolution)
- ITEM steps run once per input (fan-out concurrently).
- GLOBAL steps run once (barrier before/after).
- Templating preserves native types when the entire value is a single template (e.g., {{var:text_cols}} → list, not "['text']").
- Calls:
- "potato.*" → call via a Taters() instance (e.g., potato.text.analyze_with_dictionaries)
- dotted path → import and call any function (e.g., taters.helpers.feature_gather.aggregate_features)
Usage example: python -m taters.pipelines.run_pipeline --root_dir videos --file_type video --preset conversation_video --workers 4 --var device=cuda --var overwrite_existing=true
discover_inputs ¶
discover_inputs(root_dir, kind)
Recursively discover input files under a root folder.
The preset's ITEM-scoped steps operate over a list of inputs. This
function builds that list by scanning root_dir
and selecting files by
type:
- kind == "video": only common video extensions (e.g., .mp4, .mov, .mkv)
- kind == "audio": only common audio extensions (e.g., .wav, .mp3, .flac)
- kind == "any": all files
Parameters:
Name | Type | Description | Default |
---|---|---|---|
root_dir
|
Path
|
Directory to scan (will be resolved to an absolute path). |
required |
kind
|
('audio', 'video', 'any')
|
Filter that determines which file extensions are included. |
"audio","video","any"
|
Returns:
Type | Description |
---|---|
List[Path]
|
Sorted list of absolute file paths. |
Raises:
Type | Description |
---|---|
FileNotFoundError
|
If |
Source code in src\taters\pipelines\run_pipeline.py
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 |
|
load_preset_by_name ¶
load_preset_by_name(name)
Load a named pipeline preset from taters/pipelines/presets/<name>.yaml
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Basename of a YAML preset in the |
required |
Returns:
Type | Description |
---|---|
dict
|
Parsed YAML as a Python dictionary. Returns |
Raises:
Type | Description |
---|---|
FileNotFoundError
|
If the preset file does not exist. |
Source code in src\taters\pipelines\run_pipeline.py
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 |
|
load_yaml_file ¶
load_yaml_file(path)
Load a YAML file into a Python dictionary.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
Path
|
Full path to a YAML file. |
required |
Returns:
Type | Description |
---|---|
dict
|
Parsed YAML contents. Empty files yield |
Source code in src\taters\pipelines\run_pipeline.py
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
|
main ¶
main()
Entry point for the Taters Pipeline Runner.
Responsibilities
- Parse CLI arguments (
--preset
or--preset-file
, optional--vars-file
and repeated--var key=value
overrides,--workers
, etc.). - Load the preset YAML and merge variables from three sources in order:
1) preset
vars
block 2)--vars-file
(YAML) 3) repeated--var
CLI flags - Decide whether input discovery is required:
- If the preset has any ITEM-scoped steps,
--root_dir
is required and files are discovered withdiscover_inputs(...)
. - If there are only GLOBAL steps, discovery is skipped entirely.
- If the preset has any ITEM-scoped steps,
- Build a run manifest skeleton (preset name, inputs, vars, globals).
- Create a single
Taters()
instance (shared across all steps in the run). - Execute each step in order:
- ITEM steps: fan out across discovered inputs using a thread or process pool (configurable per step). A given step reuses one pool for all items to amortize worker startup.
- GLOBAL steps: run once, in order, with a barrier between steps.
- After each step, update and persist the JSON manifest so long-running runs are observable and resumable.
- Print the final manifest path on completion.
Concurrency Notes
- The default executor for ITEM steps is a
ThreadPoolExecutor
(good for I/O-bound steps and for GPU inference that releases the GIL). - For heavy Python/CPU work, presets may set
engine: process
on a step to use aProcessPoolExecutor
. In that case, be mindful that a new Python process is spawned for each worker (model weights may be reloaded once per worker).
Error Handling
- Individual ITEM step failures do not crash the pipeline; they mark that
item as
"error"
in the manifest and continue. - GLOBAL step failures are terminal for the run (the loop breaks).
Returns:
Type | Description |
---|---|
None
|
The function exits the process after writing the manifest. |
Source code in src\taters\pipelines\run_pipeline.py
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
|
merge_vars ¶
merge_vars(base, overlay)
Shallow-merge two variable dictionaries.
Later sources of variables (e.g., --vars-file
, then repeated --var
overrides) should replace keys from earlier sources. This helper
applies a simple dict.update(...)
and returns a new dictionary.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
base
|
dict
|
The starting dictionary of variables. |
required |
overlay
|
dict
|
The dictionary whose keys override entries in |
required |
Returns:
Type | Description |
---|---|
dict
|
A new dictionary with merged keys/values. |
Source code in src\taters\pipelines\run_pipeline.py
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
|
parse_var_overrides ¶
parse_var_overrides(pairs)
Parse --var key=value
CLI overrides into typed Python values.
Typing rules: - "true"/"false" (case-insensitive) → bool - "null"/"none" (case-insensitive) → None - integer or float strings → numeric - all else → raw string
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pairs
|
List[str]
|
CLI arguments of the form |
required |
Returns:
Type | Description |
---|---|
dict
|
Mapping from variable name to parsed value. |
Raises:
Type | Description |
---|---|
ValueError
|
If any entry does not contain an '=' separator. |
Source code in src\taters\pipelines\run_pipeline.py
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 |
|
render_value ¶
render_value(
val, *, item_ctx, globals_ctx, vars_ctx, input_path
)
Render templating expressions within a value (str, list, or dict).
Behavior
- Dicts/lists/tuples: render recursively.
- If a string is exactly one template token (e.g., "{{var:text_cols}}"), return the native value of that expression (list, int, bool, ...).
- Otherwise, perform string substitution for every {{...}} occurrence and return the resulting string.
Resolution rules (summary)
- {{input}} / {{cwd}}
- {{var:key}}
- {{global.path}} (explicit globals)
- {{pick:name.path}} → search item, then globals
- {{name}} → bare name; search item, then globals
Source code in src\taters\pipelines\run_pipeline.py
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 |
|
resolve_call ¶
resolve_call(call_name, potato)
Resolve a call target from a preset step into an actual callable.
Supported forms
1) Taters instance methods (recommended):
- "potato.audio.convert_to_wav"
- "potato.text.analyze_with_dictionaries"
The function is resolved via attribute chaining on a single
Taters()
instance created for the whole run.
2) Dotted import paths:
- "package.module:function"
- "package.module.func"
- "package.module.Class.method"
The target is imported and attributes are resolved. The final target
must be callable.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
call_name
|
str
|
Call string from the preset step's |
required |
potato
|
Taters
|
The shared |
required |
Returns:
Type | Description |
---|---|
Callable
|
The function/object that will be invoked for the step. |
Raises:
Type | Description |
---|---|
(AttributeError, KeyError, TypeError)
|
If the target cannot be resolved or is not callable. |
Source code in src\taters\pipelines\run_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 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 565 566 567 568 569 570 |
|
run_global_step ¶
run_global_step(
*, step, potato, globals_ctx, vars_ctx, manifest_path
)
Execute a single GLOBAL-scoped step (runs once per pipeline).
Differences from ITEM steps
- The templating
item_ctx
is empty. - The run manifest path is injected into
vars
asrun_manifest
, so presets can reference it in GLOBAL stages. - On success, any values from
save_as:
are merged into theglobals
artifact map.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
step
|
dict
|
The step definition block from the preset. |
required |
potato
|
Taters
|
Shared Taters instance used to call |
required |
globals_ctx
|
Dict[str, Any]
|
Accumulated global artifacts (readable by later steps). |
required |
vars_ctx
|
Dict[str, Any]
|
Merged variables. |
required |
manifest_path
|
Path
|
Path where the JSON run manifest is (or will be) saved. |
required |
Returns:
Type | Description |
---|---|
Tuple[str, Dict[str, Any], Dict[str, Any]]
|
A tuple |
Source code in src\taters\pipelines\run_pipeline.py
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 |
|
run_item_step_for_one_input ¶
run_item_step_for_one_input(
*,
step,
input_path,
potato,
item_artifacts,
globals_ctx,
vars_ctx
)
Execute a single ITEM-scoped step for one input path.
Lifecycle
1) Template the step's with:
parameters using render_value(...)
.
2) Validate any require:
keys after templating (fail fast if missing).
3) Resolve the callable (Taters method or import path).
4) Invoke with keyword arguments.
5) If the step specified save_as: <name>
, store the return value under
that name in the item's artifacts
dict.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
step
|
dict
|
The step definition block from the preset. |
required |
input_path
|
Path
|
The current input file for ITEM scope. |
required |
potato
|
Taters
|
Shared Taters instance used to call |
required |
item_artifacts
|
Dict[str, Any]
|
The current item's artifact dictionary (mutated across steps). |
required |
globals_ctx
|
Dict[str, Any]
|
Global artifacts (from GLOBAL steps). |
required |
vars_ctx
|
Dict[str, Any]
|
Merged variables. |
required |
Returns:
Type | Description |
---|---|
Tuple[str, Dict[str, Any], Dict[str, Any]]
|
A tuple |
Source code in src\taters\pipelines\run_pipeline.py
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 |
|