run_workflow
Run a SLURM workflow from a YAML file, automatically handling job dependencies and parallel execution.
Instructions
Execute a SLURM workflow from a YAML file.
Jobs are executed in dependency order - independent jobs run in parallel,
dependent jobs wait for their prerequisites to complete.
Args:
yaml_path: Path to the YAML workflow file
from_job: Start execution from this job (skip earlier jobs)
to_job: Stop execution at this job (skip later jobs)
single_job: Execute only this specific job, ignoring dependencies
dry_run: If true, show what would be executed without actually running
args: Optional mapping merged over the YAML ``args`` section before
Jinja rendering. ``python:`` prefix values are rejected.
sweep: Optional sweep spec: ``{"matrix": {...}, "fail_fast": bool,
"max_parallel": int}``. When present, the request goes through
:class:`SweepOrchestrator` and the response contains
``sweep_run_id``.
transport: Cluster selector — omit / "local" for local SLURM, or an
SSH profile name to run against that remote cluster. Orthogonal to
``mount``: ``transport`` picks *which* cluster, ``mount`` picks the
path-translation root within it.
mount: Optional mount name within the SSH profile, enabling mount-aware
path translation for ``work_dir`` / ``log_dir``. Requires an SSH
``transport``; passing ``mount`` with a local transport is an error.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| args | No | ||
| mount | No | ||
| sweep | No | ||
| to_job | No | ||
| dry_run | No | ||
| from_job | No | ||
| transport | No | ||
| yaml_path | Yes | ||
| single_job | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||