BugFix/add reload option in GenericModel.save() (#462)

Author: mingkang111

ads/model/generic_model.py

@@ -67,7 +67,8 @@
     Framework,
     ModelCustomMetadata,
     ModelProvenanceMetadata,
-    ModelTaxonomyMetadata, MetadataCustomCategory,
+    ModelTaxonomyMetadata,
+    MetadataCustomCategory,
 )
 from ads.model.model_metadata_mixin import MetadataMixin
 from ads.model.model_properties import ModelProperties
@@ -1824,18 +1825,19 @@ def _random_display_name(self):
 
     def save(
         self,
-        display_name: Optional[str] = None,
+        bucket_uri: Optional[str] = None,
+        defined_tags: Optional[dict] = None,
         description: Optional[str] = None,
+        display_name: Optional[str] = None,
+        featurestore_dataset=None,
         freeform_tags: Optional[dict] = None,
-        defined_tags: Optional[dict] = None,
         ignore_introspection: Optional[bool] = False,
-        bucket_uri: Optional[str] = None,
+        model_version_set: Optional[Union[str, ModelVersionSet]] = None,
         overwrite_existing_artifact: Optional[bool] = True,
+        parallel_process_count: int = utils.DEFAULT_PARALLEL_PROCESS_COUNT,
         remove_existing_artifact: Optional[bool] = True,
-        model_version_set: Optional[Union[str, ModelVersionSet]] = None,
+        reload: Optional[bool] = True,
         version_label: Optional[str] = None,
-        featurestore_dataset=None,
-        parallel_process_count: int = utils.DEFAULT_PARALLEL_PROCESS_COUNT,
         **kwargs,
     ) -> str:
         """Saves model artifacts to the model catalog.
@@ -1862,7 +1864,7 @@ def save(
         overwrite_existing_artifact: (bool, optional). Defaults to `True`.
             Overwrite target bucket artifact if exists.
         remove_existing_artifact: (bool, optional). Defaults to `True`.
-            Wether artifacts uploaded to object storage bucket need to be removed or not.
+            Whether artifacts uploaded to object storage bucket need to be removed or not.
         model_version_set: (Union[str, ModelVersionSet], optional). Defaults to None.
             The model version set OCID, or model version set name, or `ModelVersionSet` instance.
         version_label: (str, optional). Defaults to None.
@@ -1871,6 +1873,8 @@ def save(
             The feature store dataset
         parallel_process_count: (int, optional)
             The number of worker processes to use in parallel for uploading individual parts of a multipart upload.
+        reload: (bool, optional)
+            Whether to reload to check if `load_model()` works in `score.py`. Default to `True`.
         kwargs:
             project_id: (str, optional).
                 Project OCID. If not specified, the value will be taken either
@@ -1926,12 +1930,17 @@ def save(
                 raise RuntimeInfoInconsistencyError(
                     "`.runtime_info` does not sync with runtime.yaml file. Call "
                     "`.runtime_info.save()` if you updated `runtime_info`. "
-                    "Call `.reload()` if you updated runtime.yaml file."
+                    "Call `.reload_runtime_info()` if you updated runtime.yaml file."
                 )
             # reload to check if load_model works in score.py, i.e.
             # whether the model file has been serialized, and whether it can be loaded
             # successfully.
-            self.reload()
+            if reload:
+                self.reload()
+            else:
+                logger.warning(
+                    "The score.py file has not undergone testing, and this could result in deployment errors. To verify its functionality, please set `reload=True`."
+                )
         except:
             if not self.ignore_conda_error:
                 raise
@@ -1967,11 +1976,15 @@ def save(
         if featurestore_dataset:
             dataset_details = {
                 "dataset-id": featurestore_dataset.id,
-                "dataset-name": featurestore_dataset.name
+                "dataset-name": featurestore_dataset.name,
             }
-            self.metadata_custom.add("featurestore.dataset", value=str(dataset_details),
-                                     category=MetadataCustomCategory.TRAINING_AND_VALIDATION_DATASETS,
-                                     description="feature store dataset", replace=True)
+            self.metadata_custom.add(
+                "featurestore.dataset",
+                value=str(dataset_details),
+                category=MetadataCustomCategory.TRAINING_AND_VALIDATION_DATASETS,
+                description="feature store dataset",
+                replace=True,
+            )
 
         self.dsc_model = (
             self.dsc_model.with_compartment_id(self.properties.compartment_id)

tests/unitary/with_extras/model/test_generic_model.py

@@ -283,19 +283,19 @@ def test_prepare_fail(self, mock_handle_model_file_name):
     @patch("ads.common.auth.default_signer")
     def test_prepare_both_conda_env(self, mock_signer, mock_get_service_packs):
         """prepare a model by only providing inference conda env."""
-        inference_conda_env="oci://service-conda-packs@ociodscdev/service_pack/cpu/General_Machine_Learning_for_CPUs/1.0/mlcpuv1"
-        inference_python_version="3.6"
-        training_conda_env="oci://service-conda-packs@ociodscdev/service_pack/cpu/Oracle_Database_for_CPU_Python_3.7/1.0/database_p37_cpu_v1"
-        training_python_version="3.7"
+        inference_conda_env = "oci://service-conda-packs@ociodscdev/service_pack/cpu/General_Machine_Learning_for_CPUs/1.0/mlcpuv1"
+        inference_python_version = "3.6"
+        training_conda_env = "oci://service-conda-packs@ociodscdev/service_pack/cpu/Oracle_Database_for_CPU_Python_3.7/1.0/database_p37_cpu_v1"
+        training_python_version = "3.7"
         mock_get_service_packs.return_value = (
             {
-                inference_conda_env : ("mlcpuv1", inference_python_version),
-                training_conda_env : ("database_p37_cpu_v1", training_python_version)
+                inference_conda_env: ("mlcpuv1", inference_python_version),
+                training_conda_env: ("database_p37_cpu_v1", training_python_version),
             },
             {
-                "mlcpuv1" : (inference_conda_env, inference_python_version),
-                "database_p37_cpu_v1" : (training_conda_env, training_python_version)
-            }
+                "mlcpuv1": (inference_conda_env, inference_python_version),
+                "database_p37_cpu_v1": (training_conda_env, training_python_version),
+            },
         )
         self.generic_model.prepare(
             inference_conda_env=inference_conda_env,
@@ -365,17 +365,19 @@ def test_reload(self):
     @patch.object(GenericModel, "_random_display_name", return_value="test_name")
     @patch.object(DataScienceModel, "create")
     @patch("ads.model.runtime.env_info.get_service_packs")
-    def test_save(self, mock_get_service_packs, mock_dsc_model_create, mock__random_display_name):
+    def test_save(
+        self, mock_get_service_packs, mock_dsc_model_create, mock__random_display_name
+    ):
         """test saving a model to artifact."""
-        inference_conda_env="oci://service-conda-packs@ociodscdev/service_pack/cpu/Data_Exploration_and_Manipulation_for_CPU_Python_3.7/3.0/dataexpl_p37_cpu_v3"
-        inference_python_version="3.7"
+        inference_conda_env = "oci://service-conda-packs@ociodscdev/service_pack/cpu/Data_Exploration_and_Manipulation_for_CPU_Python_3.7/3.0/dataexpl_p37_cpu_v3"
+        inference_python_version = "3.7"
         mock_get_service_packs.return_value = (
             {
-                inference_conda_env : ("dataexpl_p37_cpu_v3", inference_python_version),
+                inference_conda_env: ("dataexpl_p37_cpu_v3", inference_python_version),
             },
             {
-                "dataexpl_p37_cpu_v3" : (inference_conda_env, inference_python_version),
-            }
+                "dataexpl_p37_cpu_v3": (inference_conda_env, inference_python_version),
+            },
         )
         mock_dsc_model_create.return_value = MagicMock(id="fake_id")
         self.generic_model.prepare(
@@ -400,15 +402,15 @@ def test_save(self, mock_get_service_packs, mock_dsc_model_create, mock__random_
     @patch("ads.model.runtime.env_info.get_service_packs")
     def test_save_not_implemented_error(self, mock_get_service_packs):
         """test saving a model to artifact."""
-        inference_conda_env="oci://service-conda-packs@ociodscdev/service_pack/cpu/Data_Exploration_and_Manipulation_for_CPU_Python_3.7/3.0/dataexpl_p37_cpu_v3"
-        inference_python_version="3.7"
+        inference_conda_env = "oci://service-conda-packs@ociodscdev/service_pack/cpu/Data_Exploration_and_Manipulation_for_CPU_Python_3.7/3.0/dataexpl_p37_cpu_v3"
+        inference_python_version = "3.7"
         mock_get_service_packs.return_value = (
             {
-                inference_conda_env : ("dataexpl_p37_cpu_v3", inference_python_version),
+                inference_conda_env: ("dataexpl_p37_cpu_v3", inference_python_version),
             },
             {
-                "dataexpl_p37_cpu_v3" : (inference_conda_env, inference_python_version),
-            }
+                "dataexpl_p37_cpu_v3": (inference_conda_env, inference_python_version),
+            },
         )
         self.generic_model._serialize = False
         self.generic_model.prepare(
@@ -429,6 +431,40 @@ def test_save_not_implemented_error(self, mock_get_service_packs):
         with pytest.raises(NotImplementedError):
             self.generic_model.save()
 
+    @patch.object(GenericModel, "_random_display_name", return_value="test_name")
+    @patch.object(DataScienceModel, "create")
+    @patch("ads.model.runtime.env_info.get_service_packs")
+    @patch("ads.model.GenericModel.reload")
+    def test_save_not_reload(
+        self,
+        mock_reload,
+        mock_get_service_packs,
+        mock_dsc_model_create,
+        mock__random_display_name,
+    ):
+        """test saving a model to artifact without verify score.py."""
+        inference_conda_env = "oci://bucket@tenancy/prefix/dataexpl_p37_cpu_v3"
+        inference_python_version = "3.7"
+        mock_get_service_packs.return_value = (
+            {
+                inference_conda_env: ("dataexpl_p37_cpu_v3", inference_python_version),
+            },
+            {
+                "dataexpl_p37_cpu_v3": (inference_conda_env, inference_python_version),
+            },
+        )
+        mock_dsc_model_create.return_value = MagicMock(id="fake_id")
+        self.generic_model.prepare(
+            inference_conda_env="dataexpl_p37_cpu_v3",
+            namespace="ociodscdev",
+            inference_python_version="3.7",
+            model_file_name="model.joblib",
+            force_overwrite=True,
+            training_id=None,
+        )
+        self.generic_model.save(ignore_introspection=True, reload=False)
+        mock_reload.assert_not_called()
+
     def test_set_model_input_serializer(self):
         """Tests set_model_input_serializer() with different input types."""
         from ads.model.serde.model_input import (