meridian.model.eda.eda_outcome.EDAOutcome

A dataclass for the outcomes of a single EDA check function.

meridian.model.eda.eda_outcome.EDAOutcome(
    check_type: meridian.model.eda.eda_outcome.EDACheckType,
    findings: list[EDAFinding],
    analysis_artifacts: list[ArtifactType]
)

An EDA check function can discover multiple issues. This object groups all of those individual issues, reported as a list of EDAFinding objects.

Attributes
check_type	The type of the EDA check that is being performed.
findings	A list of all individual issues discovered by the check.
analysis_artifacts	A list of analysis artifacts from the EDA check.

Methods

get_findings_by_cause_and_severity

View source

get_findings_by_cause_and_severity(
    finding_cause: meridian.model.eda.eda_outcome.FindingCause,
    severity: meridian.model.eda.eda_outcome.EDASeverity
) -> Sequence[meridian.model.eda.eda_outcome.EDAFinding]

Helper method to retrieve findings by cause and severity.

get_geo_artifacts

View source

get_geo_artifacts() -> list[ArtifactType]

Returns the geo-level analysis artifacts.

Returns a list to account for checks that produce multiple artifacts at the same level (e.g. Standard Deviation check).

get_national_artifacts

View source

get_national_artifacts() -> list[ArtifactType]

Returns the national-level analysis artifacts.

Returns a list to account for checks that produce multiple artifacts at the same level.

get_overall_artifacts

View source

get_overall_artifacts() -> list[ArtifactType]

Returns the overall-level analysis artifacts.

Returns a list to account for checks that produce multiple artifacts at the same level.

__eq__

__eq__(
    other
)

Return self==value.