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

Remove docstring text of Task.close() that details Task.mark_completed()

Browse Source
This commit is contained in:
Richard Leibrandt 2023-03-08 15:48:30 +01:00
parent 017dc4c784
commit 641a4a2057
1 changed files with 1 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
clearml/task.py
View File

@ -1728,9 +1728,7 @@ class Task(_Task):
Enables you to manually shut down the task from the process which opened the task.
This method does not terminate the (current) Python process, in contrast to :meth:`Task.mark_completed`.
Note, that if :meth:`Task.mark_completed` is called from a different process it will not terminate
the process from which :meth:`Task.mark_completed` was called, but the process which created the task.
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`.