sagemaker-core 1.0.62__py3-none-any.whl → 2.1.1__py3-none-any.whl

sagemaker/core/model_life_cycle.py

@@ -0,0 +1,51 @@
+# 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 file contains code related to model life cycle."""
+from __future__ import absolute_import
+
+from typing import Optional, Union
+
+from sagemaker.core.helper.pipeline_variable import PipelineVariable
+
+
+class ModelLifeCycle(object):
+    """Accepts ModelLifeCycle parameters for conversion to request dict."""
+
+    def __init__(
+        self,
+        stage: Optional[Union[str, PipelineVariable]] = None,
+        stage_status: Optional[Union[str, PipelineVariable]] = None,
+        stage_description: Optional[Union[str, PipelineVariable]] = None,
+    ):
+        """Initialize a ``ModelLifeCycle`` instance and turn parameters into dict.
+
+        # TODO: flesh out docstrings
+        Args:
+            stage (str or PipelineVariable):
+            stage_status (str or PipelineVariable):
+            stage_description (str or PipelineVariable):
+        """
+        self.stage = stage
+        self.stage_status = stage_status
+        self.stage_description = stage_description
+
+    def _to_request_dict(self):
+        """Generates a request dictionary using the parameters provided to the class."""
+        model_life_cycle_request = dict()
+        if self.stage:
+            model_life_cycle_request["Stage"] = self.stage
+        if self.stage_status:
+            model_life_cycle_request["StageStatus"] = self.stage_status
+        if self.stage_description:
+            model_life_cycle_request["StageDescription"] = self.stage_description
+        return model_life_cycle_request

sagemaker/core/model_metrics.py

@@ -0,0 +1,160 @@
+# 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 file contains code related to model metrics, including metric source and file source."""
+from __future__ import absolute_import
+
+from typing import Optional, Union
+
+from sagemaker.core.helper.pipeline_variable import PipelineVariable
+
+
+class ModelMetrics(object):
+    """Accepts model metrics parameters for conversion to request dict."""
+
+    def __init__(
+        self,
+        model_statistics: Optional["MetricsSource"] = None,
+        model_constraints: Optional["MetricsSource"] = None,
+        model_data_statistics: Optional["MetricsSource"] = None,
+        model_data_constraints: Optional["MetricsSource"] = None,
+        bias: Optional["MetricsSource"] = None,
+        explainability: Optional["MetricsSource"] = None,
+        bias_pre_training: Optional["MetricsSource"] = None,
+        bias_post_training: Optional["MetricsSource"] = None,
+    ):
+        """Initialize a ``ModelMetrics`` instance and turn parameters into dict.
+
+        Args:
+            model_statistics (MetricsSource): A metric source object that represents
+                model statistics (default: None).
+            model_constraints (MetricsSource): A metric source object that represents
+                model constraints (default: None).
+            model_data_statistics (MetricsSource): A metric source object that represents
+                model data statistics (default: None).
+            model_data_constraints (MetricsSource): A metric source object that represents
+                model data constraints (default: None).
+            bias (MetricsSource): A metric source object that represents bias report
+                (default: None).
+            explainability (MetricsSource): A metric source object that represents
+                explainability report (default: None).
+            bias_pre_training (MetricsSource): A metric source object that represents
+                Pre-training report (default: None).
+            bias_post_training (MetricsSource): A metric source object that represents
+                Post-training report (default: None).
+        """
+        self.model_statistics = model_statistics
+        self.model_constraints = model_constraints
+        self.model_data_statistics = model_data_statistics
+        self.model_data_constraints = model_data_constraints
+        self.bias = bias
+        self.bias_pre_training = bias_pre_training
+        self.bias_post_training = bias_post_training
+        self.explainability = explainability
+
+    def _to_request_dict(self):
+        """Generates a request dictionary using the parameters provided to the class."""
+        model_metrics_request = {}
+
+        model_quality = {}
+        if self.model_statistics is not None:
+            model_quality["Statistics"] = self.model_statistics._to_request_dict()
+        if self.model_constraints is not None:
+            model_quality["Constraints"] = self.model_constraints._to_request_dict()
+        if model_quality:
+            model_metrics_request["ModelQuality"] = model_quality
+
+        model_data_quality = {}
+        if self.model_data_statistics is not None:
+            model_data_quality["Statistics"] = self.model_data_statistics._to_request_dict()
+        if self.model_data_constraints is not None:
+            model_data_quality["Constraints"] = self.model_data_constraints._to_request_dict()
+        if model_data_quality:
+            model_metrics_request["ModelDataQuality"] = model_data_quality
+
+        bias = {}
+        if self.bias is not None:
+            bias["Report"] = self.bias._to_request_dict()
+        if self.bias_pre_training is not None:
+            bias["PreTrainingReport"] = self.bias_pre_training._to_request_dict()
+        if self.bias_post_training is not None:
+            bias["PostTrainingReport"] = self.bias_post_training._to_request_dict()
+        model_metrics_request["Bias"] = bias
+
+        explainability = {}
+        if self.explainability is not None:
+            explainability["Report"] = self.explainability._to_request_dict()
+        model_metrics_request["Explainability"] = explainability
+
+        return model_metrics_request
+
+
+class MetricsSource(object):
+    """Accepts metrics source parameters for conversion to request dict."""
+
+    def __init__(
+        self,
+        content_type: Union[str, PipelineVariable],
+        s3_uri: Union[str, PipelineVariable],
+        content_digest: Optional[Union[str, PipelineVariable]] = None,
+    ):
+        """Initialize a ``MetricsSource`` instance and turn parameters into dict.
+
+        Args:
+            content_type (str or PipelineVariable): Specifies the type of content
+                in S3 URI
+            s3_uri (str or PipelineVariable): The S3 URI of the metric
+            content_digest (str or PipelineVariable): The digest of the metric
+                (default: None)
+        """
+        self.content_type = content_type
+        self.s3_uri = s3_uri
+        self.content_digest = content_digest
+
+    def _to_request_dict(self):
+        """Generates a request dictionary using the parameters provided to the class."""
+        metrics_source_request = {"ContentType": self.content_type, "S3Uri": self.s3_uri}
+        if self.content_digest is not None:
+            metrics_source_request["ContentDigest"] = self.content_digest
+        return metrics_source_request
+
+
+class FileSource(object):
+    """Accepts file source parameters for conversion to request dict."""
+
+    def __init__(
+        self,
+        s3_uri: Union[str, PipelineVariable],
+        content_digest: Optional[Union[str, PipelineVariable]] = None,
+        content_type: Optional[Union[str, PipelineVariable]] = None,
+    ):
+        """Initialize a ``FileSource`` instance and turn parameters into dict.
+
+        Args:
+            s3_uri (str or PipelineVariable): The S3 URI of the metric
+            content_digest (str or PipelineVariable): The digest of the metric
+                (default: None)
+            content_type (str or PipelineVariable): Specifies the type of content
+                in S3 URI (default: None)
+        """
+        self.content_type = content_type
+        self.s3_uri = s3_uri
+        self.content_digest = content_digest
+
+    def _to_request_dict(self):
+        """Generates a request dictionary using the parameters provided to the class."""
+        file_source_request = {"S3Uri": self.s3_uri}
+        if self.content_digest is not None:
+            file_source_request["ContentDigest"] = self.content_digest
+        if self.content_type is not None:
+            file_source_request["ContentType"] = self.content_type
+        return file_source_request

sagemaker/core/model_monitor/__init__.py

@@ -0,0 +1,66 @@
+# 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.
+"""Amazon SageMaker Model Monitoring module.
+
+This module provides classes for monitoring model quality, data quality, and bias
+in deployed SageMaker models.
+"""
+from __future__ import absolute_import
+
+# Model monitoring classes
+from sagemaker.core.model_monitor.model_monitoring import BaseliningJob  # noqa: F401
+from sagemaker.core.model_monitor.model_monitoring import BatchTransformInput  # noqa: F401
+from sagemaker.core.model_monitor.model_monitoring import DefaultModelMonitor  # noqa: F401
+from sagemaker.core.model_monitor.model_monitoring import EndpointInput  # noqa: F401
+from sagemaker.core.model_monitor.model_monitoring import ModelMonitor  # noqa: F401
+from sagemaker.core.model_monitor.model_monitoring import ModelQualityMonitor  # noqa: F401
+from sagemaker.core.model_monitor.model_monitoring import MonitoringExecution  # noqa: F401
+from sagemaker.core.model_monitor.model_monitoring import MonitoringOutput  # noqa: F401
+
+# Clarify model monitoring classes
+from sagemaker.core.model_monitor.clarify_model_monitoring import BiasAnalysisConfig  # noqa: F401
+from sagemaker.core.model_monitor.clarify_model_monitoring import (  # noqa: F401
+    ExplainabilityAnalysisConfig,
+)
+from sagemaker.core.model_monitor.clarify_model_monitoring import ModelBiasMonitor  # noqa: F401
+from sagemaker.core.model_monitor.clarify_model_monitoring import (  # noqa: F401
+    ModelExplainabilityMonitor,
+)
+
+# Monitoring configuration classes
+from sagemaker.core.model_monitor.cron_expression_generator import (
+    CronExpressionGenerator,
+)  # noqa: F401
+from sagemaker.core.model_monitor.data_capture_config import DataCaptureConfig  # noqa: F401
+from sagemaker.core.model_monitor.data_quality_monitoring_config import (  # noqa: F401
+    DataQualityDistributionConstraints,
+)
+from sagemaker.core.model_monitor.data_quality_monitoring_config import (  # noqa: F401
+    DataQualityMonitoringConfig,
+)
+from sagemaker.core.model_monitor.dataset_format import DatasetFormat  # noqa: F401
+from sagemaker.core.model_monitor.dataset_format import MonitoringDatasetFormat  # noqa: F401
+from sagemaker.core.model_monitor.monitoring_alert import (
+    ModelDashboardIndicatorAction,
+)  # noqa: F401
+from sagemaker.core.model_monitor.monitoring_alert import MonitoringAlertActions  # noqa: F401
+from sagemaker.core.model_monitor.monitoring_alert import (
+    MonitoringAlertHistorySummary,
+)  # noqa: F401
+from sagemaker.core.model_monitor.monitoring_alert import MonitoringAlertSummary  # noqa: F401
+from sagemaker.core.model_monitor.monitoring_files import Constraints  # noqa: F401
+from sagemaker.core.model_monitor.monitoring_files import ConstraintViolations  # noqa: F401
+from sagemaker.core.model_monitor.monitoring_files import Statistics  # noqa: F401
+
+# Network configuration (re-exported for convenience)
+from sagemaker.core.network import NetworkConfig  # noqa: F401