m3resp.workflows.WorkflowSpec

class m3resp.workflows.WorkflowSpec(name, schema_version=None, description='', inputs=<factory>, metadata=<factory>, execution=<factory>, steps=(), outputs=<factory>, experiment=<factory>, root=<factory>)

An ordered workflow description with inputs, settings and export options.

Variables:

• name (str) – Workflow name.

• schema_version (int | None) – Format version, or None for an unversioned spec.

• description (str) – Optional description of the analysis.

• inputs (dict[str, Any]) – Values referenced from step settings with @name.

• metadata (dict[str, Any]) – Additional study, site or session notes.

• execution (m3resp.workflows.spec.SpecExecutionConfig) – Error policy and recorded seed.

• steps (tuple[m3resp.workflows.spec.StepSpec, ...]) – Operations in execution order.

• outputs (m3resp.workflows.spec.SpecOutputsConfig) – Export options used by run_spec and export steps.

• experiment (m3resp.workflows.spec.SpecExperimentConfig) – Study labels used for result-file naming.

• root (pathlib.Path) – Base directory for relative path settings. Loading a file uses its parent directory unless a root is supplied.

Parameters:

• name (str)

• schema_version (int | None)

• description (str)

• inputs (dict[str, Any])

• metadata (dict[str, Any])

• execution (SpecExecutionConfig)

• steps (tuple[StepSpec, ...])

• outputs (SpecOutputsConfig)

• experiment (SpecExperimentConfig)

• root (Path)

Attributes

description
is_legacy	Whether this spec was parsed without a schema_version.
schema_version
steps
name
inputs
metadata	Additional study, site or session notes.
execution
outputs
experiment
root	Base directory used to resolve relative path settings.

description: str = ''

execution: SpecExecutionConfig

experiment: SpecExperimentConfig

inputs: dict[str, Any]

property is_legacy: bool

Whether this spec was parsed without a schema_version.

metadata: dict[str, Any]

Additional study, site or session notes.

name: str

outputs: SpecOutputsConfig

root: Path

Base directory used to resolve relative path settings.

schema_version: int | None = None

steps: tuple[StepSpec, ...] = ()