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

Edit docstrings

Browse Source
This commit is contained in:
revital 2023-04-30 10:47:26 +03:00
parent 422807555d
commit b78082c184
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
clearml/task.py
View File

@ -1410,15 +1410,12 @@ class Task(_Task):
:param object mutable: The experiment component to connect. The object must be one of the following types: :param object mutable: The experiment component to connect. The object must be one of the following types:
- argparse - An argparse object for parameters. - argparse - An argparse object for parameters.
- dict - A dictionary for parameters. - dict - A dictionary for parameters. Note: when :meth:`Task.connect` receives a dict, it supports only keys of type `str`
- TaskParameters - A TaskParameters object. - TaskParameters - A TaskParameters object.
- :class:`Model` - A model object for initial model warmup, or for model update/snapshot uploading. In practice the model should be either :class:`InputModel` or :class:`OutputModel`. - :class:`Model` - A model object for initial model warmup, or for model update/snapshot uploading. In practice the model should be either :class:`InputModel` or :class:`OutputModel`.
- type - A Class type, storing all class properties (excluding '_' prefixed properties). - type - A Class type, storing all class properties (excluding '_' prefixed properties).
- object - A class instance, storing all instance properties (excluding '_' prefixed properties). - object - A class instance, storing all instance properties (excluding '_' prefixed properties).
.. note::
When :meth:`Task.connect` receives a dict, it supports only keys of type `str`
:param str name: A section name associated with the connected object, if 'name' is None defaults to 'General' :param str name: A section name associated with the connected object, if 'name' is None defaults to 'General'
Currently, `name` is only supported for `dict` and `TaskParameter` objects, and should be omitted for the other supported types. (Optional) Currently, `name` is only supported for `dict` and `TaskParameter` objects, and should be omitted for the other supported types. (Optional)