[ml] Fix apiview 1.10.0 comments, round 2 (Azure#31917)

* Re-introduce ivars for Signals classes

* Move docstring from class level to constructor level

* Reintroduce ivars for SystemData class

Author: diondrapeck

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_inputs_outputs/output.py

@@ -18,50 +18,50 @@
 
 
 class Output(_InputOutputBase):
-    """Define an output.
-
-    :keyword type: The type of the data output. Accepted values are 'uri_folder', 'uri_file', 'mltable', 'mlflow_model',
-        'custom_model', and user-defined types. Defaults to 'uri_folder'.
-    :paramtype type: str
-    :keyword path: The remote path where the output should be stored.
-    :paramtype path: Optional[str]
-    :keyword mode: The access mode of the data output. Accepted values are
-        * 'rw_mount': Read-write mount the data
-        * 'upload': Upload the data from the compute target
-        * 'direct': Pass in the URI as a string
-    :paramtype mode: Optional[str]
-    :keyword description: The description of the output.
-    :paramtype description: Optional[str]
-    :keyword name: The name to be used to register the output as a Data or Model asset. A name can be set without
-        setting a version.
-    :paramtype name: str
-    :keyword version: The version used to register the output as a Data or Model asset. A version can be set only
-        when name is set.
-    :paramtype version: str
-    :keyword is_control: Determine if the output is a control output.
-    :paramtype is_control: bool
-    :keyword early_available: Mark the output for early node orchestration.
-    :paramtype early_available: bool
-    :keyword intellectual_property: Intellectual property associated with the output.
-        It can be an instance of `IntellectualProperty` or a dictionary that will be used to create an instance.
-    :paramtype intellectual_property: Union[~azure.ai.ml.entities._assets.intellectual_property.IntellectualProperty,
-        dict]
-
-    .. admonition:: Example:
-
-        .. literalinclude:: ../../../../../samples/ml_samples_misc.py
-            :start-after: [START create_inputs_outputs]
-            :end-before: [END create_inputs_outputs]
-            :language: python
-            :dedent: 8
-            :caption: Creating a CommandJob with a folder output.
-    """
-
     _IO_KEYS = ["name", "version", "path", "type", "mode", "description", "early_available"]
 
     @overload
     def __init__(self, type: Literal["uri_folder"] = "uri_folder", path=None, mode=None, description=None) -> None:
-        """"""
+        # pylint: disable=line-too-long
+        """Define an output.
+
+        :keyword type: The type of the data output. Accepted values are 'uri_folder', 'uri_file', 'mltable',
+            'mlflow_model', 'custom_model', and user-defined types. Defaults to 'uri_folder'.
+        :paramtype type: str
+        :keyword path: The remote path where the output should be stored.
+        :paramtype path: Optional[str]
+        :keyword mode: The access mode of the data output. Accepted values are
+            * 'rw_mount': Read-write mount the data
+            * 'upload': Upload the data from the compute target
+            * 'direct': Pass in the URI as a string
+        :paramtype mode: Optional[str]
+        :keyword description: The description of the output.
+        :paramtype description: Optional[str]
+        :keyword name: The name to be used to register the output as a Data or Model asset. A name can be set without
+            setting a version.
+        :paramtype name: str
+        :keyword version: The version used to register the output as a Data or Model asset. A version can be set only
+            when name is set.
+        :paramtype version: str
+        :keyword is_control: Determine if the output is a control output.
+        :paramtype is_control: bool
+        :keyword early_available: Mark the output for early node orchestration.
+        :paramtype early_available: bool
+        :keyword intellectual_property: Intellectual property associated with the output.
+            It can be an instance of `IntellectualProperty` or a dictionary that will be used to create an instance.
+        :paramtype intellectual_property: Union[~azure.ai.ml.entities._assets.intellectual_property.IntellectualProperty,
+
+            dict]
+
+        .. admonition:: Example:
+
+            .. literalinclude:: ../../../../../samples/ml_samples_misc.py
+                :start-after: [START create_inputs_outputs]
+                :end-before: [END create_inputs_outputs]
+                :language: python
+                :dedent: 8
+                :caption: Creating a CommandJob with a folder output.
+        """
 
     @overload
     def __init__(self, type: Literal["uri_file"] = "uri_file", path=None, mode=None, description=None):

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

@@ -4,63 +4,61 @@
 
 # pylint: disable=protected-access
 
-from typing import Dict, List, Optional, Union
 import datetime
-import isodate
+from typing import Dict, List, Optional, Union
 
+import isodate
 from typing_extensions import Literal
 
-from azure.ai.ml.entities._inputs_outputs import Input
-from azure.ai.ml.entities._mixins import RestTranslatableMixin
-from azure.ai.ml._restclient.v2023_06_01_preview.models import (
-    MonitoringInputDataBase as RestMonitoringInputData,
-)
+from azure.ai.ml._restclient.v2023_06_01_preview.models import AllFeatures as RestAllFeatures
+from azure.ai.ml._restclient.v2023_06_01_preview.models import CustomMonitoringSignal as RestCustomMonitoringSignal
 from azure.ai.ml._restclient.v2023_06_01_preview.models import (
-    MonitoringSignalBase as RestMonitoringSignalBase,
     DataDriftMonitoringSignal as RestMonitoringDataDriftSignal,
 )
 from azure.ai.ml._restclient.v2023_06_01_preview.models import (
     DataQualityMonitoringSignal as RestMonitoringDataQualitySignal,
 )
 from azure.ai.ml._restclient.v2023_06_01_preview.models import (
     FeatureAttributionDriftMonitoringSignal as RestFeatureAttributionDriftMonitoringSignal,
-    ModelPerformanceSignal as RestModelPerformanceSignal,
-    CustomMonitoringSignal as RestCustomMonitoringSignal,
-    MonitoringDataSegment as RestMonitoringDataSegment,
+)
+from azure.ai.ml._restclient.v2023_06_01_preview.models import FeatureSubset as RestFeatureSubset
+from azure.ai.ml._restclient.v2023_06_01_preview.models import ModelPerformanceSignal as RestModelPerformanceSignal
+from azure.ai.ml._restclient.v2023_06_01_preview.models import MonitoringDataSegment as RestMonitoringDataSegment
+from azure.ai.ml._restclient.v2023_06_01_preview.models import (
     MonitoringFeatureFilterBase as RestMonitoringFeatureFilterBase,
 )
+from azure.ai.ml._restclient.v2023_06_01_preview.models import MonitoringInputDataBase as RestMonitoringInputData
 from azure.ai.ml._restclient.v2023_06_01_preview.models import MonitoringNotificationMode
+from azure.ai.ml._restclient.v2023_06_01_preview.models import MonitoringSignalBase as RestMonitoringSignalBase
 from azure.ai.ml._restclient.v2023_06_01_preview.models import MonitoringSignalType
+from azure.ai.ml._restclient.v2023_06_01_preview.models import (
+    MonitoringWorkspaceConnection as RestMonitoringWorkspaceConnection,
+)
 from azure.ai.ml._restclient.v2023_06_01_preview.models import (
     PredictionDriftMonitoringSignal as RestPredictionDriftMonitoringSignal,
 )
 from azure.ai.ml._restclient.v2023_06_01_preview.models import (
     TopNFeaturesByAttribution as RestTopNFeaturesByAttribution,
-    AllFeatures as RestAllFeatures,
-    FeatureSubset as RestFeatureSubset,
-    MonitoringWorkspaceConnection as RestMonitoringWorkspaceConnection,
 )
 from azure.ai.ml._utils._experimental import experimental
 from azure.ai.ml.constants._monitoring import (
-    MonitorSignalType,
     ALL_FEATURES,
-    MonitorModelType,
     MonitorDatasetContext,
     MonitorFeatureDataType,
+    MonitorModelType,
+    MonitorSignalType,
 )
-from azure.ai.ml.entities._monitoring.input_data import (
-    FixedInputData,
-    TrailingInputData,
-    StaticInputData,
-)
+from azure.ai.ml.entities._inputs_outputs import Input
+from azure.ai.ml.entities._mixins import RestTranslatableMixin
+from azure.ai.ml.entities._monitoring.input_data import FixedInputData, StaticInputData, TrailingInputData
 from azure.ai.ml.entities._monitoring.thresholds import (
+    CustomMonitoringMetricThreshold,
     DataDriftMetricThreshold,
     DataQualityMetricThreshold,
-    PredictionDriftMetricThreshold,
     FeatureAttributionDriftMetricThreshold,
     MetricThreshold,
     ModelPerformanceMetricThreshold,
-    CustomMonitoringMetricThreshold,
+    PredictionDriftMetricThreshold,
 )
 
 
@@ -482,6 +480,8 @@ def _get_default_data_drift_signal(cls) -> "DataDriftSignal":
 class PredictionDriftSignal(MonitoringSignal):
     """Prediction drift signal.
 
+    :ivar type: The type of the signal. Set to "prediction_drift" for this class.
+    :vartype type: str
     :keyword baseline_dataset: The dataset to calculate drift against.
     :paramtype baseline_dataset: ~azure.ai.ml.entities.MonitorInputData
     :keyword target_dataset: The dataset for which drift will be calculated.
@@ -546,7 +546,8 @@ def _get_default_prediction_drift_signal(cls) -> "PredictionDriftSignal":
 class DataQualitySignal(DataSignal):
     """Data quality signal
 
-
+    :ivar type: The type of the signal. Set to "data_quality" for this class.
+    :vartype type: str
     :keyword target_dataset: The data for which quality will be calculated.
     :paramtype target_dataset: ~azure.ai.ml.entities.TargetDataset
     :keyword baseline_dataset: The data to calculate quality against.
@@ -714,6 +715,8 @@ def _from_rest_object(cls, obj: RestMonitoringInputData) -> "FADProductionData":
 class FeatureAttributionDriftSignal(RestTranslatableMixin):
     """Feature attribution drift signal
 
+    :ivar type: The type of the signal. Set to "feature_attribution_drift" for this class.
+    :vartype type: str
     :keyword target_dataset: The data for which drift will be calculated.
     :paramtype target_dataset: ~azure.ai.ml.entities.TargetDataset
     :keyword baseline_dataset: The data to calculate drift against.
@@ -861,6 +864,8 @@ def _from_rest_object(cls, obj: RestMonitoringWorkspaceConnection) -> "Workspace
 class CustomMonitoringSignal(RestTranslatableMixin):
     """Custom monitoring signal.
 
+    :ivar type: The type of the signal. Set to "custom" for this class.
+    :vartype type: str
     :keyword input_datasets: A dictionary of input datasets for monitoring.
         Each key is the component input port name, and its value is the data asset.
     :paramtype input_datasets: Optional[dict[str, ~azure.ai.ml.entities.MonitorInputData]]

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

@@ -9,6 +9,20 @@
 class SystemData(RestTranslatableMixin):
     """Metadata related to the creation and most recent modification of a resource.
 
+    :ivar created_by: The identity that created the resource.
+    :vartype created_by: str
+    :ivar created_by_type: The type of identity that created the resource. Possible values include:
+        "User", "Application", "ManagedIdentity", "Key".
+    :vartype created_by_type: str or ~azure.ai.ml.entities.CreatedByType
+    :ivar created_at: The timestamp of resource creation (UTC).
+    :vartype created_at: ~datetime.datetime
+    :ivar last_modified_by: The identity that last modified the resource.
+    :vartype last_modified_by: str
+    :ivar last_modified_by_type: The type of identity that last modified the resource. Possible
+        values include: "User", "Application", "ManagedIdentity", "Key".
+    :vartype last_modified_by_type: str or ~azure.ai.ml.entities.CreatedByType
+    :ivar last_modified_at: The timestamp of resource last modification (UTC).
+    :vartype last_modified_at: ~datetime.datetime
     :keyword created_by: The identity that created the resource.
     :paramtype created_by: str
     :keyword created_by_type: The type of identity that created the resource. Accepted values are