boilercv_pipeline.models.stage

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

Submodules

• boilercv_pipeline.models.stage.types

Package Contents

Classes

Constants	Constants.
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.

Data

const

API

class boilercv_pipeline.models.stage.Constants(

/,

**data: typing.Any,

)

Bases: pydantic.BaseModel

Constants.

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.

dvc_out_config: boilercv_pipeline.models.dvc.OutFlags

‘OutFlags(…)’

Default dvc.yaml configuration for outs.

skip_cloud: list[str]

[‘data/cines’, ‘data/large_sources’]

These paths are too large and unwieldy to cache or push to cloud storage.

dvc_out_skip_cloud_config: boilercv_pipeline.models.dvc.OutFlags

‘OutFlags(…)’

Default dvc.yaml configuration for outs that skip the cloud.

boilercv_pipeline.models.stage.const

‘Constants(…)’

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(…)’

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_validate_out(

value: pathlib.Path,

info: context_models.validators.types.ContextValidationInfo[boilercv_pipeline.models.contexts.BoilercvPipelineContexts],

) → pathlib.Path

Serialize path 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

plots: boilercv_pipeline.models.path.DataDir

None

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’

dst: str

‘dst’