-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.ai.ml.entities.DataDriftSignal.yml
63 lines (63 loc) · 2.28 KB
/
azure.ai.ml.entities.DataDriftSignal.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
### YamlMime:PythonClass
uid: azure.ai.ml.entities.DataDriftSignal
name: DataDriftSignal
fullName: azure.ai.ml.entities.DataDriftSignal
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._monitoring.signals.DataSignal
summary: Data drift signal.
constructor:
syntax: 'DataDriftSignal(*, 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: DataDriftMetricThreshold | List[MetricThreshold]
| None = None, alert_enabled: bool = False, data_segment: DataSegment | None =
None, properties: Dict[str, str] | None = None)'
parameters:
- name: production_data
description: The data for which drift will be calculated
isRequired: true
- name: reference_data
description: The data to calculate drift against
isRequired: true
- name: metric_thresholds
description: Metrics to calculate and their associated thresholds
isRequired: true
- name: alert_enabled
description: The current notification mode for this signal
isRequired: true
- name: data_segment
description: The data segment used for scoping on a subset of the data population.
isRequired: true
- name: feature_type_override
description: Dictionary of features and what they should be overridden to.
isRequired: true
- name: properties
description: Dictionary of additional properties.
isRequired: true
keywordOnlyParameters:
- name: features
description: The feature filter identifying which feature(s) to calculate drift
over.
types:
- <xref:typing.Union>[<xref:typing.List>[<xref:str>], <xref:azure.ai.ml.entities.MonitorFeatureFilter>,
<xref:typing.Literal>['all_features']]
- name: production_data
isRequired: true
- name: reference_data
isRequired: true
- name: feature_type_override
isRequired: true
- name: metric_thresholds
isRequired: true
- name: alert_enabled
isRequired: true
- name: data_segment
isRequired: true
- name: properties
isRequired: true
variables:
- description: The type of the signal, set to "data_drift" for this class.
name: type
types:
- <xref:str>