View source

CompositePipeline

Pipeline that composes multiple pipelines

Notes

• Do not nest the composite pipeline inside a composite pipeline

Implements the Pipeline protocol.

PARAMETER	DESCRIPTION
pipelines	Pipelines TYPE: list[Pipeline]

from_config classmethod

Creates a composite pipeline from the configuration.

PARAMETER	DESCRIPTION
config	Configuration TYPE: CompositePipelineConfig

RETURNS	DESCRIPTION
CompositePipeline	Composite pipeline

__call__

Runs the composite pipeline.

---

CompositePipelineConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of CompositePipeline

Notes

• Use the top level plugins_dir_path and omit the plugins_dir_path from the pipeline configurations

Create the configuration from a config file

• Use null instead of None

Example

You can create the configuration from a config file.

config.yaml

package: 'aviary'
name: 'CompositePipeline'
config:
  plugins_dir_path: null

  pipeline_configs:
    - ...
    ...

ATTRIBUTE	DESCRIPTION
plugins_dir_path	Path to the plugins directory - defaults to None TYPE: Path | None
pipeline_configs	Configurations of the pipelines TYPE: list[PipelineConfig]