Skip to content

dqm_ml_core.models.outputs

Output configuration models for pipeline results.

Defines output settings for features, metrics, and domain-gap computations including destination paths and column filtering.

FeaturesOutputsConfig

Bases: BaseModel

Output configuration for computed features.

Source code in packages/dqm-ml-core/src/dqm_ml_core/models/outputs.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class FeaturesOutputsConfig(BaseModel):
    """Output configuration for computed features."""

    model_config = ConfigDict(extra="forbid")

    path: str = Field(description="Destination path for feature output.")
    include: list[str] | None = Field(
        default=None,
        description="Feature columns to include (fnmatch patterns supported).",
    )
    exclude: list[str] | None = Field(
        default=None,
        description="Feature columns to exclude (fnmatch patterns supported).",
    )

exclude: list[str] | None = Field(default=None, description='Feature columns to exclude (fnmatch patterns supported).') class-attribute instance-attribute

include: list[str] | None = Field(default=None, description='Feature columns to include (fnmatch patterns supported).') class-attribute instance-attribute

model_config = ConfigDict(extra='forbid') class-attribute instance-attribute

path: str = Field(description='Destination path for feature output.') class-attribute instance-attribute

GapOutputsConfig

Bases: BaseModel

Output configuration for domain-gap results.

Source code in packages/dqm-ml-core/src/dqm_ml_core/models/outputs.py 
57
58
59
60
61
62
63
class GapOutputsConfig(BaseModel):
    """Output configuration for domain-gap results."""

    model_config = ConfigDict(extra="forbid")

    path: str = Field(description="Destination path for domain-gap output.")
    pairwise: bool = Field(default=True, description="Include pairwise (delta) results.")

model_config = ConfigDict(extra='forbid') class-attribute instance-attribute

pairwise: bool = Field(default=True, description='Include pairwise (delta) results.') class-attribute instance-attribute

path: str = Field(description='Destination path for domain-gap output.') class-attribute instance-attribute

MetricsOutputsConfig

Bases: BaseModel

Output configuration for computed metrics.

Source code in packages/dqm-ml-core/src/dqm_ml_core/models/outputs.py 
49
50
51
52
53
54
class MetricsOutputsConfig(BaseModel):
    """Output configuration for computed metrics."""

    model_config = ConfigDict(extra="forbid")

    path: str = Field(description="Destination path for metrics output.")

model_config = ConfigDict(extra='forbid') class-attribute instance-attribute

path: str = Field(description='Destination path for metrics output.') class-attribute instance-attribute

ParquetOutputConfig

Bases: BaseModel

Configuration for the Parquet output writer.

Attributes:

Name Type Description
path_pattern str

Output file path format string.
columns list[str]

Columns to include in output.
exclude list[str]

Columns to exclude from output.
storage bool | dict[str, Any] | None

Optional storage configuration (bool or dict).
Source code in packages/dqm-ml-core/src/dqm_ml_core/models/outputs.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class ParquetOutputConfig(BaseModel):
    """Configuration for the Parquet output writer.

    Attributes:
        path_pattern: Output file path format string.
        columns: Columns to include in output.
        exclude: Columns to exclude from output.
        storage: Optional storage configuration (bool or dict).
    """

    model_config = ConfigDict(extra="forbid")

    path_pattern: str = Field(description="Output file path format string.")
    columns: list[str] = Field(default_factory=list, description="Columns to include in output.")
    exclude: list[str] = Field(default_factory=list, description="Columns to exclude from output.")
    storage: bool | dict[str, Any] | None = Field(
        default=None,
        description="Storage configuration (bool or dict with S3 settings).",
    )

columns: list[str] = Field(default_factory=list, description='Columns to include in output.') class-attribute instance-attribute

exclude: list[str] = Field(default_factory=list, description='Columns to exclude from output.') class-attribute instance-attribute

model_config = ConfigDict(extra='forbid') class-attribute instance-attribute

path_pattern: str = Field(description='Output file path format string.') class-attribute instance-attribute

storage: bool | dict[str, Any] | None = Field(default=None, description='Storage configuration (bool or dict with S3 settings).') class-attribute instance-attribute