Share via

CustomMonitoringSignal Class

  • Reference

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Custom monitoring signal.

Inheritance
azure.ai.ml.entities._mixins.RestTranslatableMixin
CustomMonitoringSignal

Constructor

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)

Keyword-Only Parameters

Name Description
input_data
Optional[dict[str, ReferenceData]]

A dictionary of input datasets for monitoring. Each key is the component input port name, and its value is the data asset.
metric_thresholds
List[CustomMonitoringMetricThreshold]

A list of metrics to calculate and their associated thresholds.
inputs
Optional[dict[str, <xref:azure.ai.ml.entities.Input>]]
component_id
str

The ARM (Azure Resource Manager) ID of the component resource used to calculate the custom metrics.
connection
Optional[WorkspaceConnection]

Specify connection with environment variables and secret configs.
alert_enabled
bool

Whether or not to enable alerts for the signal. Defaults to True.
properties
Optional[dict[str, str]]

A dictionary of custom properties for the signal.

Variables

Name Description
type
str

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