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

Improve docstring for Task.mark_completed() (#921)

Browse Source
This commit is contained in:
Make42 2023-02-17 22:27:43 +01:00 committed by GitHub
parent 311e05d938
commit e938f2800b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -674,10 +674,20 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
def mark_completed(self, ignore_errors=True, status_message=None, force=False):
# type: (bool, Optional[str], bool) -> ()
"""
Manually mark a Task as completed. This will close the running process and will change the Task's status
to Completed (Use this function to close and change status of remotely executed tasks).
To simply change the Task's status to completed, use task.close()
Use this function to close and change status of remotely executed tasks.
Closes the current Task, changes its status to "Completed", and terminates the running Python process.
This is in contrast to :meth:`Task.close`, which does the first two steps, but does not terminate the running Python process.
For example, in
```
task.mark_completed()
from time import sleep
sleep(30)
print('This text will not be printed!')
```
the text will not be printed, because the Python process is immediately terminated.
:param bool ignore_errors: If True default), ignore any errors raised
:param bool force: If True, the task status will be changed to `stopped` regardless of the current Task state.
:param str status_message: Optional, add status change message to the stop request.