From 7255439efdf644aad929cb9e976df5b1b2f49389 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 26 Jan 2025 22:42:34 +0200 Subject: [PATCH] Edit docstrings (#1367) --- clearml/backend_interface/task/task.py | 24 ++++++++++++------------ clearml/task.py | 15 ++++++++------- 2 files changed, 20 insertions(+), 19 deletions(-) diff --git a/clearml/backend_interface/task/task.py b/clearml/backend_interface/task/task.py index b83a4d50..832e2109 100644 --- a/clearml/backend_interface/task/task.py +++ b/clearml/backend_interface/task/task.py @@ -444,19 +444,19 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin): """ Returns the current Task's type. - Valid task types: + Valid task types: - - ``TaskTypes.training`` (default) - - ``TaskTypes.testing`` - - ``TaskTypes.inference`` - - ``TaskTypes.data_processing`` - - ``TaskTypes.application`` - - ``TaskTypes.monitor`` - - ``TaskTypes.controller`` - - ``TaskTypes.optimizer`` - - ``TaskTypes.service`` - - ``TaskTypes.qc`` - - ``TaskTypes.custom`` + - ``TaskTypes.training`` (default) + - ``TaskTypes.testing`` + - ``TaskTypes.inference`` + - ``TaskTypes.data_processing`` + - ``TaskTypes.application`` + - ``TaskTypes.monitor`` + - ``TaskTypes.controller`` + - ``TaskTypes.optimizer`` + - ``TaskTypes.service`` + - ``TaskTypes.qc`` + - ``TaskTypes.custom`` """ return self.data.type diff --git a/clearml/task.py b/clearml/task.py index 215ffea4..709b5886 100644 --- a/clearml/task.py +++ b/clearml/task.py @@ -1062,10 +1062,11 @@ class Task(_Task): that use this protocol :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 - - port - the port exposed by the application - - protocol - the protocol used by the endpoint + + - 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 + - port - the port exposed by the application + - protocol - the protocol used by the endpoint """ Session.verify_feature_set("advanced") runtime_props = self._get_runtime_properties() @@ -1308,7 +1309,7 @@ class Task(_Task): ): # 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. - 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. :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. 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 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 specified, then a path to a local configuration file is returned. Configuration object.