Fixed model deployment progress bar. (#471)

Author: lu-ohai

ads/common/oci_mixin.py

@@ -33,7 +33,7 @@
 WORK_REQUEST_STOP_STATE = ("SUCCEEDED", "FAILED", "CANCELED")
 DEFAULT_WAIT_TIME = 1200
 DEFAULT_POLL_INTERVAL = 10
-DEFAULT_WORKFLOW_STEPS = 2
+WORK_REQUEST_PERCENTAGE = 100
 
 
 class MergeStrategy(Enum):
@@ -939,7 +939,6 @@ def get_work_request_response(
     def wait_for_progress(
         self,
         work_request_id: str,
-        num_steps: int = DEFAULT_WORKFLOW_STEPS,
         max_wait_time: int = DEFAULT_WAIT_TIME,
         poll_interval: int = DEFAULT_POLL_INTERVAL,
     ):
@@ -949,8 +948,6 @@ def wait_for_progress(
         ----------
         work_request_id: str
             Work Request OCID.
-        num_steps: (int, optional). Defaults to 2.
-            Number of steps for the progress indicator.
         max_wait_time: int
             Maximum amount of time to wait in seconds (Defaults to 1200).
             Negative implies infinite wait time.
@@ -965,13 +962,14 @@ def wait_for_progress(
 
         i = 0
         start_time = time.time()
-        with get_progress_bar(num_steps) as progress:
+        with get_progress_bar(WORK_REQUEST_PERCENTAGE) as progress:
             seconds_since = time.time() - start_time
             exceed_max_time = max_wait_time > 0 and seconds_since >= max_wait_time
             if exceed_max_time:
                 logger.error(f"Max wait time ({max_wait_time} seconds) exceeded.")
+            previous_percent_complete = 0
             while not exceed_max_time and (
-                not work_request_logs or len(work_request_logs) < num_steps
+                not work_request_logs or previous_percent_complete <= WORK_REQUEST_PERCENTAGE
             ):
                 time.sleep(poll_interval)
                 new_work_request_logs = []
@@ -988,9 +986,23 @@ def wait_for_progress(
                     work_request_logs[i:] if work_request_logs else []
                 )
 
-                for wr_item in new_work_request_logs:
-                    progress.update(wr_item.message)
-                    i += 1
+                percent_change = work_request.percent_complete - previous_percent_complete
+                previous_percent_complete = work_request.percent_complete
+
+                if len(new_work_request_logs) > 0:
+                    start_index = True
+                    for wr_item in new_work_request_logs:
+                        if start_index:
+                            progress.update(wr_item.message, percent_change)
+                            start_index = False
+                        else:
+                            progress.update(wr_item.message, 0)
+                        i += 1
+                else:
+                    # if there is new percent change but the new work request logs is empty
+                    # needs to add this percent change to the bar to ensure the final percentage is 100
+                    if percent_change != 0:
+                        progress.update(n=percent_change)
 
                 if work_request and work_request.status in WORK_REQUEST_STOP_STATE:
                     if work_request.status != "SUCCEEDED":

ads/model/service/oci_datascience_model_deployment.py

@@ -20,10 +20,6 @@
 
 DEFAULT_WAIT_TIME = 1200
 DEFAULT_POLL_INTERVAL = 10
-DEACTIVATE_WORKFLOW_STEPS = 2
-DELETE_WORKFLOW_STEPS = 2
-ACTIVATE_WORKFLOW_STEPS = 6
-CREATE_WORKFLOW_STEPS = 6
 ALLOWED_STATUS = [
     State.ACTIVE.name,
     State.CREATING.name,
@@ -203,7 +199,6 @@ def activate(
                 try:
                     self.wait_for_progress(
                         self.workflow_req_id, 
-                        ACTIVATE_WORKFLOW_STEPS, 
                         max_wait_time, 
                         poll_interval
                     )
@@ -254,7 +249,6 @@ def create(
             try:
                 self.wait_for_progress(
                     self.workflow_req_id, 
-                    CREATE_WORKFLOW_STEPS, 
                     max_wait_time, 
                     poll_interval
                 )
@@ -317,7 +311,6 @@ def deactivate(
                 try:
                     self.wait_for_progress(
                         self.workflow_req_id, 
-                        DEACTIVATE_WORKFLOW_STEPS, 
                         max_wait_time, 
                         poll_interval
                     )
@@ -387,7 +380,6 @@ def delete(
             try:
                 self.wait_for_progress(
                     self.workflow_req_id, 
-                    DELETE_WORKFLOW_STEPS, 
                     max_wait_time, 
                     poll_interval
                 )

tests/unitary/default_setup/model_deployment/test_oci_datascience_model_deployment.py

@@ -15,10 +15,6 @@
 from ads.common.oci_mixin import OCIModelMixin, OCIWorkRequestMixin
 
 from ads.model.service.oci_datascience_model_deployment import (
-    ACTIVATE_WORKFLOW_STEPS,
-    CREATE_WORKFLOW_STEPS,
-    DEACTIVATE_WORKFLOW_STEPS,
-    DELETE_WORKFLOW_STEPS,
     OCIDataScienceModelDeployment,
 )
 
@@ -163,7 +159,6 @@ def test_activate_with_waiting(self):
                     mock_activate.assert_called_with(self.mock_model_deployment.id)
                     mock_wait.assert_called_with(
                         "test",
-                        ACTIVATE_WORKFLOW_STEPS,
                         1,
                         1,
                     )
@@ -248,7 +243,6 @@ def test_deactivate_with_waiting(self):
                     )
                     mock_wait.assert_called_with(
                         "test",
-                        DEACTIVATE_WORKFLOW_STEPS,
                         1,
                         1,
                     )
@@ -330,7 +324,6 @@ def test_create_with_waiting(self):
                                 mock_update_from_oci_model.assert_called()
                                 mock_wait.assert_called_with(
                                     "test",
-                                    CREATE_WORKFLOW_STEPS,                                    
                                     1,
                                     1,
                                 )
@@ -468,7 +461,6 @@ def test_delete_with_waiting(self):
                         mock_delete.assert_called_with(self.mock_model_deployment.id)
                         mock_wait.assert_called_with(
                             "test",
-                            DELETE_WORKFLOW_STEPS,
                             1,
                             1,
                         )