ODSC-50786/GenericModel: add reload options to ModelArtifact.from_uri (#499)

Author: mingkang111

ads/model/artifact.py

@@ -30,21 +30,21 @@
 ADS_VERSION = __version__
 
 
-class ArtifactNestedFolderError(Exception):   # pragma: no cover
+class ArtifactNestedFolderError(Exception):  # pragma: no cover
     def __init__(self, folder: str):
         self.folder = folder
         super().__init__("The required artifact files placed in a nested folder.")
 
 
-class ArtifactRequiredFilesError(Exception):   # pragma: no cover
+class ArtifactRequiredFilesError(Exception):  # pragma: no cover
     def __init__(self, required_files: Tuple[str]):
         super().__init__(
             "Not all required files presented in artifact folder. "
             f"Required files for conda runtime: {required_files}. If you are using container runtime, set `ignore_conda_error=True`."
         )
 
 
-class AritfactFolderStructureError(Exception):   # pragma: no cover
+class AritfactFolderStructureError(Exception):  # pragma: no cover
     def __init__(self, required_files: Tuple[str]):
         super().__init__(
             "The artifact folder has a wrong structure. "
@@ -171,6 +171,7 @@ def __init__(
         self.ignore_conda_error = ignore_conda_error
         self.model = None
         self.auth = auth or authutil.default_signer()
+
         if reload and not ignore_conda_error:
             self.reload()
             # Extracts the model_file_name from the score.py.
@@ -416,6 +417,7 @@ def from_uri(
         force_overwrite: Optional[bool] = False,
         auth: Optional[Dict] = None,
         ignore_conda_error: Optional[bool] = False,
+        reload: Optional[bool] = False,
     ):
         """Constructs a ModelArtifact object from the existing model artifacts.
 
@@ -426,16 +428,20 @@ def from_uri(
             OCI object storage URI.
         artifact_dir: str
             The local artifact folder to store the files needed for deployment.
-        model_file_name: (str, optional). Defaults to `None`
-            The file name of the serialized model.
-        force_overwrite: (bool, optional). Defaults to False.
-            Whether to overwrite existing files or not.
         auth: (Dict, optional). Defaults to None.
             The default authetication is set using `ads.set_auth` API.
             If you need to override the default, use the `ads.common.auth.api_keys`
             or `ads.common.auth.resource_principal` to create appropriate
             authentication signer and kwargs required to instantiate
             IdentityClient object.
+        force_overwrite: (bool, optional). Defaults to False.
+            Whether to overwrite existing files or not.
+        ignore_conda_error: (bool, optional). Defaults to False.
+            Parameter to ignore error when collecting conda information.
+        model_file_name: (str, optional). Defaults to `None`
+            The file name of the serialized model.
+        reload: (bool, optional). Defaults to False.
+            Whether to reload the Model into the environment.
 
         Returns
         -------
@@ -492,6 +498,8 @@ def from_uri(
                     utils.copy_from_uri(
                         uri=temp_dir, to_path=to_path, force_overwrite=True
                     )
+            except ArtifactRequiredFilesError as ex:
+                logger.warning(ex)
 
         if ObjectStorageDetails.is_oci_path(artifact_dir):
             for root, dirs, files in os.walk(to_path):
@@ -507,10 +515,10 @@ def from_uri(
 
         return cls(
             artifact_dir=artifact_dir,
-            model_file_name=model_file_name,
-            reload=True,
             ignore_conda_error=ignore_conda_error,
             local_copy_dir=to_path,
+            model_file_name=model_file_name,
+            reload=reload,
         )
 
     def __getattr__(self, item):

ads/model/generic_model.py

@@ -1349,13 +1349,15 @@ def from_model_artifact(
         properties.with_dict(local_vars)
         auth = auth or authutil.default_signer()
         artifact_dir = _prepare_artifact_dir(artifact_dir)
+        reload = kwargs.pop("reload", False)
         model_artifact = ModelArtifact.from_uri(
             uri=uri,
             artifact_dir=artifact_dir,
-            model_file_name=model_file_name,
-            force_overwrite=force_overwrite,
             auth=auth,
+            force_overwrite=force_overwrite,
             ignore_conda_error=ignore_conda_error,
+            model_file_name=model_file_name,
+            reload=reload,
         )
         model = cls(
             estimator=model_artifact.model,
@@ -1368,22 +1370,33 @@ def from_model_artifact(
         model.local_copy_dir = model_artifact.local_copy_dir
         model.model_artifact = model_artifact
         model.ignore_conda_error = ignore_conda_error
-        model.reload_runtime_info()
+
+        if reload:
+            model.reload_runtime_info()
+            model._summary_status.update_action(
+                detail="Populated metadata(Custom, Taxonomy and Provenance)",
+                action="Call .populate_metadata() to populate metadata.",
+            )
+
         model._summary_status.update_status(
             detail="Generated score.py",
-            status=ModelState.DONE.value,
+            status=ModelState.NOTAPPLICABLE.value,
         )
         model._summary_status.update_status(
             detail="Generated runtime.yaml",
-            status=ModelState.DONE.value,
+            status=ModelState.NOTAPPLICABLE.value,
         )
         model._summary_status.update_status(
-            detail="Serialized model", status=ModelState.DONE.value
+            detail="Serialized model",
+            status=ModelState.NOTAPPLICABLE.value,
         )
-        model._summary_status.update_action(
+        model._summary_status.update_status(
             detail="Populated metadata(Custom, Taxonomy and Provenance)",
-            action=f"Call .populate_metadata() to populate metadata.",
+            status=ModelState.AVAILABLE.value
+            if reload
+            else ModelState.NOTAPPLICABLE.value,
         )
+
         return model
 
     @classmethod
@@ -3034,6 +3047,7 @@ class ModelState(Enum):
     AVAILABLE = "Available"
     NOTAVAILABLE = "Not Available"
     NEEDSACTION = "Needs Action"
+    NOTAPPLICABLE = "Not Applicable"
 
 
 class SummaryStatus:

tests/unitary/with_extras/model/test_generic_model.py

@@ -807,7 +807,6 @@ def test_predict_success(self, mock_url, mock_client, mock_signer):
                 # )
                 assert test_result == {"result": "result"}
 
-    # @pytest.mark.skip(reason="need to fix later.")
     @pytest.mark.parametrize(
         "test_args",
         [
@@ -849,6 +848,7 @@ def test_predict_success(self, mock_url, mock_client, mock_signer):
                 "uri": "src/folder",
                 "force_overwrite": True,
                 "auth": {"config": "value"},
+                "reload": True,
             },
         ],
     )
@@ -882,6 +882,7 @@ def test_from_model_artifact(
             auth=test_args.get("auth", {"config": "value"}),
             model_file_name=test_args.get("model_file_name"),
             ignore_conda_error=False,
+            reload=test_args.get("reload", False),
         )
 
         if not test_args.get("as_onnx"):
@@ -899,8 +900,10 @@ def test_from_model_artifact(
                 properties=ModelProperties(),
                 as_onnx=True,
             )
-
-        mock_reload_runtime_info.assert_called()
+        if test_args.get("reload", False):
+            mock_reload_runtime_info.assert_called()
+        else:
+            mock_reload_runtime_info.assert_not_called()
         assert test_result == None
 
     @patch("ads.common.auth.default_signer")