oracle-ads 2.12.11__py3-none-any.whl → 2.13.1__py3-none-any.whl

ads/model/service/oci_datascience_model.py

@@ -1,24 +1,15 @@
 #!/usr/bin/env python
-# -*- coding: utf-8; -*-
 
 # Copyright (c) 2022, 2024 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import logging
-import time
+from dataclasses import dataclass
 from functools import wraps
 from io import BytesIO
-from typing import Callable, Dict, List, Optional
+from typing import Callable, Dict, List, Optional, Union
 
 import oci.data_science
-from ads.common import utils
-from ads.common.object_storage_details import ObjectStorageDetails
-from ads.common.oci_datascience import OCIDataScienceMixin
-from ads.common.oci_mixin import OCIWorkRequestMixin
-from ads.common.oci_resource import SEARCH_TYPE, OCIResource
-from ads.common.utils import extract_region
-from ads.common.work_request import DataScienceWorkRequest
-from ads.model.deployment import ModelDeployment
 from oci.data_science.models import (
     ArtifactExportDetailsObjectStorage,
     ArtifactImportDetailsObjectStorage,
@@ -26,9 +17,21 @@ from oci.data_science.models import (
     ExportModelArtifactDetails,
     ImportModelArtifactDetails,
     UpdateModelDetails,
-    WorkRequest,
 )
 from oci.exceptions import ServiceError
+from requests.structures import CaseInsensitiveDict
+
+from ads.common import utils
+from ads.common.auth import default_signer
+from ads.common.object_storage_details import ObjectStorageDetails
+from ads.common.oci_datascience import OCIDataScienceMixin
+from ads.common.oci_mixin import OCIWorkRequestMixin
+from ads.common.oci_resource import SEARCH_TYPE, OCIResource
+from ads.common.serializer import DataClassSerializable
+from ads.common.utils import extract_region, read_file, text_sanitizer
+from ads.common.work_request import DataScienceWorkRequest
+from ads.model.common.utils import MetadataArtifactPathType
+from ads.model.deployment import ModelDeployment
 
 logger = logging.getLogger(__name__)
 
@@ -57,6 +60,21 @@ class ModelWithActiveDeploymentError(Exception):  # pragma: no cover
     pass
 
 
+class ModelMetadataArtifactNotFoundError(Exception):  # pragma: no cover
+    def __init__(self, model_ocid, metadata_key: str):
+        super().__init__(
+            f"The model {model_ocid} does not contain the metadata with key {metadata_key}."
+        )
+
+
+@dataclass(repr=False)
+class ModelMetadataArtifactDetails(DataClassSerializable):
+    """Represents a details of Model Metadata ."""
+
+    headers: Union[Dict, CaseInsensitiveDict]
+    status: str
+
+
 def check_for_model_id(msg: str = MODEL_NEEDS_TO_BE_SAVED):
     """The decorator helping to check if the ID attribute sepcified for a datascience model.
 
@@ -89,6 +107,12 @@ def check_for_model_id(msg: str = MODEL_NEEDS_TO_BE_SAVED):
     return decorator
 
 
+def convert_model_metadata_response(
+    headers: Union[Dict, CaseInsensitiveDict], status: int
+) -> ModelMetadataArtifactDetails:
+    return ModelMetadataArtifactDetails(headers=headers, status=str(status))
+
+
 class OCIDataScienceModel(
     OCIDataScienceMixin,
     OCIWorkRequestMixin,
@@ -282,7 +306,7 @@ class OCIDataScienceModel(
         msg="Model needs to be restored before the archived artifact content can be accessed."
     )
     def restore_archived_model_artifact(
-            self, restore_model_for_hours_specified: Optional[int] = None
+        self, restore_model_for_hours_specified: Optional[int] = None
     ) -> None:
         """Restores the archived model artifact.
 
@@ -304,7 +328,8 @@ class OCIDataScienceModel(
         """
         return self.client.restore_archived_model_artifact(
             model_id=self.id,
-            restore_model_for_hours_specified=restore_model_for_hours_specified).headers["opc-work-request-id"]
+            restore_model_for_hours_specified=restore_model_for_hours_specified,
+        ).headers["opc-work-request-id"]
 
     @check_for_model_id(
         msg="Model needs to be saved to the Model Catalog before the artifact content can be read."
@@ -531,8 +556,6 @@ class OCIDataScienceModel(
 
         Parameters
         ----------
-        model_id: str
-            The model ID.
         config: (Dict, optional). Defaults to `None`.
             Configuration keys and values as per SDK and Tool Configuration.
             The from_file() method can be used to load configuration from a file.
@@ -581,7 +604,7 @@ class OCIDataScienceModel(
             raise ValueError("Model OCID not provided.")
         return super().from_ocid(ocid)
 
-    def is_model_by_reference(self):
+    def is_model_created_by_reference(self):
         """Checks if model is created by reference
         Returns
         -------
@@ -596,3 +619,450 @@ class OCIDataScienceModel(
                 ):
                     return True
         return False
+
+    def get_metadata_content(
+        self, artifact_path_or_content: str, path_type: MetadataArtifactPathType
+    ):
+        """
+        returns the content of the metadata artifact
+
+        Parameters
+        ----------
+        artifact_path_or_content: str
+            The path of the file (local or oss) containing metadata artifact or content.
+        path_type: str
+            can be one of local , oss or actual content itself
+
+        Returns
+        -------
+        metadata artifact content
+        """
+
+        if path_type == MetadataArtifactPathType.CONTENT:
+            return artifact_path_or_content
+
+        elif path_type == MetadataArtifactPathType.LOCAL:
+            if not utils.is_path_exists(artifact_path_or_content):
+                raise FileNotFoundError(
+                    f"File not found:  {artifact_path_or_content} . "
+                )
+
+            with open(artifact_path_or_content, "rb") as f:
+                contents = f.read()
+                logger.info(f"The metadata artifact content - {contents}")
+
+            return contents
+
+        elif path_type == MetadataArtifactPathType.OSS:
+            if not utils.is_path_exists(artifact_path_or_content):
+                raise FileNotFoundError(f"File not found: {artifact_path_or_content}")
+
+            contents = str(
+                read_file(file_path=artifact_path_or_content, auth=default_signer())
+            )
+            logger.debug(f"The metadata artifact content - {contents}")
+
+            return contents
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before the creating custom metadata artifact corresponding to that model"
+    )
+    def create_custom_metadata_artifact(
+        self,
+        metadata_key_name: str,
+        artifact_path: str,
+        path_type: MetadataArtifactPathType,
+    ) -> ModelMetadataArtifactDetails:
+        """Creates model custom metadata artifact for specified model.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+
+        artifact_path: str
+            The model custom metadata artifact path to be upload.
+
+        path_type: MetadataArtifactPathType
+            can be one of local , oss or actual content itself
+
+        Returns
+        -------
+        ModelMetadataArtifactDetails
+            The model custom metadata artifact creation info.
+            Example:
+            {
+                'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+                'opc-request-id': 'E4F7',
+                'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+                'X-Content-Type-Options': 'nosniff',
+                'Content-Length': '4029958',
+                'Vary': 'Origin',
+                'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+                'status': 204
+            }
+
+        """
+        contents = self.get_metadata_content(
+            artifact_path_or_content=artifact_path, path_type=path_type
+        )
+        response = self.client.create_model_custom_metadatum_artifact(
+            self.id,
+            metadata_key_name,
+            text_sanitizer(contents),
+            content_disposition="form" '-data; name="file"; filename="readme.*"',
+        )
+        response_data = convert_model_metadata_response(
+            response.headers, response.status
+        )
+        return response_data
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before creating defined metadata artifact corresponding to that model"
+    )
+    def create_defined_metadata_artifact(
+        self,
+        metadata_key_name: str,
+        artifact_path: str,
+        path_type: MetadataArtifactPathType,
+    ) -> ModelMetadataArtifactDetails:
+        """Creates model defined metadata artifact for specified model.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+
+        artifact_path: str
+            The model custom metadata artifact path to be upload.
+
+        path_type: MetadataArtifactPathType
+            can be one of local , oss or actual content itself.
+
+        Returns
+        -------
+        ModelMetadataArtifactDetails
+            The model defined metadata artifact creation info.
+            Example:
+            {
+                'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+                'opc-request-id': 'E4F7',
+                'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+                'X-Content-Type-Options': 'nosniff',
+                'Content-Length': '4029958',
+                'Vary': 'Origin',
+                'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+                'status': 204
+            }
+
+        """
+        contents = self.get_metadata_content(
+            artifact_path_or_content=artifact_path, path_type=path_type
+        )
+        response = self.client.create_model_defined_metadatum_artifact(
+            self.id,
+            metadata_key_name,
+            text_sanitizer(contents),
+            content_disposition='form-data; name="file"; filename="readme.*"',
+        )
+        response_data = convert_model_metadata_response(
+            response.headers, response.status
+        )
+        return response_data
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before updating defined metadata artifact corresponding to that model"
+    )
+    def update_defined_metadata_artifact(
+        self,
+        metadata_key_name: str,
+        artifact_path: str,
+        path_type: MetadataArtifactPathType,
+    ) -> ModelMetadataArtifactDetails:
+        """Update model defined metadata artifact for specified model.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+
+        artifact_path: str
+            The model defined metadata artifact path to be upload.
+
+        path_type:MetadataArtifactPathType
+            can be one of local , oss or actual content itself.
+        Returns
+        -------
+        ModelMetadataArtifactDetails
+            The model defined metadata artifact update info.
+            Example:
+            {
+                'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+                'opc-request-id': 'E4F7',
+                'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+                'X-Content-Type-Options': 'nosniff',
+                'Content-Length': '4029958',
+                'Vary': 'Origin',
+                'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+                'status': 204
+            }
+
+        """
+        contents = self.get_metadata_content(
+            artifact_path_or_content=artifact_path, path_type=path_type
+        )
+        response = self.client.update_model_defined_metadatum_artifact(
+            self.id,
+            metadata_key_name,
+            text_sanitizer(contents),
+            content_disposition='form-data; name="file"; filename="readme.*"',
+        )
+        response_data = convert_model_metadata_response(
+            response.headers, response.status
+        )
+        return response_data
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before updating custom metadata artifact corresponding to that model"
+    )
+    def update_custom_metadata_artifact(
+        self,
+        metadata_key_name: str,
+        artifact_path: str,
+        path_type: MetadataArtifactPathType,
+    ) -> ModelMetadataArtifactDetails:
+        """Update model custom metadata artifact for specified model.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+
+        artifact_path: str
+            The model custom metadata artifact path to be upload.
+
+        path_type: MetadataArtifactPathType
+            can be one of local , oss or actual content itself.
+
+        Returns
+        -------
+        ModelMetadataArtifactDetails
+            The model custom metadata artifact update info.
+            Example:
+            {
+                'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+                'opc-request-id': 'E4F7',
+                'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+                'X-Content-Type-Options': 'nosniff',
+                'Content-Length': '4029958',
+                'Vary': 'Origin',
+                'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+                'status': 204
+            }
+
+        """
+        contents = self.get_metadata_content(
+            artifact_path_or_content=artifact_path, path_type=path_type
+        )
+        response = self.client.update_model_custom_metadatum_artifact(
+            self.id,
+            metadata_key_name,
+            text_sanitizer(contents),
+            content_disposition="form" '-data; name="file"; filename="readme.*"',
+        )
+        response_data = convert_model_metadata_response(
+            response.headers, response.status
+        )
+        return response_data
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before fetching custom metadata artifact corresponding to that model"
+    )
+    def get_custom_metadata_artifact(self, metadata_key_name: str) -> bytes:
+        """Downloads model custom metadata artifact content for specified model metadata key.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+        Returns
+        -------
+        bytes
+               custom metadata artifact content
+
+        """
+        try:
+            return self.client.get_model_custom_metadatum_artifact_content(
+                self.id, metadata_key_name
+            ).data.content
+        except ServiceError as ex:
+            if ex.status == 404:
+                raise ModelMetadataArtifactNotFoundError(self.id, metadata_key_name)
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before fetching defined metadata artifact corresponding to that model"
+    )
+    def get_defined_metadata_artifact(self, metadata_key_name: str) -> bytes:
+        """Downloads model defined metadata artifact content for specified model metadata key.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+        Returns
+        -------
+        bytes
+                Defined metadata artifact content
+
+        """
+        try:
+            return self.client.get_model_defined_metadatum_artifact_content(
+                self.id, metadata_key_name
+            ).data.content
+        except ServiceError as ex:
+            if ex.status == 404 or ex.status == 400:
+                raise ModelMetadataArtifactNotFoundError(self.id, metadata_key_name)
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before fetching custom metadata artifact corresponding to that model"
+    )
+    def head_custom_metadata_artifact(
+        self, metadata_key_name: str
+    ) -> ModelMetadataArtifactDetails:
+        """Gets custom metadata artifact metadata for specified model metadata key.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+        Returns
+        -------
+        ModelMetadataArtifactDetails
+            The model custom metadata artifact head call info.
+            Example:
+            {
+                'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+                'opc-request-id': 'E4F7',
+                'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+                'X-Content-Type-Options': 'nosniff',
+                'Content-Length': '4029958',
+                'Vary': 'Origin',
+                'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+                'status': 204
+            }
+
+        """
+        response = self.client.head_model_custom_metadatum_artifact(
+            self.id, metadata_key_name
+        )
+        response_data = convert_model_metadata_response(
+            response.headers, response.status
+        )
+        return response_data
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before fetching defined metadata artifact corresponding to that model"
+    )
+    def head_defined_metadata_artifact(
+        self, metadata_key_name: str
+    ) -> ModelMetadataArtifactDetails:
+        """Gets defined metadata artifact metadata for specified model metadata key.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+        Returns
+        -------
+        ModelMetadataArtifactDetails
+            The model defined metadata artifact head call info.
+            Example:
+            {
+                'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+                'opc-request-id': 'E4F7',
+                'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+                'X-Content-Type-Options': 'nosniff',
+                'Content-Length': '4029958',
+                'Vary': 'Origin',
+                'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+                'status': 204
+            }
+
+        """
+        response = self.client.head_model_defined_metadatum_artifact(
+            self.id, metadata_key_name
+        )
+        response_data = convert_model_metadata_response(
+            response.headers, response.status
+        )
+        return response_data
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before the deleting custom metadata artifact corresponding to that model"
+    )
+    def delete_custom_metadata_artifact(
+        self, metadata_key_name: str
+    ) -> ModelMetadataArtifactDetails:
+        """Deletes model custom metadata artifact for specified model metadata key.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+        Returns
+        -------
+        ModelMetadataArtifactDetails
+            The model custom metadata artifact delete call info.
+            Example:
+            {
+                'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+                'opc-request-id': 'E4F7',
+                'X-Content-Type-Options': 'nosniff',
+                'Vary': 'Origin',
+                'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+                'status': 204
+            }
+
+        """
+        response = self.client.delete_model_custom_metadatum_artifact(
+            self.id, metadata_key_name
+        )
+        response_data = convert_model_metadata_response(
+            response.headers, response.status
+        )
+        return response_data
+
+    @check_for_model_id(
+        msg="Model needs to be saved to the Model Catalog before the deleting defined metadata artifact corresponding to that model"
+    )
+    def delete_defined_metadata_artifact(
+        self, metadata_key_name: str
+    ) -> ModelMetadataArtifactDetails:
+        """Deletes model defined metadata artifact for specified model metadata key.
+
+        Parameters
+        ----------
+        metadata_key_name: str
+            The name of the model metadatum in the metadata.
+        Returns
+        -------
+        ModelMetadataArtifactDetails
+            The model defined metadata artifact delete call info.
+            Example:
+            {
+                'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+                'opc-request-id': 'E4F7',
+                'X-Content-Type-Options': 'nosniff',
+                'Vary': 'Origin',
+                'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+                'status': 204
+            }
+
+        """
+        response = self.client.delete_model_defined_metadatum_artifact(
+            self.id, metadata_key_name
+        )
+        response_data = convert_model_metadata_response(
+            response.headers, response.status
+        )
+        return response_data

ads/opctl/anomaly_detection.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2025 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+from ads.opctl.operator.lowcode.anomaly.__main__ import operate
+from ads.opctl.operator.lowcode.anomaly.operator_config import AnomalyOperatorConfig
+
+if __name__ == "__main__":
+    config = AnomalyOperatorConfig()
+    operate(config)

ads/opctl/backend/marketplace/helm_helper.py

@@ -1,31 +1,30 @@
 #!/usr/bin/env python
-# -*- coding: utf-8; -*-
 
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
+import io
 import subprocess
 from enum import Enum
 from typing import List
-import io
 
 import click
 import pandas as pd
-from ads.opctl.backend.marketplace.models.marketplace_type import (
-    HelmMarketplaceListingDetails,
-)
 
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 from ads.opctl import logger
 from ads.opctl.backend.marketplace.marketplace_utils import (
-    StatusIcons,
-    get_docker_bearer_token,
     WARNING,
     Color,
+    StatusIcons,
+    get_docker_bearer_token,
+)
+from ads.opctl.backend.marketplace.models.marketplace_type import (
+    HelmMarketplaceListingDetails,
 )
 
 
-class HelmCommand(str, metaclass=ExtendedEnumMeta):
+class HelmCommand(ExtendedEnum):
     """Supported Helm commands."""
 
     Install = "install"
@@ -63,7 +62,7 @@ def run_helm_install(
         "-i",
     ]
     print(f"\n{Color.BLUE}{' '.join(helm_cmd)}{Color.END}")
-    return subprocess.run(helm_cmd)
+    return subprocess.run(helm_cmd, check=False)
 
 
 def _get_as_flags_(**kwargs) -> List[str]:
@@ -125,7 +124,7 @@ def check_helm_pull(helm_chart_url: str, version: str) -> HelmPullStatus:
         *_get_as_flags_(version=f"{version}"),
     ]
     logger.debug(" ".join(helm_cmd))
-    result = subprocess.run(helm_cmd, capture_output=True)
+    result = subprocess.run(helm_cmd, capture_output=True, check=False)
     stderr = result.stderr.decode("utf-8")
     if result.returncode == 0:
         return HelmPullStatus.SUCCESS
@@ -146,7 +145,7 @@ def run_helm_login(ocir_repo: str, token: str):
         *_get_as_flags_(username="BEARER_TOKEN", password=token),
     ]
     logger.debug(" ".join(helm_cmd[:-1]))
-    result = subprocess.run(helm_cmd, capture_output=True)
+    result = subprocess.run(helm_cmd, capture_output=True, check=False)
     if result.returncode == 0:
         pass
     else:
@@ -162,7 +161,7 @@ def run_helm_list(namespace: str, **kwargs) -> pd.DataFrame:
         *_get_as_flags_(namespace=namespace, **kwargs),
     ]
     logger.debug(" ".join(helm_cmd))
-    result = subprocess.run(helm_cmd, capture_output=True)
+    result = subprocess.run(helm_cmd, capture_output=True, check=False)
     if result.returncode == 0:
         return pd.read_csv(
             io.BytesIO(result.stdout), delimiter=r"\s*\t\s*", engine="python"

ads/opctl/cli.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
-# -*- coding: utf-8; -*-
 
-# Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+# Copyright (c) 2022, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import os
@@ -173,7 +172,7 @@ _options = [
     click.option(
         "--backend",
         "-b",
-        type=click.Choice([backend.value for backend in BACKEND_NAME]),
+        type=click.Choice([backend for backend in BACKEND_NAME]),
         help="backend to run the operator",
         required=False,
         default=None,
@@ -405,7 +404,7 @@ def check(file, **kwargs):
     debug = kwargs["debug"]
     if file:
         if os.path.exists(file):
-            with open(file, "r") as f:
+            with open(file) as f:
                 config = suppress_traceback(debug)(yaml.safe_load)(f.read())
         else:
             raise FileNotFoundError(f"{file} is not found")
@@ -586,7 +585,7 @@ def deactivate(**kwargs):
 )
 @click.option(
     "--output",
-    help=f"The filename to save the resulting specification template YAML",
+    help="The filename to save the resulting specification template YAML",
     required=False,
     default=None,
 )