Enhancing Model-Defined Metadata Handling (#1069)

Author: mrDzurb

ads/model/model_metadata.py

@@ -1509,7 +1509,10 @@ def _from_oci_metadata(cls, metadata_list):
         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)
+            else:
+                metadata._items.add(item)
         return metadata
 
     def to_dataframe(self) -> pd.DataFrame:
@@ -1562,7 +1565,10 @@ def from_dict(cls, data: Dict) -> "ModelTaxonomyMetadata":
         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
 
 

tests/unitary/default_setup/model/test_datascience_model.py

@@ -26,7 +26,9 @@
     ModelArtifactSizeError,
     BucketNotVersionedError,
     ModelFileDescriptionError,
-    InvalidArtifactType, ModelRetentionSetting, ModelBackupSetting,
+    InvalidArtifactType,
+    ModelRetentionSetting,
+    ModelBackupSetting,
 )
 from ads.model.model_metadata import (
     ModelCustomMetadata,
@@ -44,7 +46,7 @@
 from ads.config import AQUA_SERVICE_MODELS_BUCKET as SERVICE_MODELS_BUCKET
 
 MODEL_OCID = "ocid1.datasciencemodel.oc1.iad.<unique_ocid>"
- 
+
 OCI_MODEL_PAYLOAD = {
     "id": MODEL_OCID,
     "compartment_id": "ocid1.compartment.oc1..<unique_ocid>",
@@ -71,16 +73,17 @@
         {"key": "UseCaseType", "value": "multinomial_classification"},
         {"key": "Hyperparameters"},
         {"key": "ArtifactTestResults"},
+        {"key": "UnexpectedKey", "value": "unexpected_value"},
     ],
     "backup_setting": {
         "is_backup_enabled": True,
         "backup_region": "us-phoenix-1",
-        "customer_notification_type": "ALL"
+        "customer_notification_type": "ALL",
     },
     "retention_setting": {
         "archive_after_days": 30,
         "delete_after_days": 90,
-        "customer_notification_type": "ALL"
+        "customer_notification_type": "ALL",
     },
     "input_schema": '{"schema": [{"dtype": "int64", "feature_type": "Integer", "name": 0, "domain": {"values": "", "stats": {}, "constraints": []}, "required": true, "description": "0", "order": 0}], "version": "1.1"}',
     "output_schema": '{"schema": [{"dtype": "int64", "feature_type": "Integer", "name": 0, "domain": {"values": "", "stats": {}, "constraints": []}, "required": true, "description": "0", "order": 0}], "version": "1.1"}',
@@ -148,6 +151,7 @@
             {"key": "UseCaseType", "value": "multinomial_classification"},
             {"key": "Hyperparameters", "value": None},
             {"key": "ArtifactTestResults", "value": None},
+            {"key": "UnexpectedKey", "value": "unexpected_value"},
         ]
     },
     "provenanceMetadata": {
@@ -161,12 +165,12 @@
     "backupSetting": {
         "is_backup_enabled": True,
         "backup_region": "us-phoenix-1",
-        "customer_notification_type": "ALL"
+        "customer_notification_type": "ALL",
     },
     "retentionSetting": {
         "archive_after_days": 30,
         "delete_after_days": 90,
-        "customer_notification_type": "ALL"
+        "customer_notification_type": "ALL",
     },
     "artifact": "ocid1.datasciencemodel.oc1.iad.<unique_ocid>.zip",
 }
@@ -327,8 +331,8 @@ def test_with_methods_1(self, mock_load_default_properties):
             .with_defined_metadata_list(self.payload["definedMetadataList"])
             .with_provenance_metadata(self.payload["provenanceMetadata"])
             .with_artifact(self.payload["artifact"])
-            .with_backup_setting(self.payload['backupSetting'])
-            .with_retention_setting(self.payload['retentionSetting'])
+            .with_backup_setting(self.payload["backupSetting"])
+            .with_retention_setting(self.payload["retentionSetting"])
         )
         assert self.prepare_dict(dsc_model.to_dict()["spec"]) == self.prepare_dict(
             self.payload
@@ -356,8 +360,12 @@ def test_with_methods_2(self):
                 ModelProvenanceMetadata.from_dict(self.payload["provenanceMetadata"])
             )
             .with_artifact(self.payload["artifact"])
-            .with_backup_setting(ModelBackupSetting.from_dict(self.payload['backupSetting']))
-            .with_retention_setting(ModelRetentionSetting.from_dict(self.payload['retentionSetting']))
+            .with_backup_setting(
+                ModelBackupSetting.from_dict(self.payload["backupSetting"])
+            )
+            .with_retention_setting(
+                ModelRetentionSetting.from_dict(self.payload["retentionSetting"])
+            )
         )
         assert self.prepare_dict(dsc_model.to_dict()["spec"]) == self.prepare_dict(
             self.payload

tests/unitary/default_setup/model/test_model_artifact.py

@@ -7,7 +7,7 @@
 import pickle
 import sys
 
-import mock
+from unittest import mock
 import pytest
 import yaml
 from ads.common.model import ADSModel