Refactor duration to utilization duration

Author: jmsmkn

app/grandchallenge/components/backends/amazon_sagemaker_base.py

@@ -357,7 +357,7 @@ def _stop_job_boto(self):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-        self.__duration = None
+        self.__utilization_duration = None
         self.__runtime_metrics = {}
 
         self.__sagemaker_client = None
@@ -413,8 +413,8 @@ def _cloudwatch_client(self):
         return self.__cloudwatch_client
 
     @property
-    def duration(self):
-        return self.__duration
+    def utilization_duration(self):
+        return self.__utilization_duration
 
     @property
     def runtime_metrics(self):
@@ -536,10 +536,10 @@ def _set_duration(self, *, event):
                 self._get_start_time(event=event)
             )
             stopped = ms_timestamp_to_datetime(self._get_end_time(event=event))
-            self.__duration = stopped - started
+            self.__utilization_duration = stopped - started
         except TypeError:
             logger.warning("Invalid start or end time, duration undetermined")
-            self.__duration = None
+            self.__utilization_duration = None
 
     def _get_log_stream_name(self, *, data_log=False):
         response = self._logs_client.describe_log_streams(

app/grandchallenge/components/backends/base.py

@@ -399,7 +399,7 @@ def stderr(self):
 
     @property
     @abstractmethod
-    def duration(self): ...
+    def utilization_duration(self): ...
 
     @property
     @abstractmethod
@@ -449,12 +449,13 @@ def _max_memory_mb(self):
 
     @property
     def compute_cost_euro_millicents(self):
-        duration = self.duration
-        if duration is None:
+        utilization_duration = self.utilization_duration
+        if utilization_duration is None:
             return None
         else:
             return duration_to_millicents(
-                duration=duration, usd_cents_per_hour=self.usd_cents_per_hour
+                duration=utilization_duration,
+                usd_cents_per_hour=self.usd_cents_per_hour,
             )
 
     @property
@@ -479,7 +480,7 @@ def _invocation_key(self):
         return safe_join(self._invocation_prefix, "invocation.json")
 
     @property
-    def _result_key(self):
+    def _inference_result_key(self):
         return safe_join(
             self._io_prefix, ".sagemaker_shim", "inference_result.json"
         )
@@ -818,7 +819,7 @@ def _get_inference_result(self):
         try:
             response = self._s3_client.get_object(
                 Bucket=settings.COMPONENTS_OUTPUT_BUCKET_NAME,
-                Key=self._result_key,
+                Key=self._inference_result_key,
             )
         except botocore.exceptions.ClientError as error:
             if error.response["Error"]["Code"] == "404":
@@ -855,11 +856,11 @@ def _get_inference_result(self):
                 "The invocation request did not return valid json"
             )
 
+        logger.info(f"{inference_result=}")
+
         if inference_result.pk != self._job_id:
             raise RuntimeError("Wrong result key for this job")
 
-        logger.info(f"{inference_result=}")
-
         return inference_result
 
     def _handle_completed_job(self):

app/grandchallenge/components/models.py

@@ -1744,7 +1744,7 @@ def update_status(
         stderr: str = "",
         error_message="",
         detailed_error_message=None,
-        duration=None,
+        utilization_duration=None,
         compute_cost_euro_millicents=None,
         runtime_metrics=None,
     ):
@@ -1765,8 +1765,8 @@ def update_status(
                 for key, value in detailed_error_message.items()
             }
 
-        if duration is not None:
-            self.utilization.duration = duration
+        if utilization_duration is not None:
+            self.utilization.duration = utilization_duration
             self.utilization.save(update_fields=["duration"])
 
         if compute_cost_euro_millicents is not None:

app/grandchallenge/components/tasks.py

@@ -857,7 +857,7 @@ def get_update_status_kwargs(*, executor=None):
         return {
             "stdout": executor.stdout,
             "stderr": executor.stderr,
-            "duration": executor.duration,
+            "utilization_duration": executor.utilization_duration,
             "compute_cost_euro_millicents": executor.compute_cost_euro_millicents,
             "runtime_metrics": executor.runtime_metrics,
         }

app/grandchallenge/evaluation/serializers.py

@@ -281,7 +281,7 @@ def update(self, instance, validated_data):
             ]
             and instance.evaluation_utilization.duration is None
         ):
-            extra_kwargs.update(duration=now() - instance.claimed_at)
+            extra_kwargs["utilization_duration"] = now() - instance.claimed_at
 
         # calling update_status takes care of sending the notifications
         instance.update_status(

app/tests/algorithms_tests/test_models.py

@@ -86,7 +86,9 @@ def test_average_duration(settings, django_capture_on_commit_callbacks):
     )
 
     with django_capture_on_commit_callbacks(execute=True):
-        j.update_status(status=j.SUCCESS, duration=timedelta(minutes=5))
+        j.update_status(
+            status=j.SUCCESS, utilization_duration=timedelta(minutes=5)
+        )
 
     alg.refresh_from_db()
     assert alg.average_duration == timedelta(minutes=5)
@@ -97,7 +99,9 @@ def test_average_duration(settings, django_capture_on_commit_callbacks):
     )
 
     with django_capture_on_commit_callbacks(execute=True):
-        j.update_status(status=j.FAILURE, duration=timedelta(minutes=10))
+        j.update_status(
+            status=j.FAILURE, utilization_duration=timedelta(minutes=10)
+        )
 
     alg.refresh_from_db()
     assert alg.average_duration == timedelta(minutes=5)
@@ -106,7 +110,9 @@ def test_average_duration(settings, django_capture_on_commit_callbacks):
     j = AlgorithmJobFactory(time_limit=60)
 
     with django_capture_on_commit_callbacks(execute=True):
-        j.update_status(status=j.SUCCESS, duration=timedelta(minutes=15))
+        j.update_status(
+            status=j.SUCCESS, utilization_duration=timedelta(minutes=15)
+        )
 
     alg.refresh_from_db()
     assert alg.average_duration == timedelta(minutes=5)

app/tests/components_tests/resources/backends.py

@@ -107,7 +107,7 @@ def execute(self):
             self._s3_client.upload_fileobj(
                 Fileobj=io.BytesIO(inference_result_content),
                 Bucket=settings.COMPONENTS_OUTPUT_BUCKET_NAME,
-                Key=self._result_key,
+                Key=self._inference_result_key,
                 ExtraArgs={
                     "Metadata": {"signature_hmac_sha256": signature},
                 },
@@ -163,7 +163,7 @@ def get_job_params(*, job_name):
             )
 
     @property
-    def duration(self):
+    def utilization_duration(self):
         return now() - self.__start_time
 
     @property

app/tests/components_tests/test_amazon_sagemaker_training_backend.py

@@ -258,7 +258,7 @@ def test_set_duration():
         signing_key=b"",
     )
 
-    assert executor.duration is None
+    assert executor.utilization_duration is None
 
     executor._set_duration(
         event={
@@ -268,7 +268,7 @@ def test_set_duration():
         }
     )
 
-    assert executor.duration == timedelta(seconds=21)
+    assert executor.utilization_duration == timedelta(seconds=21)
 
 
 def test_get_log_stream_name(settings):
@@ -579,7 +579,7 @@ def test_handle_completed_job():
     executor._s3_client.upload_fileobj(
         Fileobj=io.BytesIO(inference_result_content),
         Bucket=settings.COMPONENTS_OUTPUT_BUCKET_NAME,
-        Key=executor._result_key,
+        Key=executor._inference_result_key,
         ExtraArgs={
             "Metadata": {"signature_hmac_sha256": signature},
         },

app/tests/components_tests/test_backends.py

@@ -776,7 +776,7 @@ def test_invocation_results_signature_unverified(settings):
     executor._s3_client.upload_fileobj(
         Fileobj=io.BytesIO(inference_result_content),
         Bucket=settings.COMPONENTS_OUTPUT_BUCKET_NAME,
-        Key=executor._result_key,
+        Key=executor._inference_result_key,
         ExtraArgs={
             "Metadata": {"signature_hmac_sha256": signature},
         },
@@ -824,7 +824,7 @@ def test_invocation_results_signature_verified(settings):
     executor._s3_client.upload_fileobj(
         Fileobj=io.BytesIO(inference_result_content),
         Bucket=settings.COMPONENTS_OUTPUT_BUCKET_NAME,
-        Key=executor._result_key,
+        Key=executor._inference_result_key,
         ExtraArgs={
             "Metadata": {"signature_hmac_sha256": signature},
         },

app/tests/utilization_tests/test_tasks.py

@@ -24,7 +24,7 @@ def usd_cents_per_hour(self):
         return 12.1
 
     @property
-    def duration(self):
+    def utilization_duration(self):
         raise NotImplementedError
 
     def execute(self):