Share via

DataQualitySignal Class

  • Reference

Data quality signal

Constructor

DataQualitySignal(*, production_data: ProductionData | None = None, reference_data: ReferenceData | None = None, features: List[str] | MonitorFeatureFilter | Literal['all_features'] | None = None, feature_type_override: Dict[str, str | MonitorFeatureDataType] | None = None, metric_thresholds: MetricThreshold | List[MetricThreshold] | None = None, alert_enabled: bool = False, properties: Dict[str, str] | None = None)

Parameters

Name Description
production_data
Required

The data for which drift will be calculated
reference_data
Required

The data to calculate drift against
metric_thresholds
Required

Metrics to calculate and their associated thresholds
alert_enabled
Required

Whether or not to enable alerts for the signal. Defaults to False.
feature_type_override
Required

Dictionary of features and what they should be overridden to.
properties
Required

Dictionary of additional properties.

Keyword-Only Parameters

Name Description
features
Union[List[str], MonitorFeatureFilter, Literal['all_features']]

The feature filter identifying which feature(s) to calculate drift over.

Default value: None
production_data
Default value: None
reference_data
Default value: None
feature_type_override
Default value: None
metric_thresholds
Default value: None
alert_enabled
Default value: False
properties
Default value: None

Variables

Name Description
type
str

The type of the signal. Set to "data_quality" for this class.