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

ads/model/generic_model.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2022, 2024 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 inspect
@@ -63,7 +63,7 @@ from ads.model.model_introspect import (
     ModelIntrospect,
 )
 from ads.model.model_metadata import (
-    ExtendedEnumMeta,
+    ExtendedEnum,
     Framework,
     MetadataCustomCategory,
     ModelCustomMetadata,
@@ -146,7 +146,7 @@ class ModelDeploymentRuntimeType:
     CONTAINER = "container"
 
 
-class DataScienceModelType(str, metaclass=ExtendedEnumMeta):
+class DataScienceModelType(ExtendedEnum):
     MODEL_DEPLOYMENT = "datasciencemodeldeployment"
     MODEL = "datasciencemodel"
 

ads/model/model_metadata.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2021, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2021, 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 json
@@ -21,9 +21,10 @@ from oci.util import to_dict
 
 from ads.common import logger
 from ads.common.error import ChangesNotCommitted
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 from ads.common.object_storage_details import ObjectStorageDetails
 from ads.common.serializer import DataClassSerializable
+from ads.common.utils import parse_bool
 from ads.dataset import factory
 
 try:
@@ -81,28 +82,34 @@ class MetadataDescriptionTooLong(ValueError):
         )
 
 
-class MetadataCustomPrintColumns(str, metaclass=ExtendedEnumMeta):
+class MetadataCustomPrintColumns(ExtendedEnum):
     KEY = "Key"
     VALUE = "Value"
     DESCRIPTION = "Description"
     CATEGORY = "Category"
+    HAS_ARTIFACT = "HasArtifact"
 
 
-class MetadataTaxonomyPrintColumns(str, metaclass=ExtendedEnumMeta):
+class MetadataTaxonomyPrintColumns(ExtendedEnum):
     KEY = "Key"
     VALUE = "Value"
+    HAS_ARTIFACT = "HasArtifact"
 
 
-class MetadataTaxonomyKeys(str, metaclass=ExtendedEnumMeta):
+class MetadataTaxonomyKeys(ExtendedEnum):
     USE_CASE_TYPE = "UseCaseType"
     FRAMEWORK = "Framework"
     FRAMEWORK_VERSION = "FrameworkVersion"
     ALGORITHM = "Algorithm"
     HYPERPARAMETERS = "Hyperparameters"
     ARTIFACT_TEST_RESULT = "ArtifactTestResults"
+    README = "Readme"
+    LICENSE = "License"
+    DEPLOYMENT_CONFIGURATION = "DeploymentConfiguration"
+    FINETUNE_CONFIGURATION = "FineTuneConfiguration"
 
 
-class MetadataCustomKeys(str, metaclass=ExtendedEnumMeta):
+class MetadataCustomKeys(ExtendedEnum):
     SLUG_NAME = "SlugName"
     CONDA_ENVIRONMENT = "CondaEnvironment"
     CONDA_ENVIRONMENT_PATH = "CondaEnvironmentPath"
@@ -121,7 +128,7 @@ class MetadataCustomKeys(str, metaclass=ExtendedEnumMeta):
     MODEL_FILE_NAME = "ModelFileName"
 
 
-class MetadataCustomCategory(str, metaclass=ExtendedEnumMeta):
+class MetadataCustomCategory(ExtendedEnum):
     PERFORMANCE = "Performance"
     TRAINING_PROFILE = "Training Profile"
     TRAINING_AND_VALIDATION_DATASETS = "Training and Validation Datasets"
@@ -129,7 +136,7 @@ class MetadataCustomCategory(str, metaclass=ExtendedEnumMeta):
     OTHER = "Other"
 
 
-class UseCaseType(str, metaclass=ExtendedEnumMeta):
+class UseCaseType(ExtendedEnum):
     BINARY_CLASSIFICATION = "binary_classification"
     REGRESSION = "regression"
     MULTINOMIAL_CLASSIFICATION = "multinomial_classification"
@@ -146,7 +153,7 @@ class UseCaseType(str, metaclass=ExtendedEnumMeta):
     OTHER = "other"
 
 
-class Framework(str, metaclass=ExtendedEnumMeta):
+class Framework(ExtendedEnum):
     SCIKIT_LEARN = "scikit-learn"
     XGBOOST = "xgboost"
     TENSORFLOW = "tensorflow"
@@ -336,13 +343,14 @@ class ModelMetadataItem(ABC):
         """Creates a new metadata item from the OCI metadata item."""
         oci_metadata_item = to_dict(oci_metadata_item)
         key_value_map = {field: oci_metadata_item.get(field) for field in cls._FIELDS}
-
         if isinstance(key_value_map["value"], str):
             try:
                 key_value_map["value"] = json.loads(oci_metadata_item.get("value"))
+                key_value_map["has_artifact"] = parse_bool(
+                    oci_metadata_item.get("has_artifact")
+                )
             except Exception:
                 pass
-
         return cls(**key_value_map)
 
     def __hash__(self):
@@ -398,15 +406,12 @@ class ModelTaxonomyMetadataItem(ModelMetadataItem):
         Validates metadata item.
     """
 
-    _FIELDS = ["key", "value"]
+    _FIELDS = ["key", "value", "has_artifact"]
 
-    def __init__(
-        self,
-        key: str,
-        value: str = None,
-    ):
+    def __init__(self, key: str, value: str = None, has_artifact: bool = False):
         self.key = key
         self.value = value
+        self.has_artifact = has_artifact
 
     @property
     def key(self) -> str:
@@ -432,6 +437,14 @@ class ModelTaxonomyMetadataItem(ModelMetadataItem):
             raise ValueError("The key cannot be empty.")
         self._key = key
 
+    @property
+    def has_artifact(self) -> bool:
+        return self._has_artifact
+
+    @has_artifact.setter
+    def has_artifact(self, has_artifact: bool):
+        self._has_artifact = has_artifact is True
+
     @property
     def value(self) -> str:
         return self._value
@@ -471,7 +484,7 @@ class ModelTaxonomyMetadataItem(ModelMetadataItem):
         """
         self.update(value=None)
 
-    def update(self, value: str) -> None:
+    def update(self, value: str, has_artifact: bool = False) -> None:
         """Updates metadata item value.
 
         Parameters
@@ -485,6 +498,7 @@ class ModelTaxonomyMetadataItem(ModelMetadataItem):
             Nothing.
         """
         self.value = value
+        self.has_artifact = has_artifact
 
     def validate(self) -> bool:
         """Validates metadata item.
@@ -555,7 +569,7 @@ class ModelCustomMetadataItem(ModelTaxonomyMetadataItem):
         Validates metadata item.
     """
 
-    _FIELDS = ["key", "value", "description", "category"]
+    _FIELDS = ["key", "value", "description", "category", "has_artifact"]
 
     def __init__(
         self,
@@ -563,10 +577,12 @@ class ModelCustomMetadataItem(ModelTaxonomyMetadataItem):
         value: str = None,
         description: str = None,
         category: str = None,
+        has_artifact: bool = False,
     ):
         super().__init__(key=key, value=value)
         self.description = description
         self.category = category
+        self.has_artifact = has_artifact
 
     @property
     def description(self) -> str:
@@ -586,6 +602,17 @@ class ModelCustomMetadataItem(ModelTaxonomyMetadataItem):
 
         self._description = description
 
+    @property
+    def has_artifact(self) -> bool:
+        return self._has_artifact
+
+    @has_artifact.setter
+    def has_artifact(self, has_artifact: bool):
+        if not has_artifact:
+            self._has_artifact = False
+        else:
+            self._has_artifact = has_artifact
+
     @property
     def category(self) -> str:
         return self._category
@@ -631,7 +658,9 @@ class ModelCustomMetadataItem(ModelTaxonomyMetadataItem):
         """
         self.update(value=None, description=None, category=None)
 
-    def update(self, value: str, description: str, category: str) -> None:
+    def update(
+        self, value: str, description: str, category: str, has_artifact: bool = False
+    ) -> None:
         """Updates metadata item.
 
         Parameters
@@ -651,6 +680,7 @@ class ModelCustomMetadataItem(ModelTaxonomyMetadataItem):
         self.value = value
         self.description = description
         self.category = category
+        self.has_artifact = has_artifact
 
     def _to_oci_metadata(self):
         """Converts metadata item to OCI metadata item."""
@@ -659,6 +689,8 @@ class ModelCustomMetadataItem(ModelTaxonomyMetadataItem):
             oci_metadata_item.value = _METADATA_EMPTY_VALUE
         if not oci_metadata_item.category:
             oci_metadata_item.category = MetadataCustomCategory.OTHER
+        if not oci_metadata_item.has_artifact:
+            oci_metadata_item.has_artifact = False
         return oci_metadata_item
 
     def validate(self) -> bool:
@@ -1368,7 +1400,13 @@ class ModelCustomMetadata(ModelMetadata):
         return (
             pd.DataFrame(
                 (
-                    (item.key, item.value, item.description, item.category)
+                    (
+                        item.key,
+                        item.value,
+                        item.description,
+                        item.category,
+                        item.has_artifact,
+                    )
                     for item in self._items
                 ),
                 columns=[value for value in MetadataCustomPrintColumns.values()],
@@ -1509,7 +1547,12 @@ class ModelTaxonomyMetadata(ModelMetadata):
         metadata = cls()
         for oci_item in metadata_list:
             item = ModelTaxonomyMetadataItem._from_oci_metadata(oci_item)
-            metadata[item.key].update(value=item.value)
+            if item.key in metadata.keys:
+                metadata[item.key].update(
+                    value=item.value, has_artifact=item.has_artifact
+                )
+            else:
+                metadata._items.add(item)
         return metadata
 
     def to_dataframe(self) -> pd.DataFrame:
@@ -1522,7 +1565,7 @@ class ModelTaxonomyMetadata(ModelMetadata):
         """
         return (
             pd.DataFrame(
-                ((item.key, item.value) for item in self._items),
+                ((item.key, item.value, item.has_artifact) for item in self._items),
                 columns=[value for value in MetadataTaxonomyPrintColumns.values()],
             )
             .sort_values(by=[MetadataTaxonomyPrintColumns.KEY])
@@ -1562,7 +1605,10 @@ class ModelTaxonomyMetadata(ModelMetadata):
         metadata = cls()
         for item in data["data"]:
             item = ModelTaxonomyMetadataItem.from_dict(item)
-            metadata[item.key].update(value=item.value)
+            if item.key in metadata.keys:
+                metadata[item.key].update(value=item.value)
+            else:
+                metadata._items.add(item)
         return metadata
 
 

ads/model/model_version_set.py

@@ -14,7 +14,7 @@ from typing import Dict, List, Optional, Union
 
 import oci.data_science
 from ads.common.utils import batch_convert_case, get_value, snake_to_camel
-from ads.config import COMPARTMENT_OCID, OCI_REGION_METADATA, PROJECT_OCID
+from ads.config import COMPARTMENT_OCID, OCI_REGION_METADATA, PROJECT_OCID, USER
 from ads.jobs.builders.base import Builder
 from ads.model.datascience_model import DataScienceModel
 from ads.model.service.oci_datascience_model_version_set import (
@@ -454,7 +454,7 @@ class ModelVersionSet(Builder):
         return "modelVersionSet"
 
     @classmethod
-    def list(cls, compartment_id: str = None, **kwargs) -> List["ModelVersionSet"]:
+    def list(cls, compartment_id: str = None, category: str = USER, **kwargs) -> List["ModelVersionSet"]:
         """
         List model version sets in a given compartment.
 
@@ -462,6 +462,8 @@ class ModelVersionSet(Builder):
         ----------
         compartment_id: str
             The OCID of compartment.
+        category: (str, optional). Defaults to `USER`.
+            The category of Model. Allowed values are: "USER", "SERVICE"
         kwargs
             Additional keyword arguments for filtering model version sets.
 
@@ -473,7 +475,7 @@ class ModelVersionSet(Builder):
         return [
             cls.from_dsc_model_version_set(model_version_set)
             for model_version_set in DataScienceModelVersionSet.list_resource(
-                compartment_id, **kwargs
+                compartment_id, category=category, **kwargs
             )
         ]