Skip to content

kiara.info.pipelines

PipelineModuleInfo pydantic-model

structure: PipelineStructureDesc pydantic-field required

The pipeline structure.

PipelineState pydantic-model

Describes the current state of a pipeline.

This includes the structure of the pipeline (how the internal modules/steps are connected to each other), as well as all current input/output values for the pipeline itself, as well as for all internal steps.

Use the dict or json methods to convert this object into a generic data structure.

pipeline_inputs: PipelineValuesInfo pydantic-field required

The current (externally facing) input values of this pipeline.

pipeline_outputs: PipelineValuesInfo pydantic-field required

The current (externally facing) output values of this pipeline.

status: StepStatus pydantic-field required

The current overal status of the pipeline.

step_inputs: Dict[str, kiara.pipeline.PipelineValuesInfo] pydantic-field required

The current (internal) input values of each step of this pipeline.

step_outputs: Dict[str, kiara.pipeline.PipelineValuesInfo] pydantic-field required

The current (internal) output values of each step of this pipeline.

step_states: Dict[str, kiara.pipeline.StepStatus] pydantic-field required

The status of each step.

structure: PipelineStructureDesc pydantic-field required

The structure (interconnections of modules/steps) of the pipeline.

PipelineStructureDesc pydantic-model

Outlines the internal structure of a Pipeline.

pipeline_input_connections: Dict[str, List[str]] pydantic-field required

The connections of this pipelines input fields. One input field can be connected to one or several step input fields.

pipeline_inputs: Dict[str, kiara.pipeline.values.PipelineInputRef] pydantic-field required

The pipeline inputs.

pipeline_output_connections: Dict[str, str] pydantic-field required

The connections of this pipelines output fields. Each pipeline output is connected to exactly one step output field.

pipeline_outputs: Dict[str, kiara.pipeline.values.PipelineOutputRef] pydantic-field required

The pipeline outputs.

processing_stages: List[List[str]] pydantic-field required

The order in which this pipeline has to be processed (basically the dependencies of each step on other steps, if any).

steps: Dict[str, kiara.pipeline.config.StepDesc] pydantic-field required

The steps contained in this pipeline, with the 'step_id' as key.

StepsInfo pydantic-model

processing_stages: List[List[str]] pydantic-field required

The stages in which the steps are processed.

steps: Dict[str, kiara.pipeline.config.StepDesc] pydantic-field required

A list of step details.