[ML] Add MoMo Docstrings and Make Models/Consts Public (Azure#30242)

* add docstrings for monitoring classes

* make models public

* fix model performance

* black

* fix imports

Author: needuv

sdk/ml/azure-ai-ml/azure/ai/ml/_schema/monitoring/monitor_definition.py

@@ -13,7 +13,6 @@
     DataQualitySignalSchema,
     PredictionDriftSignalSchema,
     FeatureAttributionDriftSignalSchema,
-    ModelPerformanceSignalSchema,
     CustomMonitoringSignalSchema,
 )
 from azure.ai.ml._schema.monitoring.alert_notification import AlertNotificationSchema
@@ -32,7 +31,6 @@ class MonitorDefinitionSchema(metaclass=PatchedSchemaMeta):
                 NestedField(DataQualitySignalSchema),
                 NestedField(PredictionDriftSignalSchema),
                 NestedField(FeatureAttributionDriftSignalSchema),
-                NestedField(ModelPerformanceSignalSchema),
                 NestedField(CustomMonitoringSignalSchema),
             ]
         ),

sdk/ml/azure-ai-ml/azure/ai/ml/constants/__init__.py

@@ -21,6 +21,13 @@
 )
 from ._registry import AcrAccountSku, StorageAccountType
 from ._workspace import ManagedServiceIdentityType
+from ._monitoring import (
+    MonitorSignalType,
+    MonitorMetricName,
+    MonitorModelType,
+    MonitorFeatureType,
+    MonitorDatasetContext,
+)
 
 TabularTrainingMode.__module__ = __name__
 
@@ -44,4 +51,9 @@
     "NlpLearningRateScheduler",
     "Scope",
     "TabularTrainingMode",
+    "MonitorSignalType",
+    "MonitorMetricName",
+    "MonitorModelType",
+    "MonitorFeatureType",
+    "MonitorDatasetContext",
 ]

sdk/ml/azure-ai-ml/azure/ai/ml/constants/_monitoring.py

@@ -6,13 +6,16 @@
 
 from azure.core import CaseInsensitiveEnumMeta
 
+from azure.ai.ml._utils._experimental import experimental
+
 
 ALL_FEATURES = "all_features"
 
 
 AZMONITORING = "azmonitoring"
 
 
+@experimental
 class MonitorSignalType(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     DATA_DRIFT = "data_drift"
     DATA_QUALITY = "data_quality"
@@ -22,6 +25,7 @@ class MonitorSignalType(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     CUSTOM = "custom"
 
 
+@experimental
 class MonitorMetricName(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     JENSEN_SHANNON_DISTANCE = "jensen_shannon_distance"
     NORMALIZED_WASSERSTEIN_DISTANCE = "normalized_wasserstein_distance"
@@ -41,18 +45,21 @@ class MonitorMetricName(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     RMSE = "RMSE"
 
 
+@experimental
 class MonitorModelType(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     CLASSIFICATION = "classification"
     REGRESSION = "regression"
 
 
+@experimental
 class MonitorFeatureType(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     NUMERICAL = "numerical"
     CATEGORICAL = "categorical"
     NOT_APPLICABLE = "not_applicable"
     ALL_FEATURE_TYPES = "all_feature_types"
 
 
+@experimental
 class MonitorDatasetContext(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     MODEL_INPUTS = "model_inputs"
     MODEL_OUTPUTS = "model_outputs"

sdk/ml/azure-ai-ml/azure/ai/ml/entities/__init__.py

@@ -156,6 +156,28 @@
     PackageInputPathUrl,
     PackageInputPathVersion,
 )
+from ._monitoring.alert_notification import AlertNotification
+from ._monitoring.definition import MonitorDefinition
+from ._monitoring.input_data import MonitorInputData
+from ._monitoring.schedule import MonitorSchedule
+from ._monitoring.signals import (
+    DataDriftSignal,
+    DataQualitySignal,
+    PredictionDriftSignal,
+    FeatureAttributionDriftSignal,
+    CustomMonitoringSignal,
+    TargetDataset,
+    MonitorFeatureFilter,
+    DataSegment,
+)
+from ._monitoring.target import MonitoringTarget
+from ._monitoring.thresholds import (
+    DataDriftMetricThreshold,
+    DataQualityMetricThreshold,
+    PredictionDriftMetricThreshold,
+    FeatureAttributionDriftMetricThreshold,
+    CustomMonitoringMetricThreshold,
+)
 
 
 from ._assets._artifacts.feature_set import FeatureSet
@@ -360,4 +382,22 @@
     "PackageInputPathVersion",
     "Route",
     "AccessKeyConfiguration",
+    "AlertNotification",
+    "MonitorDefinition",
+    "MonitorInputData",
+    "MonitorSchedule",
+    "DataDriftSignal",
+    "DataQualitySignal",
+    "PredictionDriftSignal",
+    "FeatureAttributionDriftSignal",
+    "CustomMonitoringSignal",
+    "TargetDataset",
+    "MonitorFeatureFilter",
+    "DataSegment",
+    "MonitoringTarget",
+    "DataDriftMetricThreshold",
+    "DataQualityMetricThreshold",
+    "PredictionDriftMetricThreshold",
+    "FeatureAttributionDriftMetricThreshold",
+    "CustomMonitoringMetricThreshold",
 ]

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

@@ -14,6 +14,12 @@
 
 @experimental
 class AlertNotification(RestTranslatableMixin):
+    """Alert notification configuration for monitoring jobs
+
+    :param emails: A list of emails that will receive notifications for monitoring alerts
+    :type emails: List[str]
+    """
+
     def __init__(
         self,
         *,

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

@@ -16,7 +16,6 @@
     DataQualitySignal,
     PredictionDriftSignal,
     FeatureAttributionDriftSignal,
-    ModelPerformanceSignal,
     CustomMonitoringSignal,
 )
 from azure.ai.ml.entities._mixins import RestTranslatableMixin
@@ -30,6 +29,21 @@
 
 @experimental
 class MonitorDefinition(RestTranslatableMixin):
+    """Monitor definition
+
+    :param compute: Information on compute resources associated with the monitor
+    :type compute: str
+    :param monitoring_target: Metadata describing the model or deployment that is being monitored
+    :type monitoring_target: ~azure.ai.ml.entities.MonitoringTarget
+    :param monitoring_signals: Dictionary of signals to monitor
+    :type monitoring_signals: Dict[str, Union[~azure.ai.ml.entities.DataDriftSignal
+        , ~azure.ai.ml.entities.DataQualitySignal, ~azure.ai.ml.entities.PredictionDriftSignal
+        , ~azure.ai.ml.entities.FeatureAttributionDriftSignal
+        , ~azure.ai.ml.entities.CustomMonitoringSignal]]
+    :param alert_notification: Alert configuration for the monitor
+    :type alert_notification: Union[Literal['azmonitoring'], ~azure.ai.ml.entities.AlertNotification]
+    """
+
     def __init__(
         self,
         *,
@@ -42,7 +56,6 @@ def __init__(
                 DataQualitySignal,
                 PredictionDriftSignal,
                 FeatureAttributionDriftSignal,
-                ModelPerformanceSignal,
                 CustomMonitoringSignal,
             ],
         ] = None,

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

@@ -13,6 +13,21 @@
 
 @experimental
 class MonitorInputData(RestTranslatableMixin):
+    """Monitor input data
+
+    :param input_dataset: Input data used by the monitor
+    :type input_dataset: ~azure.ai.ml.entities.Input
+    :param dataset_context: The context of the input dataset. Possible values
+        include: model_inputs, model_outputs, training, test, validation,
+        ground_truth
+    :type dataset_context: str or ~azure.ai.ml.constants.MonitorDatasetContext
+    :param target_column_name: The target column in the given input dataset to leverage
+    :type target_column_name: str
+    :param pre_processing_component: ARM resource ID of the component resource used to
+        preprocess the data.
+    :type pre_processing_component: str
+    """
+
     def __init__(
         self,
         *,

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

@@ -28,6 +28,25 @@
 
 @experimental
 class MonitorSchedule(Schedule, RestTranslatableMixin):
+    """Monitor schedule
+
+    :param name: Name of the schedule.
+    :type name: str
+    :param trigger: Trigger of the schedule.
+    :type trigger: Union[~azure.ai.ml.entities.CronTrigger
+        , ~azure.ai.ml.entities.RecurrenceTrigger]
+    :param create_monitor: The schedule action monitor definition
+    :type create_monitor: ~azure.ai.ml.entities.MonitorDefinition
+    :param display_name: Display name of the schedule.
+    :type display_name: str
+    :param description: Description of the schedule, defaults to None
+    :type description: str
+    :param tags: Tag dictionary. Tags can be added, removed, and updated.
+    :type tags: dict[str, str]
+    :param properties: The job property dictionary.
+    :type properties: dict[str, str]
+    """
+
     def __init__(
         self,
         *,