pipeline

Configurable workflows and scripts.

Pipelines are flexible objects consisting of two logical parts: configurable parameters and a custom script defined by overriding the abstract method run().

To facilitate the development and testing of models, Sapicore provides a compact default simulation pipeline with a sample configuration YAML. Advanced users may use those as a basis for custom workflows.

class pipeline.Pipeline(config_or_path: dict | str = None, **kwargs)

Pipeline base class.

Parameters:

config_or_path (dict or str, optional) – Dictionary or path to YAML to use with apply_config().

Raises:

FileNotFoundError – If provided with an invalid string configuration path.

run() → None

Pipeline implementation, to be overridden by the user.

Modules

pipeline.simple

Simple simulation pipeline.