boilercv_pipeline.models.data

boilercv_pipeline.models.data#

Output data model.

Submodules#

Package Contents#

Classes#

Dfs

Data frames.

Plots

Plots.

Data

Data frame and plot outputs.

Data#

AnyData

API#

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

Bases: pydantic.BaseModel

Data frames.

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: pandas.DataFrame#

‘Field(…)’

dst: pandas.DataFrame#

‘Field(…)’

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

Bases: pydantic.BaseModel

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.

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

Bases: pydantic.BaseModel, typing.Generic[boilercv_pipeline.models.data.types.Dfs_T, boilercv_pipeline.models.data.types.Plots_T]

Data frame and plot 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.

dfs: boilercv_pipeline.models.data.types.Dfs_T#

‘Field(…)’

plots: boilercv_pipeline.models.data.types.Plots_T#

‘Field(…)’

boilercv_pipeline.models.data.AnyData#

None

Contents