ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-05-07 22:34:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Deprecate Task.completed(), use Task.mark_completed() instead

Browse Source
This commit is contained in:
allegroai 2021-08-20 00:29:41 +03:00
parent 087938671c
commit 99327ecb62
3 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
clearml/backend_interface/task/task.py
View File

@ -5,6 +5,7 @@ import logging
import os import os
import re import re
import sys import sys
import warnings
from copy import copy from copy import copy
from datetime import datetime from datetime import datetime
from enum import Enum from enum import Enum
@ -559,6 +560,14 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
return self.send(tasks.StoppedRequest(self.id, force=force), ignore_errors=ignore_errors) return self.send(tasks.StoppedRequest(self.id, force=force), ignore_errors=ignore_errors)
def completed(self, ignore_errors=True): def completed(self, ignore_errors=True):
# type: (bool) -> ()
"""
.. note:: Deprecated in 1.1.0
"""
warnings.warn("'completed' is deprecated; use 'mark_completed' instead.", DeprecationWarning)
return self.mark_completed(ignore_errors=ignore_errors)
def mark_completed(self, ignore_errors=True):
# type: (bool) -> () # type: (bool) -> ()
""" The signal indicating that this Task completed. """ """ The signal indicating that this Task completed. """
if hasattr(tasks, 'CompletedRequest') and callable(tasks.CompletedRequest): if hasattr(tasks, 'CompletedRequest') and callable(tasks.CompletedRequest):

2
clearml/datasets/dataset.py
View File

@ -417,7 +417,7 @@ class Dataset(object):
self._task.flush(wait_for_uploads=True) self._task.flush(wait_for_uploads=True)
else: else:
self._task.close() self._task.close()
self._task.completed() self._task.mark_completed()
if self._task_pinger: if self._task_pinger:
self._task_pinger.unregister() self._task_pinger.unregister()

4
clearml/task.py
View File

@ -2237,7 +2237,7 @@ class Task(_Task):
Metrics.report_offline_session(task, session_folder) Metrics.report_offline_session(task, session_folder)
# print imported results page # print imported results page
print('ClearML results page: {}'.format(task.get_output_log_web_page())) print('ClearML results page: {}'.format(task.get_output_log_web_page()))
task.completed() task.mark_completed()
# close task # close task
task.close() task.close()
@ -3054,7 +3054,7 @@ class Task(_Task):
elif task_status[0] == 'failed': elif task_status[0] == 'failed':
self.mark_failed(status_reason=task_status[1]) self.mark_failed(status_reason=task_status[1])
elif task_status[0] == 'completed': elif task_status[0] == 'completed':
self.completed() self.mark_completed()
elif task_status[0] == 'stopped': elif task_status[0] == 'stopped':
self.stopped() self.stopped()