ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-06-26 18:16:07 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Improve docstring for Task.close() (#920)

Browse Source
This commit is contained in:
Make42 2023-02-19 08:25:24 +01:00 committed by GitHub
parent 541c2425e0
commit 4ebe714165
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
clearml/task.py
View File

@ -1724,8 +1724,13 @@ class Task(_Task):
def close(self): def close(self):
""" """
Closes the current Task and changes its status to completed. Closes the current Task and changes its status to "Completed".
Enables you to manually shutdown the task. Enables you to manually shutdown the task.
This method does not terminate the current Python process, in contrast to :meth:`Task.mark_completed`.
After having :meth:`Task.close`d a task, the respective object cannot be used anymore and
methods like :meth:`Task.connect` or :meth:`Task.connect_configuration` will throw a `ValueError`.
In order to obtain an object representing the task again, use methods like :meth:`Task.get_task`.
.. warning:: .. warning::
Only call :meth:`Task.close` if you are certain the Task is not needed. Only call :meth:`Task.close` if you are certain the Task is not needed.