boilercv_pipeline.models.stage

Pipeline stage model and models at sub-pipeline stage granularity.

Submodules

• boilercv_pipeline.models.stage.types

Package Contents

Classes

Stage	Base of pipeline stage models.
StagePaths	Paths for stage dependencies and outputs.
Deps	Stage dependency paths.
Outs	Stage output paths.
DfsPlotsOuts	Stage output paths including data frames and plots.
DataStage	Data stage in a pipeline stage.

API

class boilercv_pipeline.models.stage.Stage(

/,

**data: context_models.types.Data,

)

Bases: boilercv_pipeline.models.path.BoilercvPipelineContextStore

Base of pipeline stage models.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config

‘get_boilercv_pipeline_config(…)’

classmethod dvc_prepare_stage(

data: dict[str, Any],

handler: pydantic.functional_validators.ModelWrapValidatorHandler[Self],

info: boilercv_pipeline.sync_dvc.types.DvcValidationInfo,

) → Self

Prepare a pipeline stage for dvc.yaml.

classmethod dvc_add_param(

value: Any,

info: boilercv_pipeline.sync_dvc.types.DvcValidationInfo,

) → Any

Add param to global parameters and stage command for dvc.yaml.

class boilercv_pipeline.models.stage.StagePaths(

/,

**data: context_models.types.Data,

)

Bases: boilercv_pipeline.models.path.BoilercvPipelineContextStore

Paths for stage dependencies and outputs.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config

‘get_boilercv_pipeline_config(…)’

classmethod dvc_set_stage_path(

path: pathlib.Path,

info: boilercv_pipeline.sync_dvc.types.DvcValidationInfo,

) → pathlib.Path

Set stage path as a stage dep, plot, or out for dvc.yaml.

class boilercv_pipeline.models.stage.Deps(

/,

**data: context_models.types.Data,

)

Bases: boilercv_pipeline.models.stage.StagePaths

Stage dependency paths.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class boilercv_pipeline.models.stage.Outs(

/,

**data: context_models.types.Data,

)

Bases: boilercv_pipeline.models.stage.StagePaths

Stage output paths.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class boilercv_pipeline.models.stage.DfsPlotsOuts(

/,

**data: context_models.types.Data,

)

Bases: boilercv_pipeline.models.stage.Outs

Stage output paths including data frames and plots.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

dfs: boilercv_pipeline.models.path.DataDir

None

Output data directory for this stage.

plots: boilercv_pipeline.models.path.DataDir

None

Output plots directory for this stage.

class boilercv_pipeline.models.stage.DataStage(

/,

**data: typing.Any,

)

Bases: pydantic.BaseModel

Data stage in a pipeline stage.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

src: str

‘src’

Source data for this stage.

dst: str

‘dst’

Destination data for this stage.