diff --git a/clearml/task.py b/clearml/task.py index dbc2bdc7..f07d5c42 100644 --- a/clearml/task.py +++ b/clearml/task.py @@ -1410,15 +1410,12 @@ class Task(_Task): :param object mutable: The experiment component to connect. The object must be one of the following types: - - argparse - An argparse object for parameters. - - dict - A dictionary for parameters. - - 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`. - - type - A Class type, storing all class 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` + - argparse - An argparse object 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. + - :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). + - object - A class instance, storing all instance properties (excluding '_' prefixed properties). :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)