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

Edit docstrings (#1024)

Browse Source
This commit is contained in:
pollfly 2023-05-30 15:40:43 +03:00 committed by GitHub
parent db2f899d95
commit 56d4de04e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
clearml/logger.py
View File

@ -309,7 +309,7 @@ class Logger(object):
extra_data=None, # type: Optional[dict] extra_data=None, # type: Optional[dict]
): ):
""" """
For explicit report, report a table plot. For explicit reporting, report a table plot.
One and only one of the following parameters must be provided. One and only one of the following parameters must be provided.
@ -340,25 +340,29 @@ class Logger(object):
See full details on the supported configuration: https://plotly.com/javascript/reference/layout/ See full details on the supported configuration: https://plotly.com/javascript/reference/layout/
For example: For example:
.. code block:: py .. code-block:: py
logger.report_table( logger.report_table(
title='table example', title='table example',
series='pandas DataFrame', series='pandas DataFrame',
iteration=0, iteration=0,
table_plot=df, table_plot=df,
extra_layout={'height': 600}) extra_layout={'height': 600}
)
:param extra_data: optional dictionary for data configuration, like column width, passed directly to plotly :param extra_data: optional dictionary for data configuration, like column width, passed directly to plotly
See full details on the supported configuration: https://plotly.com/javascript/reference/table/ See full details on the supported configuration: https://plotly.com/javascript/reference/table/
For example: For example:
.. code block:: py .. code-block:: py
logger.report_table( logger.report_table(
title='table example', title='table example',
series='pandas DataFrame', series='pandas DataFrame',
iteration=0, iteration=0,
table_plot=df, table_plot=df,
extra_data={'columnwidth': [2., 1., 1., 1.]}) extra_data={'columnwidth': [2., 1., 1., 1.]}
)
""" """
mutually_exclusive( mutually_exclusive(

22
clearml/task.py
View File

@ -1703,24 +1703,24 @@ class Task(_Task):
:param total_num_nodes: The total number of nodes to be enqueued, including the master node, :param total_num_nodes: The total number of nodes to be enqueued, including the master node,
which should already be enqueued when running remotely which should already be enqueued when running remotely
:param port: Port opened by the master node. If the environment variable `CLEARML_MULTI_NODE_MASTER_DEF_PORT` :param port: Port opened by the master node. If the environment variable ``CLEARML_MULTI_NODE_MASTER_DEF_PORT``
is set, the value of this parameter will be set to the one defined in `CLEARML_MULTI_NODE_MASTER_DEF_PORT`. is set, the value of this parameter will be set to the one defined in ``CLEARML_MULTI_NODE_MASTER_DEF_PORT``.
If `CLEARML_MULTI_NODE_MASTER_DEF_PORT` doesn't exist, but `MASTER_PORT` does, then the value of this If ``CLEARML_MULTI_NODE_MASTER_DEF_PORT`` doesn't exist, but ``MASTER_PORT`` does, then the value of this
parameter will be set to the one defined in `MASTER_PORT`. If neither environment variables exist, parameter will be set to the one defined in ``MASTER_PORT``. If neither environment variables exist,
the value passed to the parameter will be used the value passed to the parameter will be used
:param queue: The queue to enqueue the nodes to. Can be different than the queue the master :param queue: The queue to enqueue the nodes to. Can be different from the queue the master
node is enqueued to. If None, the nodes will be enqueued to the same queue as the master node node is enqueued to. If None, the nodes will be enqueued to the same queue as the master node
:param wait: If True, the master node will wait for the other nodes to start :param wait: If True, the master node will wait for the other nodes to start
:param addr: The address of the master node's worker. If the environment variable :param addr: The address of the master node's worker. If the environment variable
`CLEARML_MULTI_NODE_MASTER_DEF_ADDR` is set, the value of this parameter will be set to ``CLEARML_MULTI_NODE_MASTER_DEF_ADDR`` is set, the value of this parameter will be set to
the one defined in `CLEARML_MULTI_NODE_MASTER_DEF_ADDR`. the one defined in ``CLEARML_MULTI_NODE_MASTER_DEF_ADDR``.
If `CLEARML_MULTI_NODE_MASTER_DEF_ADDR` doesn't exist, but `MASTER_ADDR` does, then the value of this If ``CLEARML_MULTI_NODE_MASTER_DEF_ADDR`` doesn't exist, but ``MASTER_ADDR`` does, then the value of this
parameter will be set to the one defined in `MASTER_ADDR`. If neither environment variables exist, parameter will be set to the one defined in ``MASTER_ADDR``. If neither environment variables exist,
the value passed to the parameter will be used. If this value is None (default), the private IP of the value passed to the parameter will be used. If this value is None (default), the private IP of
the machine the master node is running on will be used. the machine the master node is running on will be used.
:return: A dictionary containing relevant information regarding the multi node run. This dictionary :return: A dictionary containing relevant information regarding the multi node run. This dictionary has the following entries:
has the following entries:
- `master_addr` - the address of the machine that the master node is running on - `master_addr` - the address of the machine that the master node is running on
- `master_port` - the open port of the machine that the master node is running on - `master_port` - the open port of the machine that the master node is running on
- `total_num_nodes` - the total number of nodes, including the master - `total_num_nodes` - the total number of nodes, including the master