chore: fix style issues

Author: Sushanth Sathish Kumar

src/sagemaker/dashboard/__init__.py

@@ -21,7 +21,7 @@
 from sagemaker.dashboard.data_quality_dashboard import AutomaticDataQualityDashboard  # noqa: F401
 from sagemaker.dashboard.model_quality_dashboard import AutomaticModelQualityDashboard  # noqa: F401
 from sagemaker.dashboard.dashboard_variables import DashboardVariable  # noqa: F401
-from sagemaker.dashboard.dashboard_widgets import (
-    DashboardWidget, # noqa: F401
-    DashboardWidgetProperties, # noqa: F401
-)  
+from sagemaker.dashboard.dashboard_widgets import (  # noqa: F401
+    DashboardWidget,
+    DashboardWidgetProperties,
+)

src/sagemaker/dashboard/dashboard_variables.py

@@ -14,7 +14,7 @@
 
 These classes assist with creating dashboards in Python3 and then using boto3 CloudWatch client
 to publish the generated dashboards. To be used to aid dashboard creation in ClarifyModelMonitor
-and ModelMonitor. 
+and ModelMonitor.
 """
 from __future__ import absolute_import
 import json
@@ -44,7 +44,7 @@ def __init__(
             inputType (str): Type of input field ('input', 'select', or 'radio') for user interaction.
             variable_id (str): Identifier for the variable, up to 32 characters.
             label (str, optional): Label displayed for the input field (default is None).
-            search (str, optional): Metric search expression to populate input options (required for 'select' or 'radio').
+            search (str, optional): Metric search expression to populate input options.
             populateFrom (str, optional): Dimension name used to populate input options from search results.
         """
         self.variable_type = variable_type

src/sagemaker/dashboard/dashboard_widgets.py

@@ -14,15 +14,14 @@
 
 These classes assist with creating dashboards in Python3 and then using boto3 CloudWatch client
 to publish the generated dashboards. To be used to aid dashboard creation in ClarifyModelMonitor
-and ModelMonitor. 
+and ModelMonitor.
 """
 from __future__ import absolute_import
 import json
 
 
 class DashboardWidgetProperties:
-    """
-    Represents properties of a dashboard widget used for metrics in CloudWatch.
+    """Represents properties of a dashboard widget used for metrics in CloudWatch.
 
     Attributes:
         view (str): Type of visualization ('timeSeries', 'singleValue', 'gauge', 'bar', 'pie', 'table').
@@ -44,8 +43,7 @@ def __init__(
         title=None,
         markdown=None,
     ):
-        """
-        Initializes DashboardWidgetProperties instance.
+        """Initializes DashboardWidgetProperties instance.
 
         Args:
             view (str, optional): Type of visualization ('timeSeries', 'singleValue', 'gauge', 'bar', 'pie', 'table').
@@ -65,8 +63,7 @@ def __init__(
         self.markdown = markdown
 
     def to_dict(self):
-        """
-        Converts DashboardWidgetProperties instance to a dictionary representation.
+        """Converts DashboardWidgetProperties instance to a dictionary representation.
 
         Returns:
             dict: Dictionary containing widget properties suitable for JSON serialization.
@@ -89,8 +86,7 @@ def to_dict(self):
         return widget_properties_dict
 
     def to_json(self):
-        """
-        Converts DashboardWidgetProperties instance to a JSON string.
+        """Converts DashboardWidgetProperties instance to a JSON string.
 
         Returns:
             str: JSON string representation of the widget properties.
@@ -99,8 +95,7 @@ def to_json(self):
 
 
 class DashboardWidget:
-    """
-    Represents a widget in a CloudWatch dashboard.
+    """Represents a widget in a CloudWatch dashboard.
 
     Attributes:
         height (int): Height of the widget.
@@ -110,8 +105,7 @@ class DashboardWidget:
     """
 
     def __init__(self, height, width, widget_type, properties=None):
-        """
-        Initializes DashboardWidget instance.
+        """Initializes DashboardWidget instance.
 
         Args:
             height (int): Height of the widget.
@@ -129,8 +123,7 @@ def __init__(self, height, width, widget_type, properties=None):
         )
 
     def to_dict(self):
-        """
-        Converts DashboardWidget instance to a dictionary representation.
+        """Converts DashboardWidget instance to a dictionary representation.
 
         Returns:
             dict: Dictionary containing widget attributes suitable for JSON serialization.
@@ -143,8 +136,7 @@ def to_dict(self):
         }
 
     def to_json(self):
-        """
-        Converts DashboardWidget instance to a JSON string.
+        """Converts DashboardWidget instance to a JSON string.
 
         Returns:
             str: JSON string representation of the widget attributes.

src/sagemaker/dashboard/data_quality_dashboard.py

@@ -10,9 +10,9 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""This module the wrapper class for data quality dashboard. 
+"""This module the wrapper class for data quality dashboard.
 
-To be used to aid dashboard creation in ModelMonitor. 
+To be used to aid dashboard creation in ModelMonitor.
 """
 from __future__ import absolute_import
 

src/sagemaker/dashboard/model_quality_dashboard.py

@@ -1,3 +1,20 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""This module the wrapper class for model quality dashboard.
+
+To be used to aid dashboard creation in ModelMonitor.
+"""
+
 from __future__ import absolute_import
 import json
 from sagemaker.dashboard.dashboard_widgets import DashboardWidget, DashboardWidgetProperties
@@ -6,13 +23,6 @@
 class AutomaticModelQualityDashboard:
     """Represents a dashboard for automatic model quality metrics in Amazon SageMaker.
 
-    Attributes:
-        MODEL_QUALITY_METRICS_ENDPOINT_NAMESPACE (str): Namespace for model metrics at endpoint level.
-        MODEL_QUALITY_METRICS_BATCH_NAMESPACE (str): Namespace for model metrics at batch transform level.
-        REGRESSION_MODEL_QUALITY_METRICS (list): List of regression model quality metrics and their graphs.
-        BINARY_CLASSIFICATION_MODEL_QUALITY_METRICS (list): List of binary classification model quality metrics and their graphs.
-        MULTICLASS_CLASSIFICATION_MODEL_QUALITY_METRICS (list): List of multiclass classification model quality metrics and their graphs.
-
     Methods:
         __init__(self, endpoint_name, monitoring_schedule_name, batch_transform_input, problem_type, region_name):
             Initializes an AutomaticModelQualityDashboard instance.
@@ -134,7 +144,8 @@ def _generate_widgets(self):
             )
         else:
             raise ValueError(
-                "Parameter problem_type is invalid. Valid options are Regression, BinaryClassification, or MulticlassClassification."
+                "Parameter problem_type is invalid. Valid options are "
+                "Regression, BinaryClassification, or MulticlassClassification."
             )
 
         for graphs_per_line in metrics_to_graph:
@@ -150,10 +161,10 @@ def _generate_widgets(self):
                             [
                                 {
                                     "expression": (
-                                        f"SEARCH( '{AutomaticModelQualityDashboard.MODEL_QUALITY_METRICS_BATCH_NAMESPACE} "
+                                        f"SEARCH( '{self.MODEL_QUALITY_METRICS_BATCH_NAMESPACE} "
                                         f"{metrics_string} "
                                         f'MonitoringSchedule="{self.monitoring_schedule}" \', '
-                                        f"'Average')"
+                                        "'Average')"
                                     )
                                 }
                             ]
@@ -169,7 +180,7 @@ def _generate_widgets(self):
                             [
                                 {
                                     "expression": (
-                                        f"SEARCH( '{AutomaticModelQualityDashboard.MODEL_QUALITY_METRICS_ENDPOINT_NAMESPACE} "
+                                        f"SEARCH( '{self.MODEL_QUALITY_METRICS_ENDPOINT_NAMESPACE} "
                                         f"{metrics_string} "
                                         f'Endpoint="{self.endpoint}" '
                                         f'MonitoringSchedule="{self.monitoring_schedule}" \', '

src/sagemaker/model_monitor/model_monitoring.py

@@ -1546,8 +1546,7 @@ def _check_dashboard_validity_without_checking_in_use(
         enable_automatic_dashboard=False,
         dashboard_name=None,
     ):
-        """Checks if the parameters provided to generate an automatic dashboard are valid,
-        but does not check if the dashboard is already in use.
+        """Checks if the parameters are valid, without checking if dashboard name is taken
 
         Args:
             monitor_schedule_name (str): Monitoring schedule name.
@@ -1610,11 +1609,11 @@ def _check_automatic_dashboard_validity(
             enable_automatic_dashboard=enable_automatic_dashboard,
             dashboard_name=dashboard_name,
         )
+        cw_client = self.sagemaker_session.boto_session.client("cloudwatch")
 
         if enable_automatic_dashboard:
             try:
                 # try to access the dashboard to see if it exists already
-                cw_client = self.sagemaker_session.boto_session.client("cloudwatch")
                 cw_client.get_dashboard(DashboardName=dashboard_name)
                 message = (
                     f"Dashboard name {dashboard_name} is already in use. "
@@ -1623,11 +1622,11 @@ def _check_automatic_dashboard_validity(
                 )
                 _LOGGER.error(message)
                 raise ValueError(message)
-            except Exception as _:
+            except Exception as e:
+                _LOGGER.log(f"Correctly received error {e}.")
                 # in this case, the dashboard name is not in use
                 # and we are free to write to it without overwriting any
                 # customer data.
-                pass
 
     def _create_monitoring_schedule_from_job_definition(
         self,