ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-04-22 15:25:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Edit docstrings (#1011)

Browse Source
This commit is contained in:
pollfly 2023-05-07 15:50:49 +03:00 committed by GitHub
parent 1c254c3d83
commit 1927e6578c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 48 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -684,7 +684,7 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
This is in contrast to :meth:`Task.close`, which does the first two steps, but does not terminate any Python process.
Let's say that process A created the task and process B has a handle on the task, e.g., with :meth:`Task.get_task`.
Then, if we call :meth:`Task.mark_completed`, the process A is terminated, but process B is not.
Then, if we call :meth:`Task.mark_completed`, process A is terminated, but process B is not.
However, if :meth:`Task.mark_completed` was called from the same process in which the task was created,
then - effectively - the process terminates itself.
@ -1135,7 +1135,7 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
Notice the parameter dict is flat:
i.e. {'Args/param': 'value'} will set the argument "param" in section "Args" to "value"
:param args: Positional arguments, which are one or more dictionary or (key, value) iterable. They are
:param args: Positional arguments, which are one or more dictionaries or (key, value) iterable. They are
merged into a single key-value pair dictionary.
:param kwargs: Key-value pairs, merged into the parameters dictionary created from ``args``.
"""
@ -1147,7 +1147,7 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
Set the parameters for a Task. This method sets a complete group of key-value parameter pairs, but does not
support parameter descriptions (the input is a dictionary of key-value pairs).
:param args: Positional arguments, which are one or more dictionary or (key, value) iterable. They are
:param args: Positional arguments, which are one or more dictionaries or (key, value) iterable. They are
merged into a single key-value pair dictionary.
:param kwargs: Key-value pairs, merged into the parameters dictionary created from ``args``.
"""
@ -1362,7 +1362,7 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
Notice the parameter dict is flat:
i.e. {'Args/param': 'value'} will set the argument "param" in section "Args" to "value"
:param args: Positional arguments, which are one or more dictionary or (key, value) iterable. They are
:param args: Positional arguments, which are one or more dictionaries or (key, value) iterable. They are
merged into a single key-value pair dictionary.
:param kwargs: Key-value pairs, merged into the parameters dictionary created from ``args``.
"""

16
clearml/logger.py
View File

@ -132,8 +132,7 @@ class Logger(object):
:param str msg: The text to log.
:param int level: The log level from the Python ``logging`` package. The default value is ``logging.INFO``.
:param bool print_console: In addition to the log, print to the console
:param bool print_console: In addition to the log, print to the console.
The values are:
- ``True`` - Print to the console. (default)
@ -420,15 +419,13 @@ class Logger(object):
:param str xaxis: The x-axis title. (Optional)
:param str yaxis: The y-axis title. (Optional)
:param str mode: The type of line plot.
The values are:
- ``lines`` (default)
- ``markers``
- ``lines+markers``
:param bool reverse_xaxis: Reverse the x-axis
:param bool reverse_xaxis: Reverse the x-axis.
The values are:
- ``True`` - The x-axis is high to low (reversed).
@ -566,12 +563,7 @@ class Logger(object):
:param str zaxis: The z-axis title. (Optional)
:param list(str) labels: Labels per point in the data assigned to the ``scatter`` parameter. The labels must be
in the same order as the data.
:param str mode: The type of scatter plot. The values are:
- ``lines``
- ``markers``
- ``lines+markers``
:param str mode: The type of scatter plot. The values are: ``lines``, ``markers``, ``lines+markers``.
For example:
.. code-block:: py
@ -1258,7 +1250,7 @@ class Logger(object):
def matplotlib_force_report_non_interactive(cls, force):
# type: (bool) -> None
"""
If True, all matplotlib are always converted to non interactive static plots (images), appearing in under
If True, all matplotlib are always converted to non-interactive static plots (images), appearing in under
the Plots section. If False (default), matplotlib figures are converted into interactive web UI plotly
figures, in case figure conversion fails, it defaults to non-interactive plots.

18
clearml/model.py
View File

@ -678,17 +678,13 @@ class BaseModel(object):
:param int iteration: The reported iteration / step.
:param str xaxis: The x-axis title. (Optional)
:param str yaxis: The y-axis title. (Optional)
:param str mode: The type of line plot.
The values are:
:param str mode: The type of line plot. The values are:
- ``lines`` (default)
- ``markers``
- ``lines+markers``
:param bool reverse_xaxis: Reverse the x-axis
The values are:
:param bool reverse_xaxis: Reverse the x-axis. The values are:
- ``True`` - The x-axis is high to low (reversed).
- ``False`` - The x-axis is low to high (not reversed). (default)
@ -819,11 +815,7 @@ class BaseModel(object):
:param str zaxis: The z-axis title. (Optional)
:param list(str) labels: Labels per point in the data assigned to the ``scatter`` parameter. The labels must be
in the same order as the data.
:param str mode: The type of scatter plot. The values are:
- ``lines``
- ``markers``
- ``lines+markers``
:param str mode: The type of scatter plot. The values are: ``lines``, ``markers``, ``lines+markers``.
For example:
@ -1550,9 +1542,7 @@ class InputModel(Model):
:param str weights_url: A valid URL for the initial weights file. If the **ClearML Web-App** (backend)
already stores the metadata of a model with the same URL, that existing model is returned
and ClearML ignores all other parameters.
For example:
and ClearML ignores all other parameters. For example:
- ``https://domain.com/file.bin``
- ``s3://bucket/file.bin``

14
clearml/task.py
View File

@ -1174,8 +1174,7 @@ class Task(_Task):
:param str parent: The ID of the parent Task of the new Task.
- If ``parent`` is not specified, then ``parent`` is set to ``source_task.parent``.
- If ``parent`` is not specified and ``source_task.parent`` is not available, then
``parent`` set to ``source_task``.
- If ``parent`` is not specified and ``source_task.parent`` is not available, then ``parent`` set to ``source_task``.
:param str project: The ID of the project in which to create the new Task.
If ``None``, the new task inherits the original Task's project. (Optional)
@ -2506,21 +2505,16 @@ class Task(_Task):
:param queue_name: The queue name used for enqueueing the task. If ``None``, this call exits the process
without enqueuing the task.
:param clone: Clone the Task and execute the newly cloned Task
The values are:
- ``True`` - A cloned copy of the Task will be created, and enqueued, instead of this Task.
- ``False`` - The Task will be enqueued.
:param exit_process: The function call will leave the calling process at the end
:param exit_process: The function call will leave the calling process at the end.
- ``True`` - Exit the process (exit(0)).
- ``True`` - Exit the process (exit(0)). Note: if ``clone==False``, then ``exit_process`` must be ``True``.
- ``False`` - Do not exit the process.
.. warning::
If ``clone==False``, then ``exit_process`` must be ``True``.
:return Task: return the task object of the newly generated remotely executing task
"""
# do nothing, we are running remotely
@ -2589,7 +2583,7 @@ class Task(_Task):
"""
Create a new task, and call ``func`` with the specified kwargs.
One can think of this call as remote forking, where the newly created instance is the new Task
calling the specified func with the appropriate kwargs and leave once the func terminates.
calling the specified func with the appropriate kwargs and leaving once the func terminates.
Notice that a remote executed function cannot create another child remote executed function.
.. note::