ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-01-31 00:56:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add missing stop_request, request a an agent to stop a running Task gracefully

Browse Source
This commit is contained in:
clearml 2025-01-02 00:14:52 +02:00
parent 246dbbbd3c
commit d674db14da
2 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -695,6 +695,28 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
ignore_errors=ignore_errors
)
def stop_request(self, ignore_errors=True, force=False, status_message=None):
# type: (bool, bool, Optional[str]) -> ()
"""
Request a task to stop. this will not change the task status
but mark a request for an agent or SDK to actually stop the Task.
This will trigger the Task's abort callback, and at the end will
change the task status to stopped and kill the Task's processes
Notice: calling this on your own Task, will cause
the watchdog to call the on_abort callback and kill the process
:param bool force: If not True, call fails if the task status is not 'in_progress'
:param bool ignore_errors: if False raise exception on error
:param str status_message: Optional, add status change message to the stop request.
This message will be stored as status_message on the Task's info panel
"""
# request task stop
return self.send(
tasks.StopRequest(self.id, force=force, status_reason="abort request", status_message=status_message),
ignore_errors=ignore_errors
)
def completed(self, ignore_errors=True):
# type: (bool) -> ()
"""

20
clearml/task.py
View File

@ -2406,6 +2406,26 @@ class Task(_Task):
# mark task as stopped
self.stopped(force=force, status_message=str(status_message) if status_message else None)
def mark_stop_request(self, force=False, status_message=None):
# type: (bool, Optional[str]) -> ()
"""
Request a task to stop. this will not change the task status
but mark a request for an agent or SDK to actually stop the Task.
This will trigger the Task's abort callback, and at the end will
change the task status to stopped and kill the Task's processes
Notice: calling this on your own Task, will cause
the watchdog to call the on_abort callback and kill the process
:param bool force: If not True, call fails if the task status is not 'in_progress'
:param str status_message: Optional, add status change message to the stop request.
This message will be stored as status_message on the Task's info panel
"""
# flush any outstanding logs
self.flush(wait_for_uploads=True)
# request task stop
return self.stop_request(self, force=force, status_message=status_message)
def flush(self, wait_for_uploads=False):
# type: (bool) -> bool
"""