Skip to content

Commit 8c480ce

Browse files
authored
update alert_enable property explanation in model monitor signals (Azure#39197)
1 parent a6359b6 commit 8c480ce

File tree

1 file changed

+10
-10
lines changed
  • sdk/ml/azure-ai-ml/azure/ai/ml/entities/_monitoring

1 file changed

+10
-10
lines changed

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_monitoring/signals.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ class MonitoringSignal(RestTranslatableMixin):
360360
~azure.ai.ml.entities.GenerationSafetyQualityMonitoringMetricThreshold,
361361
362362
]]]
363-
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to True.
363+
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
364364
:paramtype alert_enabled: bool
365365
"""
366366

@@ -433,7 +433,7 @@ class DataSignal(MonitoringSignal):
433433
~azure.ai.ml.entities.GenerationSafetyQualityMonitoringMetricThreshold,
434434
435435
]]
436-
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to True.
436+
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
437437
:paramtype alert_enabled: bool
438438
"""
439439

@@ -470,7 +470,7 @@ class DataDriftSignal(DataSignal):
470470
:paramtype reference_data: ~azure.ai.ml.entities.ReferenceData
471471
:param metric_thresholds: Metrics to calculate and their associated thresholds
472472
:paramtype metric_thresholds: ~azure.ai.ml.entities.DataDriftMetricThreshold
473-
:param alert_enabled: The current notification mode for this signal
473+
:param alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
474474
:paramtype alert_enabled: bool
475475
:param data_segment: The data segment used for scoping on a subset of the data population.
476476
:paramtype data_segment: ~azure.ai.ml.entities.DataSegment
@@ -573,7 +573,7 @@ class PredictionDriftSignal(MonitoringSignal):
573573
:paramtype reference_data: ~azure.ai.ml.entities.ReferenceData
574574
:param metric_thresholds: Metrics to calculate and their associated thresholds
575575
:paramtype metric_thresholds: ~azure.ai.ml.entities.DataDriftMetricThreshold
576-
:param alert_enabled: The current notification mode for this signal
576+
:param alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
577577
:paramtype alert_enabled: bool
578578
:param properties: Dictionary of additional properties.
579579
:paramtype properties: dict[str, str]
@@ -657,7 +657,7 @@ class DataQualitySignal(DataSignal):
657657
:paramtype reference_data: ~azure.ai.ml.entities.ReferenceData
658658
:param metric_thresholds: Metrics to calculate and their associated thresholds
659659
:paramtype metric_thresholds: ~azure.ai.ml.entities.DataDriftMetricThreshold
660-
:param alert_enabled: The current notification mode for this signal
660+
:param alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
661661
:paramtype alert_enabled: bool
662662
:keyword features: The feature filter identifying which feature(s) to calculate drift over.
663663
:paramtype features: Union[List[str], ~azure.ai.ml.entities.MonitorFeatureFilter, Literal['all_features']]
@@ -840,7 +840,7 @@ class FeatureAttributionDriftSignal(RestTranslatableMixin):
840840
:keyword metric_thresholds: Metrics to calculate and their
841841
associated thresholds.
842842
:paramtype metric_thresholds: ~azure.ai.ml.entities.FeatureAttributionDriftMetricThreshold
843-
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to True.
843+
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
844844
:paramtype alert_enabled: bool
845845
"""
846846

@@ -907,7 +907,7 @@ class ModelPerformanceSignal(RestTranslatableMixin):
907907
:paramtype model_type: ~azure.ai.ml.constants.MonitorModelType
908908
:keyword data_segment: The data segment to calculate performance against.
909909
:paramtype data_segment: ~azure.ai.ml.entities.DataSegment
910-
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to True.
910+
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
911911
:paramtype alert_enabled: bool
912912
"""
913913

@@ -1017,7 +1017,7 @@ class CustomMonitoringSignal(RestTranslatableMixin):
10171017
:paramtype component_id: str
10181018
:keyword connection: Specify connection with environment variables and secret configs.
10191019
:paramtype connection: Optional[~azure.ai.ml.entities.WorkspaceConnection]
1020-
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to True.
1020+
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
10211021
:paramtype alert_enabled: bool
10221022
:keyword properties: A dictionary of custom properties for the signal.
10231023
:paramtype properties: Optional[dict[str, str]]
@@ -1145,7 +1145,7 @@ class GenerationSafetyQualitySignal(RestTranslatableMixin):
11451145
:paramtype input_datasets: Optional[dict[str, ~azure.ai.ml.entities.LlmData]]
11461146
:keyword metric_thresholds: Metrics to calculate and their associated thresholds.
11471147
:paramtype metric_thresholds: ~azure.ai.ml.entities.GenerationSafetyQualityMonitoringMetricThreshold
1148-
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to True.
1148+
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
11491149
:paramtype alert_enabled: bool
11501150
:keyword connection_id: Gets or sets the connection ID used to connect to the
11511151
content generation endpoint.
@@ -1216,7 +1216,7 @@ class GenerationTokenStatisticsSignal(RestTranslatableMixin):
12161216
:paramtype input_dataset: Optional[~azure.ai.ml.entities.LlmData]
12171217
:keyword metric_thresholds: Metrics to calculate and their associated thresholds. Defaults to App Traces
12181218
:paramtype metric_thresholds: Optional[~azure.ai.ml.entities.GenerationTokenStatisticsMonitorMetricThreshold]
1219-
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to True.
1219+
:keyword alert_enabled: Whether or not to enable alerts for the signal. Defaults to False.
12201220
:paramtype alert_enabled: bool
12211221
:keyword properties: The properties of the signal
12221222
:paramtype properties: Optional[Dict[str, str]]

0 commit comments

Comments
 (0)