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

Edit docstrings (#900)

Browse Source
This commit is contained in:
pollfly 2023-02-02 10:24:01 +02:00 committed by GitHub
parent 54c601eea2
commit c978d8c259
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
clearml/logger.py
View File

@ -480,9 +480,7 @@ class Logger(object):
:param str yaxis: The y-axis title. (Optional) :param str yaxis: The y-axis title. (Optional)
:param list(str) labels: Labels per point in the data assigned to the ``scatter`` parameter. The labels must be :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. in the same order as the data.
:param str mode: The type of scatter plot. :param str mode: The type of scatter plot. The values are:
The values are:
- ``lines`` - ``lines``
- ``markers`` - ``markers``
@ -544,9 +542,7 @@ class Logger(object):
:param str zaxis: The z-axis title. (Optional) :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 :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. in the same order as the data.
:param str mode: The type of scatter plot. :param str mode: The type of scatter plot. The values are:
The values are:
- ``lines`` - ``lines``
- ``markers`` - ``markers``
@ -560,9 +556,7 @@ class Logger(object):
logger.report_scatter3d(title="example_scatter_3d", series="series_xyz", iteration=1, scatter=scatter3d, logger.report_scatter3d(title="example_scatter_3d", series="series_xyz", iteration=1, scatter=scatter3d,
xaxis="title x", yaxis="title y", zaxis="title z") xaxis="title x", yaxis="title y", zaxis="title z")
:param bool fill: Fill the area under the curve :param bool fill: Fill the area under the curve. The values are:
The values are:
- ``True`` - Fill - ``True`` - Fill
- ``False`` - Do not fill (default) - ``False`` - Do not fill (default)
@ -819,16 +813,14 @@ class Logger(object):
:param local_path: A path to an image file. :param local_path: A path to an image file.
:param url: A URL for the location of a pre-uploaded image. :param url: A URL for the location of a pre-uploaded image.
:param image: Image data (RGB). :param image: Image data (RGB).
:param matrix: Deperacted, Image data (RGB). :param matrix: Deprecated, Image data (RGB).
.. note:: .. note::
The ``matrix`` parameter is deprecated. Use the ``image`` parameters. The ``matrix`` parameter is deprecated. Use the ``image`` parameters.
:param max_image_history: The maximum number of images to store per metric/variant combination. :param max_image_history: The maximum number of images to store per metric/variant combination.
For an unlimited number, use a negative value. The default value is set in global configuration For an unlimited number, use a negative value. The default value is set in global configuration
(default=``5``). (default=``5``).
:param delete_after_upload: After the upload, delete the local copy of the image :param delete_after_upload: After the upload, delete the local copy of the image. The values are:
The values are:
- ``True`` - Delete after upload. - ``True`` - Delete after upload.
- ``False`` - Do not delete after upload. (default) - ``False`` - Do not delete after upload. (default)
@ -1128,7 +1120,7 @@ class Logger(object):
`report_image`, `report_media` etc. without specifying `max_history` `report_image`, `report_media` etc. without specifying `max_history`
:param max_history: Number of samples (files) to store on a unique set of title/series being reported :param max_history: Number of samples (files) to store on a unique set of title/series being reported
with different iteration counter. This is used to make sure users do not end up exploding storage with different iteration counters. This is used to make sure users do not end up exploding storage
on server storage side. on server storage side.
For example the following code sample will store the last 5 images even though For example the following code sample will store the last 5 images even though
@ -1148,10 +1140,10 @@ class Logger(object):
# type: () -> int # type: () -> int
""" """
Return the default max debug sample history when reporting media/debug samples. Return the default max debug sample history when reporting media/debug samples.
If value was not set specifically, the functions returns the configuration file default value. If value was not set specifically, the function returns the configuration file default value.
:return: default number of samples (files) to store on a unique set of title/series being reported :return: default number of samples (files) to store on a unique set of title/series being reported
with different iteration counter. This is used to make sure users do not end up exploding storage with different iteration counters. This is used to make sure users do not end up exploding storage
on server storage side. on server storage side.
""" """
if self._default_max_sample_history is not None: if self._default_max_sample_history is not None:

3
clearml/model.py
View File

@ -1460,8 +1460,7 @@ class OutputModel(BaseModel):
:param str register_uri: The URI of an already uploaded weights file. The URI must be valid. Specify :param str register_uri: The URI of an already uploaded weights file. The URI must be valid. Specify
``register_uri`` or ``weights_filename``, but not both. ``register_uri`` or ``weights_filename``, but not both.
:param int iteration: The iteration number. :param int iteration: The iteration number.
:param bool update_comment: Update the model comment with the local weights file name (to maintain :param bool update_comment: Update the model comment with the local weights file name (to maintain provenance) (Optional)
provenance) (Optional)
- ``True`` - Update model comment (Default) - ``True`` - Update model comment (Default)
- ``False`` - Do not update - ``False`` - Do not update