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

Edit docstrings (#1367)

Browse Source
This commit is contained in:
pollfly 2025-01-26 22:42:34 +02:00 committed by GitHub
parent e8785a3e3d
commit 7255439efd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -444,19 +444,19 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
""" """
Returns the current Task's type. Returns the current Task's type.
Valid task types: Valid task types:
- ``TaskTypes.training`` (default) - ``TaskTypes.training`` (default)
- ``TaskTypes.testing`` - ``TaskTypes.testing``
- ``TaskTypes.inference`` - ``TaskTypes.inference``
- ``TaskTypes.data_processing`` - ``TaskTypes.data_processing``
- ``TaskTypes.application`` - ``TaskTypes.application``
- ``TaskTypes.monitor`` - ``TaskTypes.monitor``
- ``TaskTypes.controller`` - ``TaskTypes.controller``
- ``TaskTypes.optimizer`` - ``TaskTypes.optimizer``
- ``TaskTypes.service`` - ``TaskTypes.service``
- ``TaskTypes.qc`` - ``TaskTypes.qc``
- ``TaskTypes.custom`` - ``TaskTypes.custom``
""" """
return self.data.type return self.data.type

15
clearml/task.py
View File

@ -1062,10 +1062,11 @@ class Task(_Task):
that use this protocol that use this protocol
:return: A list of dictionaries. Each dictionary contains the following values: :return: A list of dictionaries. Each dictionary contains the following values:
- endpoint - raw endpoint. One might need to authenticate in order to use this endpoint
- browser_endpoint - endpoint to be used in browser. Authentication will be handled via the browser - endpoint - raw endpoint. One might need to authenticate in order to use this endpoint
- port - the port exposed by the application - browser_endpoint - endpoint to be used in browser. Authentication will be handled via the browser
- protocol - the protocol used by the endpoint - port - the port exposed by the application
- protocol - the protocol used by the endpoint
""" """
Session.verify_feature_set("advanced") Session.verify_feature_set("advanced")
runtime_props = self._get_runtime_properties() runtime_props = self._get_runtime_properties()
@ -1308,7 +1309,7 @@ class Task(_Task):
): ):
# type: (...) -> List[TaskInstance] # type: (...) -> List[TaskInstance]
""" """
Get a list of Tasks objects matching the queries/filters Get a list of Tasks objects matching the queries/filters:
- A list of specific Task IDs. - A list of specific Task IDs.
- Filter Tasks based on specific fields: - Filter Tasks based on specific fields:
@ -1844,7 +1845,7 @@ class Task(_Task):
While by setting `name='Train'` the connected dictionary will be under the Train section in the hyperparameters section. While by setting `name='Train'` the connected dictionary will be under the Train section in the hyperparameters section.
:param ignore_remote_overrides: If True, ignore UI/backend overrides when running remotely. :param ignore_remote_overrides: If True, ignore UI/backend overrides when running remotely.
Default is False, meaning that any changes made in the UI/backend will be applied in remote execution. Default is False, meaning that any changes made in the UI/backend will be applied in remote execution.
:return: It will return the same object that was passed as the `mutable` argument to the method, except if the type of the object is dict. :return: It will return the same object that was passed as the `mutable` argument to the method, except if the type of the object is dict.
For dicts the :meth:`Task.connect` will return the dict decorated as a `ProxyDictPostWrite`. For dicts the :meth:`Task.connect` will return the dict decorated as a `ProxyDictPostWrite`.
@ -1996,7 +1997,7 @@ class Task(_Task):
:param str description: Configuration section description (text). default: None :param str description: Configuration section description (text). default: None
:param bool ignore_remote_overrides: If True, ignore UI/backend overrides when running remotely. :param bool ignore_remote_overrides: If True, ignore UI/backend overrides when running remotely.
Default is False, meaning that any changes made in the UI/backend will be applied in remote execution. Default is False, meaning that any changes made in the UI/backend will be applied in remote execution.
:return: If a dictionary is specified, then a dictionary is returned. If pathlib2.Path / string is :return: If a dictionary is specified, then a dictionary is returned. If pathlib2.Path / string is
specified, then a path to a local configuration file is returned. Configuration object. specified, then a path to a local configuration file is returned. Configuration object.