Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix missing test objects fields #735

Merged
merged 4 commits into from
Aug 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/evidently/metrics/data_drift/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
from evidently.base_metric import MetricResult
from evidently.calculations.stattests import PossibleStatTestType
from evidently.options import DataDriftOptions
from evidently.pydantic_utils import FrozenBaseModel

T = TypeVar("T", bound=MetricResult)


class WithDriftOptions(Metric[T], Generic[T], abc.ABC):
_drift_options: DataDriftOptions
class WithDriftOptionsFields(FrozenBaseModel):
# todo: fields here are not consistent with DriftOptions, so no common base model
stattest: Optional[PossibleStatTestType] = None
cat_stattest: Optional[PossibleStatTestType] = None
Expand All @@ -27,6 +27,10 @@ class WithDriftOptions(Metric[T], Generic[T], abc.ABC):
text_stattest_threshold: Optional[float] = None
per_column_stattest_threshold: Optional[Dict[str, float]] = None


class WithDriftOptions(WithDriftOptionsFields, Metric[T], Generic[T], abc.ABC):
_drift_options: DataDriftOptions

@property
def drift_options(self):
return self._drift_options
27 changes: 20 additions & 7 deletions src/evidently/tests/data_drift_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from evidently.metrics import ColumnDriftMetric
from evidently.metrics import DataDriftTable
from evidently.metrics import EmbeddingsDriftMetric
from evidently.metrics.data_drift.base import WithDriftOptionsFields
from evidently.metrics.data_drift.data_drift_table import DataDriftTableResults
from evidently.metrics.data_drift.embedding_drift_methods import DriftMethod
from evidently.model.widget import BaseWidgetInfo
Expand Down Expand Up @@ -91,9 +92,10 @@ def to_dataframe(self) -> pd.DataFrame:
)


class BaseDataDriftMetricsTest(BaseCheckValueTest, ABC):
class BaseDataDriftMetricsTest(BaseCheckValueTest, WithDriftOptionsFields, ABC):
group: ClassVar = DATA_DRIFT_GROUP.id
_metric: DataDriftTable
columns: Optional[List[str]]

def __init__(
self,
Expand Down Expand Up @@ -128,8 +130,6 @@ def __init__(
not_eq=not_eq,
not_in=not_in,
is_critical=is_critical,
)
self._metric = DataDriftTable(
columns=columns,
stattest=stattest,
cat_stattest=cat_stattest,
Expand All @@ -142,6 +142,19 @@ def __init__(
text_stattest_threshold=text_stattest_threshold,
per_column_stattest_threshold=per_column_stattest_threshold,
)
self._metric = DataDriftTable(
columns=self.columns,
stattest=self.stattest,
cat_stattest=self.cat_stattest,
num_stattest=self.num_stattest,
text_stattest=self.text_stattest,
per_column_stattest=self.per_column_stattest,
stattest_threshold=self.stattest_threshold,
cat_stattest_threshold=self.cat_stattest_threshold,
num_stattest_threshold=self.num_stattest_threshold,
text_stattest_threshold=self.text_stattest_threshold,
per_column_stattest_threshold=self.per_column_stattest_threshold,
)

@property
def metric(self):
Expand Down Expand Up @@ -220,12 +233,12 @@ def __init__(
self.stattest = stattest
self.stattest_threshold = stattest_threshold

super().__init__(is_critical=is_critical)
self._metric = ColumnDriftMetric(
column_name=column_name,
stattest=stattest,
stattest_threshold=stattest_threshold,
column_name=self.column_name,
stattest=self.stattest,
stattest_threshold=self.stattest_threshold,
)
super().__init__(is_critical=is_critical)

@property
def metric(self):
Expand Down
14 changes: 11 additions & 3 deletions src/evidently/tests/data_integrity_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ def get_description(self, value: Numeric) -> str:
class BaseIntegrityMissingValuesValuesTest(ConditionFromReferenceMixin[DatasetMissingValues], ABC):
group: ClassVar = DATA_INTEGRITY_GROUP.id
_metric: DatasetMissingValuesMetric
missing_values: Optional[list] = None
replace: bool = True

def __init__(
self,
Expand All @@ -147,6 +149,8 @@ def __init__(
not_in: Optional[List[Union[Numeric, str, bool]]] = None,
is_critical: bool = True,
):
self.missing_values = missing_values
self.replace = replace
super().__init__(
eq=eq,
gt=gt,
Expand All @@ -158,7 +162,7 @@ def __init__(
not_in=not_in,
is_critical=is_critical,
)
self._metric = DatasetMissingValuesMetric(missing_values=missing_values, replace=replace)
self._metric = DatasetMissingValuesMetric(missing_values=self.missing_values, replace=self.replace)


class BaseTestMissingValuesRenderer(TestRenderer):
Expand Down Expand Up @@ -455,6 +459,8 @@ class BaseIntegrityColumnMissingValuesTest(ConditionFromReferenceMixin[DatasetMi
group: ClassVar = DATA_INTEGRITY_GROUP.id
_metric: DatasetMissingValuesMetric
column_name: str
missing_values: Optional[List] = None
replace: bool = True

def __init__(
self,
Expand All @@ -472,6 +478,8 @@ def __init__(
is_critical: bool = True,
):
self.column_name = column_name
self.missing_values = missing_values
self.replace = replace
super().__init__(
eq=eq,
gt=gt,
Expand All @@ -483,7 +491,7 @@ def __init__(
not_in=not_in,
is_critical=is_critical,
)
self._metric = DatasetMissingValuesMetric(missing_values=missing_values, replace=replace)
self._metric = DatasetMissingValuesMetric(missing_values=self.missing_values, replace=self.replace)


class TestColumnNumberOfDifferentMissingValues(BaseIntegrityColumnMissingValuesTest):
Expand Down Expand Up @@ -1025,7 +1033,7 @@ def __init__(
not_in=not_in,
is_critical=is_critical,
)
self._metric = ColumnRegExpMetric(column_name=column_name, reg_exp=reg_exp)
self._metric = ColumnRegExpMetric(column_name=self.column_name, reg_exp=self.reg_exp)

@property
def metric(self):
Expand Down
16 changes: 8 additions & 8 deletions src/evidently/tests/data_quality_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ def __init__(
column_name=ColumnName.from_any(column_name),
is_critical=is_critical,
)
self._metric = ColumnSummaryMetric(column_name)
self._metric = ColumnSummaryMetric(self.column_name)


class TestConflictTarget(Test):
Expand Down Expand Up @@ -834,8 +834,8 @@ class TestMeanInNSigmas(Test):
def __init__(self, column_name: Union[str, ColumnName], n_sigmas: int = 2, is_critical: bool = True):
self.column_name = ColumnName.from_any(column_name)
self.n_sigmas = n_sigmas
self._metric = ColumnSummaryMetric(column_name)
super().__init__(is_critical=is_critical)
self._metric = ColumnSummaryMetric(self.column_name)

@property
def metric(self):
Expand Down Expand Up @@ -979,7 +979,7 @@ def __init__(
self.left = left
self.right = right
super().__init__(is_critical=is_critical)
self._metric = ColumnValueRangeMetric(column_name=self.column_name, left=left, right=right)
self._metric = ColumnValueRangeMetric(column_name=self.column_name, left=self.left, right=self.right)

@property
def metric(self):
Expand Down Expand Up @@ -1059,7 +1059,6 @@ def __init__(
self.column_name = ColumnName.from_any(column_name)
self.left = left
self.right = right
self._metric = ColumnValueRangeMetric(column_name=column_name, left=left, right=right)

super().__init__(
eq=eq,
Expand All @@ -1072,6 +1071,7 @@ def __init__(
not_in=not_in,
is_critical=is_critical,
)
self._metric = ColumnValueRangeMetric(column_name=self.column_name, left=self.left, right=self.right)

def groups(self) -> Dict[str, str]:
return {GroupingTypes.ByFeature.id: self.column_name.display_name}
Expand Down Expand Up @@ -1190,8 +1190,8 @@ class TestValueList(Test):
def __init__(self, column_name: str, values: Optional[list] = None, is_critical: bool = True):
self.column_name = column_name
self.values = values
self._metric = ColumnValueListMetric(column_name=column_name, values=values)
super().__init__(is_critical=is_critical)
self._metric = ColumnValueListMetric(column_name=self.column_name, values=values)

@property
def metric(self):
Expand Down Expand Up @@ -1254,7 +1254,7 @@ def __init__(
not_in=not_in,
is_critical=is_critical,
)
self._metric = ColumnValueListMetric(column_name=column_name, values=values)
self._metric = ColumnValueListMetric(column_name=self.column_name, values=self.values)

@property
def metric(self):
Expand Down Expand Up @@ -1362,7 +1362,7 @@ def __init__(
not_in=not_in,
is_critical=is_critical,
)
self._metric = ColumnQuantileMetric(column_name=column_name, quantile=quantile)
self._metric = ColumnQuantileMetric(column_name=self.column_name, quantile=self.quantile)

@property
def metric(self):
Expand Down Expand Up @@ -1483,7 +1483,7 @@ def __init__(
not_in=not_in,
is_critical=is_critical,
)
self._metric = ColumnCategoryMetric(column_name=column_name, category=category)
self._metric = ColumnCategoryMetric(column_name=self.column_name, category=self.category)

@property
def metric(self):
Expand Down