boilercv_pipeline.models.contexts

boilercv_pipeline.models.contexts#

Contexts.

Submodules#

Package Contents#

Classes#

Roots

Root directories.

DvcContext

DVC context.

BoilercvPipelineContext

Root directory context.

BoilercvPipelineContexts

Boilercv pipeline context.

Data#

BOILERCV_PIPELINE

Context name for boilercv_pipeline.

DVC

DVC context name for boilercv_pipeline.

MODEL

DVC model attribute name.

PARAMS

DVC params attribute name.

ROOTED

Paths rooted to their directories.

API#

boilercv_pipeline.models.contexts.BOILERCV_PIPELINE#

‘boilercv_pipeline’

Context name for boilercv_pipeline.

boilercv_pipeline.models.contexts.DVC#

‘boilercv_dvc’

DVC context name for boilercv_pipeline.

boilercv_pipeline.models.contexts.MODEL#

‘model’

DVC model attribute name.

boilercv_pipeline.models.contexts.PARAMS#

‘params’

DVC params attribute name.

class boilercv_pipeline.models.contexts.Roots(
/,
**data: typing.Any,
)#

Bases: pydantic.BaseModel

Root directories.

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.

data: pathlib.Path | None#

None

Data.

docs: pathlib.Path | None#

None

Docs.

boilercv_pipeline.models.contexts.ROOTED#

‘Roots(…)’

Paths rooted to their directories.

class boilercv_pipeline.models.contexts.DvcContext(
/,
**data: typing.Any,
)#

Bases: pydantic.BaseModel

DVC context.

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: boilercv_pipeline.models.dvc.DvcYamlModel#

‘Field(…)’

Synchronized dvc.yaml configuration.

params: dict[str, Any]#

‘Field(…)’

DVC params.yaml synchronized to dvc.yaml.

property stage: boilercv_pipeline.models.dvc.Stage#

Current DVC stage being assembled.

property cmd: str | list[str]#

Current DVC stage command.

class boilercv_pipeline.models.contexts.BoilercvPipelineContext(
/,
**data: typing.Any,
)#

Bases: pydantic.BaseModel

Root directory context.

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.

roots: boilercv_pipeline.models.contexts.Roots#

‘Field(…)’

Root directories for different kinds of paths.

kinds: boilercv_pipeline.models.contexts.types.Kinds#

‘Field(…)’

Kind of each path.

track_kinds: bool#

False

Whether to track kinds.

class boilercv_pipeline.models.contexts.BoilercvPipelineContexts#

Bases: context_models.types.Context

Boilercv pipeline context.

Initialization

Initialize self. See help(type(self)) for accurate signature.

boilercv_pipeline: boilercv_pipeline.models.contexts.BoilercvPipelineContext#

None

boilercv_dvc: NotRequired[boilercv_pipeline.models.contexts.DvcContext]#

None

Contents