-
Notifications
You must be signed in to change notification settings - Fork 234
/
azure.ai.ml.entities.CustomMonitoringSignal.yml
61 lines (54 loc) · 2.2 KB
/
azure.ai.ml.entities.CustomMonitoringSignal.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
### YamlMime:PythonClass
uid: azure.ai.ml.entities.CustomMonitoringSignal
name: CustomMonitoringSignal
fullName: azure.ai.ml.entities.CustomMonitoringSignal
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._mixins.RestTranslatableMixin
summary: '> [!NOTE]
> This is an experimental class, and may change at any time. Please see [https://aka.ms/azuremlexperimental](https://aka.ms/azuremlexperimental)
for more information.
>
Custom monitoring signal.'
constructor:
syntax: 'CustomMonitoringSignal(*, inputs: Dict[str, Input] | None = None, metric_thresholds:
List[CustomMonitoringMetricThreshold], component_id: str, connection: Connection
| None = None, input_data: Dict[str, ReferenceData] | None = None, alert_enabled:
bool = False, properties: Dict[str, str] | None = None)'
keywordOnlyParameters:
- name: input_data
description: 'A dictionary of input datasets for monitoring.
Each key is the component input port name, and its value is the data asset.'
types:
- <xref:typing.Optional>[<xref:dict>[<xref:str>, <xref:azure.ai.ml.entities.ReferenceData>]]
- name: metric_thresholds
description: 'A list of metrics to calculate and their
associated thresholds.'
types:
- <xref:typing.List>[<xref:azure.ai.ml.entities.CustomMonitoringMetricThreshold>]
- name: inputs
types:
- <xref:typing.Optional>[<xref:dict>[<xref:str>, <xref:azure.ai.ml.entities.Input>]]
- name: component_id
description: 'The ARM (Azure Resource Manager) ID of the component resource used
to
calculate the custom metrics.'
types:
- <xref:str>
- name: connection
description: Specify connection with environment variables and secret configs.
types:
- <xref:typing.Optional>[<xref:azure.ai.ml.entities.WorkspaceConnection>]
- name: alert_enabled
description: Whether or not to enable alerts for the signal. Defaults to True.
types:
- <xref:bool>
- name: properties
description: A dictionary of custom properties for the signal.
types:
- <xref:typing.Optional>[<xref:dict>[<xref:str>, <xref:str>]]
variables:
- description: The type of the signal. Set to "custom" for this class.
name: type
types:
- <xref:str>