Add system_meatadata property to azure ml model class (Azure#39763)

* Add system_meatadata property to azure ml model class

* update code format

* remove changelog changes

Author: chaoyu-msft

sdk/ml/azure-ai-ml/azure/ai/ml/_schema/assets/model.py

@@ -43,6 +43,7 @@ class ModelSchema(PathAwareSchema):
     latest_version = fields.Str(dump_only=True)
     datastore = fields.Str(metadata={"description": "Name of the datastore to upload to."}, required=False)
     intellectual_property = ExperimentalField(NestedField(IntellectualPropertySchema, required=False), dump_only=True)
+    system_metadata = fields.Dict()
 
     @pre_dump
     def validate(self, data, **kwargs):

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_assets/_artifacts/model.py

@@ -85,6 +85,7 @@ def __init__(
     ) -> None:
         self.job_name = kwargs.pop("job_name", None)
         self._intellectual_property = kwargs.pop("intellectual_property", None)
+        self._system_metadata = kwargs.pop("system_metadata", None)
         super().__init__(
             name=name,
             version=version,
@@ -129,6 +130,9 @@ def _from_rest_object(cls, model_rest_object: ModelVersion) -> "Model":
         rest_model_version: ModelVersionProperties = model_rest_object.properties
         arm_id = AMLVersionedArmId(arm_id=model_rest_object.id)
         model_stage = rest_model_version.stage if hasattr(rest_model_version, "stage") else None
+        model_system_metadata = (
+            rest_model_version.system_metadata if hasattr(rest_model_version, "system_metadata") else None
+        )
         if hasattr(rest_model_version, "flavors"):
             flavors = {key: flavor.data for key, flavor in rest_model_version.flavors.items()}
         model = Model(
@@ -150,6 +154,7 @@ def _from_rest_object(cls, model_rest_object: ModelVersion) -> "Model":
                 if rest_model_version.intellectual_property
                 else None
             ),
+            system_metadata=model_system_metadata,
         )
         return model
 
@@ -182,6 +187,8 @@ def _to_rest_object(self) -> ModelVersion:
             stage=self.stage,
             is_anonymous=self._is_anonymous,
         )
+        model_version.system_metadata = self._system_metadata if hasattr(self, "_system_metadata") else None
+
         model_version_resource = ModelVersion(properties=model_version)
 
         return model_version_resource

sdk/ml/azure-ai-ml/tests/model/unittests/test_model_schema.py

@@ -37,6 +37,18 @@ def test_deserialize_with_stage(self) -> None:
         model = load_model(path)
         assert model.stage == "Production"
 
+    def test_deserialize_with_system_metadata(self) -> None:
+        path = Path("./tests/test_configs/model/model_with_system_metadata.yml")
+        model = load_model(path)
+        assert model._system_metadata
+        assert model._system_metadata["publisher"] == "Contoso"
+        assert model._system_metadata["license"] == "MIT License"
+
+        model_version_resource = model._to_rest_object()
+        assert model_version_resource.properties.system_metadata
+        assert model_version_resource.properties.system_metadata["publisher"] == "Contoso"
+        assert model_version_resource.properties.system_metadata["license"] == "MIT License"
+
     def test_ipp_model(self) -> None:
         rest_ipp_model = {
             "id": "azureml://registries/fake_registry/models/fake_ipp_model/versions/611575",

sdk/ml/azure-ai-ml/tests/test_configs/model/model_with_system_metadata.yml

@@ -0,0 +1,19 @@
+name: my-production-model
+type: mlflow_model
+path: ./lightgbm_mlflow_model
+version: 3
+description: "this is my test model with stage"
+stage: "Production"
+tags:
+  foo: bar
+  abc: 123
+utc_time_created: '2023-05-03 17:44:02.096572'
+flavors:
+  sklearn:
+    sklearn_version: 0.23.2
+  python_function:
+    loader_module: office.plrmodel
+    python_version: 3.8.5
+system_metadata:
+  publisher: "Contoso"
+  license: "MIT License"