Fixed model deployment failed return value.

Author: lu-ohai

ads/model/deployment/model_deployment.py

@@ -85,7 +85,7 @@ class LogNotConfiguredError(Exception):  # pragma: no cover
     pass
 
 
-class ModelDeploymentFailedError(Exception):  # pragma: no cover
+class ModelDeploymentPredictError(Exception):  # pragma: no cover
     pass
 
 
@@ -607,31 +607,24 @@ def deploy(
         -------
         ModelDeployment
            The instance of ModelDeployment.
-
-        Raises
-        ------
-        ModelDeploymentFailedError
-            If model deployment fails to deploy
         """
         create_model_deployment_details = (
             self._build_model_deployment_details()
             if self._spec
             else self.properties.build()
         )
 
-        response = self.dsc_model_deployment.create(
-            create_model_deployment_details=create_model_deployment_details,
-            wait_for_completion=wait_for_completion,
-            max_wait_time=max_wait_time,
-            poll_interval=poll_interval,
-        )
-
-        if response.lifecycle_state == State.FAILED.name:
-            raise ModelDeploymentFailedError(
-                f"Model deployment {response.id} failed to deploy: {response.lifecycle_details}"
+        try:
+            response = self.dsc_model_deployment.create(
+                create_model_deployment_details=create_model_deployment_details,
+                wait_for_completion=wait_for_completion,
+                max_wait_time=max_wait_time,
+                poll_interval=poll_interval,
             )
-
-        return self._update_from_oci_model(response)
+        except:
+            raise
+        finally:
+            return self._update_from_oci_model(response)
 
     def delete(
         self,
@@ -657,12 +650,16 @@ def delete(
         ModelDeployment
             The instance of ModelDeployment.
         """
-        response = self.dsc_model_deployment.delete(
-            wait_for_completion=wait_for_completion,
-            max_wait_time=max_wait_time,
-            poll_interval=poll_interval,
-        )
-        return self._update_from_oci_model(response)
+        try:
+            response = self.dsc_model_deployment.delete(
+                wait_for_completion=wait_for_completion,
+                max_wait_time=max_wait_time,
+                poll_interval=poll_interval,
+            )
+        except:
+            raise
+        finally:
+            return self._update_from_oci_model(response)
 
     def update(
         self,
@@ -718,14 +715,17 @@ def update(
             else self._update_model_deployment_details(**kwargs)
         )
 
-        response = self.dsc_model_deployment.update(
-            update_model_deployment_details=update_model_deployment_details,
-            wait_for_completion=wait_for_completion,
-            max_wait_time=max_wait_time,
-            poll_interval=poll_interval,
-        )
-
-        return self._update_from_oci_model(response)
+        try:
+            response = self.dsc_model_deployment.update(
+                update_model_deployment_details=update_model_deployment_details,
+                wait_for_completion=wait_for_completion,
+                max_wait_time=max_wait_time,
+                poll_interval=poll_interval,
+            )
+        except:
+            raise
+        finally:
+            return self._update_from_oci_model(response)
 
     def watch(
         self,
@@ -890,6 +890,10 @@ def predict(
             Prediction results.
 
         """
+        if self.sync().lifecycle_state != "ACTIVE":
+            raise ModelDeploymentPredictError(
+                "Model Deployment must be in `ACTIVE` state before predict can be called."
+            )
         endpoint = f"{self.url}/predict"
         signer = authutil.default_signer()["signer"]
         header = {
@@ -953,7 +957,7 @@ def predict(
         except oci.exceptions.ServiceError as ex:
             # When bandwidth exceeds the allocated value, TooManyRequests error (429) will be raised by oci backend.
             if ex.status == 429:
-                bandwidth_mbps = self.infrastructure.bandwidth_mbps or MODEL_DEPLOYMENT_BANDWIDTH_MBPS
+                bandwidth_mbps = self.infrastructure.bandwidth_mbps or DEFAULT_BANDWIDTH_MBPS
                 utils.get_logger().warning(
                     f"Load balancer bandwidth exceeds the allocated {bandwidth_mbps} Mbps."
                     "To estimate the actual bandwidth, use formula: (payload size in KB) * (estimated requests per second) * 8 / 1024."
@@ -985,13 +989,16 @@ def activate(
         ModelDeployment
             The instance of ModelDeployment.
         """
-        response = self.dsc_model_deployment.activate(
-            wait_for_completion=wait_for_completion,
-            max_wait_time=max_wait_time,
-            poll_interval=poll_interval,
-        )
-
-        return self._update_from_oci_model(response)
+        try:
+            response = self.dsc_model_deployment.activate(
+                wait_for_completion=wait_for_completion,
+                max_wait_time=max_wait_time,
+                poll_interval=poll_interval,
+            )
+        except:
+            raise
+        finally:
+            return self._update_from_oci_model(response)
 
     def deactivate(
         self,
@@ -1017,13 +1024,16 @@ def deactivate(
         ModelDeployment
             The instance of ModelDeployment.
         """
-        response = self.dsc_model_deployment.deactivate(
-            wait_for_completion=wait_for_completion,
-            max_wait_time=max_wait_time,
-            poll_interval=poll_interval,
-        )
-
-        return self._update_from_oci_model(response)
+        try:
+            response = self.dsc_model_deployment.deactivate(
+                wait_for_completion=wait_for_completion,
+                max_wait_time=max_wait_time,
+                poll_interval=poll_interval,
+            )
+        except:
+            raise
+        finally:
+            return self._update_from_oci_model(response)
 
     def _log_details(self, log_type: str = ModelDeploymentLogType.ACCESS):
         """Gets log details for the provided `log_type`.

ads/model/generic_model.py

@@ -2315,16 +2315,20 @@ def deploy(
             .with_runtime(runtime)
         )
 
-        self.model_deployment = model_deployment.deploy(
-            wait_for_completion=wait_for_completion,
-            max_wait_time=max_wait_time,
-            poll_interval=poll_interval,
-        )
-        self._summary_status.update_status(
-            detail="Deployed the model",
-            status=self.model_deployment.state.name.upper(),
-        )
-        return self.model_deployment
+        try:
+            self.model_deployment = model_deployment.deploy(
+                wait_for_completion=wait_for_completion,
+                max_wait_time=max_wait_time,
+                poll_interval=poll_interval,
+            )
+            self._summary_status.update_status(
+                detail="Deployed the model",
+                status=self.model_deployment.state.name.upper(),
+            )
+        except:
+            raise
+        finally:
+            return self.model_deployment
 
     def prepare_save_deploy(
         self,
@@ -2792,25 +2796,29 @@ def restart_deployment(
         """
         if not self.model_deployment:
             raise ValueError("Use `deploy()` method to start model deployment.")
-        logger.info(
-            f"Deactivating model deployment {self.model_deployment.model_deployment_id}."
-        )
-        self.model_deployment.deactivate(
-            max_wait_time=max_wait_time, poll_interval=poll_interval
-        )
-        logger.info(
-            f"Model deployment {self.model_deployment.model_deployment_id} has successfully been deactivated."
-        )
-        logger.info(
-            f"Activating model deployment {self.model_deployment.model_deployment_id}."
-        )
-        self.model_deployment.activate(
-            max_wait_time=max_wait_time, poll_interval=poll_interval
-        )
-        logger.info(
-            f"Model deployment {self.model_deployment.model_deployment_id} has successfully been activated."
-        )
-        return self.model_deployment
+        try:
+            logger.info(
+                f"Deactivating model deployment {self.model_deployment.model_deployment_id}."
+            )
+            self.model_deployment.deactivate(
+                max_wait_time=max_wait_time, poll_interval=poll_interval
+            )
+            logger.info(
+                f"Model deployment {self.model_deployment.model_deployment_id} has successfully been deactivated."
+            )
+            logger.info(
+                f"Activating model deployment {self.model_deployment.model_deployment_id}."
+            )
+            self.model_deployment.activate(
+                max_wait_time=max_wait_time, poll_interval=poll_interval
+            )
+            logger.info(
+                f"Model deployment {self.model_deployment.model_deployment_id} has successfully been activated."
+            )
+        except:
+            raise
+        finally:
+            return self.model_deployment
 
     @class_or_instance_method
     def delete(

ads/model/service/oci_datascience_model_deployment.py

@@ -212,6 +212,8 @@ def activate(
                         f"Error while trying to activate model deployment: {self.id}"
                     )
                     raise e
+                finally:
+                    return self.sync()
 
             return self.sync()
         else:
@@ -264,6 +266,8 @@ def create(
                     f"Error while trying to create model deployment: {self.id}"
                 )
                 raise e
+            finally:
+                return self.sync()
 
         return self.sync()
 
@@ -328,6 +332,8 @@ def deactivate(
                         f"Error while trying to deactivate model deployment: {self.id}"
                     )
                     raise e
+                finally:
+                    return self.sync()
 
             return self.sync()
         else:
@@ -399,6 +405,8 @@ def delete(
                     f"Error while trying to delete model deployment: {self.id}"
                 )
                 raise e
+            finally:
+                return self.sync()
 
         return self.sync()
 
@@ -454,8 +462,8 @@ def update(
         except Exception as e:
             logger.error(f"Error while trying to update model deployment: {self.id}")
             raise e
-
-        return self.sync()
+        finally:
+            return self.sync()
 
     @classmethod
     def list(

tests/unitary/default_setup/model_deployment/test_model_deployment_v2.py

@@ -21,7 +21,6 @@
 from ads.model.deployment.model_deployment import (
     ModelDeployment,
     ModelDeploymentLogType,
-    ModelDeploymentFailedError,
 )
 from ads.model.deployment.model_deployment_infrastructure import (
     ModelDeploymentInfrastructure,
@@ -1148,44 +1147,6 @@ def test_deploy(
         mock_create_model_deployment.assert_called_with(create_model_deployment_details)
         mock_sync.assert_called()
 
-    @patch.object(OCIDataScienceMixin, "sync")
-    @patch.object(
-        oci.data_science.DataScienceClient,
-        "create_model_deployment",
-    )
-    @patch.object(DataScienceModel, "create")
-    def test_deploy_failed(
-        self, mock_create, mock_create_model_deployment, mock_sync
-    ):
-        dsc_model = MagicMock()
-        dsc_model.id = "fakeid.datasciencemodel.oc1.iad.xxx"
-        mock_create.return_value = dsc_model
-        response = oci.response.Response(
-            status=MagicMock(),
-            headers=MagicMock(),
-            request=MagicMock(),
-            data=oci.data_science.models.ModelDeployment(
-                id="test_model_deployment_id",
-                lifecycle_state="FAILED",
-                lifecycle_details="The specified log object is not found or user is not authorized.",
-            ),
-        )
-        mock_sync.return_value = response.data
-        model_deployment = self.initialize_model_deployment()
-        create_model_deployment_details = (
-            model_deployment._build_model_deployment_details()
-        )
-        with pytest.raises(
-            ModelDeploymentFailedError,
-            match=f"Model deployment {response.data.id} failed to deploy: {response.data.lifecycle_details}",
-        ):
-            model_deployment.deploy(wait_for_completion=False)
-            mock_create.assert_called()
-            mock_create_model_deployment.assert_called_with(
-                create_model_deployment_details
-            )
-            mock_sync.assert_called()
-
     @patch.object(
         OCIDataScienceModelDeployment,
         "activate",