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

Fix docstrings

Browse Source
This commit is contained in:
allegroai 2020-09-05 16:30:00 +03:00
parent fae11edf1b
commit 86aa3aaa98
7 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
setup.py
View File

@ -43,7 +43,7 @@ setup(
author_email='trains@allegro.ai',
license='Apache License 2.0',
classifiers=[
# How mature is this project? Common values are
# How mature is this project. Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable

12
trains/automation/optimization.py
View File

@ -47,7 +47,7 @@ class Objective(object):
- ``max``
- ``min``
:param bool extremum: Return the global minimum / maximum reported metric value?
:param bool extremum: Return the global minimum / maximum reported metric value
The values are:
@ -837,7 +837,7 @@ class HyperParameterOptimizer(object):
default is ``None``, indicating no time limit.
:param float compute_time_limit: The maximum compute time in minutes. When time limit is exceeded,
all jobs aborted. (Optional)
:param bool auto_connect_task: Store optimization arguments and configuration in the Task?
:param bool auto_connect_task: Store optimization arguments and configuration in the Task
The values are:
@ -847,7 +847,7 @@ class HyperParameterOptimizer(object):
- ``False`` - Do not store with Task.
:param bool always_create_task: Always create a new Task?
:param bool always_create_task: Always create a new Task
The values are:
@ -1045,7 +1045,7 @@ class HyperParameterOptimizer(object):
def is_active(self):
# type: () -> bool
"""
Is the optimization procedure active (still running)?
Is the optimization procedure active (still running)
The values are:
@ -1062,7 +1062,7 @@ class HyperParameterOptimizer(object):
def is_running(self):
# type: () -> bool
"""
Is the optimization controller is running?
Is the optimization controller is running
The values are:
@ -1141,7 +1141,7 @@ class HyperParameterOptimizer(object):
def reached_time_limit(self):
# type: () -> bool
"""
Did the optimizer reach the time limit?
Did the optimizer reach the time limit
The values are:

4
trains/automation/parameters.py
View File

@ -129,7 +129,7 @@ class UniformParameterRange(Parameter):
:param float min_value: The minimum sample to use for uniform random sampling.
:param float max_value: The maximum sample to use for uniform random sampling.
:param float step_size: If not ``None``, set step size (quantization) for value sampling.
:param bool include_max_value: Range includes the ``max_value``?
:param bool include_max_value: Range includes the ``max_value``
The values are:
@ -185,7 +185,7 @@ class UniformIntegerParameterRange(Parameter):
:param int min_value: The minimum sample to use for uniform random sampling.
:param int max_value: The maximum sample to use for uniform random sampling.
:param int step_size: The default step size is ``1``.
:param bool include_max_value: Range includes the ``max_value``?
:param bool include_max_value: Range includes the ``max_value``
The values are:

2
trains/backend_interface/model.py
View File

@ -467,7 +467,7 @@ class Model(IdObjectBase, AsyncManagerMixin, _StorageUriMixin):
Clone this model into a new model.
:param name: Name for the new model
:param comment: Optional comment for the new model
:param child: Should the new model be a child of this model? (default True)
:param child: Should the new model be a child of this model (default True)
:return: The new model's ID
"""
data = self.data

2
trains/backend_interface/task/log.py
View File

@ -48,7 +48,7 @@ class TaskHandler(BufferingHandler):
def shouldFlush(self, record):
"""
Should the handler flush its buffer?
Should the handler flush its buffer
Returns true if the buffer is up to capacity. This method can be
overridden to implement custom flushing strategies.

16
trains/logger.py
View File

@ -109,7 +109,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:
@ -358,7 +358,7 @@ class Logger(object):
- ``markers``
- ``lines+markers``
:param bool reverse_xaxis: Reverse the x-axis?
:param bool reverse_xaxis: Reverse the x-axis
The values are:
@ -510,7 +510,7 @@ class Logger(object):
logger.report_scatter3d(title="example_scatter_3d", series="series_xyz", iteration=1, scatter=scatter3d,
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:
@ -773,7 +773,7 @@ class Logger(object):
:param int 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
(default=``5``).
:param bool delete_after_upload: After the upload, delete the local copy of the image?
:param bool delete_after_upload: After the upload, delete the local copy of the image
The values are:
@ -863,7 +863,7 @@ class Logger(object):
:param file_extension: A file extension to use when ``stream`` is passed.
:param int max_history: The maximum number of media files to store per metric/variant combination
use negative value for unlimited. default is set in global configuration (default=5)
:param bool delete_after_upload: After the file is uploaded, delete the local copyu?
:param bool delete_after_upload: After the file is uploaded, delete the local copy
- ``True`` - Delete
- ``False`` - Do not delete
@ -1053,7 +1053,7 @@ class Logger(object):
"""
Group together TensorBoard scalars that do not have a title, or assign a title/series with the same tag.
:param group_scalars: Group TensorBoard scalars without a title?
:param group_scalars: Group TensorBoard scalars without a title
The values are:
@ -1070,7 +1070,7 @@ class Logger(object):
"""
Group TensorBoard scalar series together or in separate plots.
:param single_series: Group TensorBoard scalar series together?
:param single_series: Group TensorBoard scalar series together
The values are:
@ -1093,7 +1093,7 @@ class Logger(object):
:param str msg: text to print to the console (always send to the backend and displayed in console)
:param level: logging level, default: logging.INFO
:type level: Logging Level
:param bool omit_console: Omit the console output, and only send the ``msg`` value to the log?
:param bool omit_console: Omit the console output, and only send the ``msg`` value to the log
- ``True`` - Omit the console output.
- ``False`` - Print the console output. (default)

14
trains/model.py
View File

@ -264,7 +264,7 @@ class BaseModel(object):
Download the base model package into a temporary directory (extract the files), or return a list of the
locally stored filenames.
:param bool return_path: Return the model weights or a list of filenames? (Optional)
:param bool return_path: Return the model weights or a list of filenames (Optional)
- ``True`` - Download the model weights into a temporary directory, and return the temporary directory path.
- ``False`` - Return a list of the locally stored filenames. (Default)
@ -486,13 +486,13 @@ class InputModel(Model):
:type tags: list(str)
:param str comment: A comment / description for the model. (Optional)
:type comment str:
:param is_package: Is the imported weights file is a package? (Optional)
:param is_package: Is the imported weights file is a package (Optional)
- ``True`` - Is a package. Add a package tag to the model.
- ``False`` - Is not a package. Do not add a package tag. (Default)
:type is_package: bool
:param bool create_as_published: Set the model's status to Published? (Optional)
:param bool create_as_published: Set the model's status to Published (Optional)
- ``True`` - Set the status to Published.
- ``False`` - Do not set the status to Published. The status will be Draft. (Default)
@ -600,7 +600,7 @@ class InputModel(Model):
.. note::
If a model with the exact same URL exists, it will be used, and all other arguments will be ignored.
:param bool load_archived: Load archived models?
:param bool load_archived: Load archived models
- ``True`` - Load the registered Model, if it is archived.
- ``False`` - Ignore archive models.
@ -1048,7 +1048,7 @@ class OutputModel(BaseModel):
is the previously used URI. (Optional)
:param str target_filename: The newly created filename in the storage destination location. The default value
is the ``weights_filename`` value. (Optional)
:param bool auto_delete_file: Delete the temporary file after uploading? (Optional)
:param bool auto_delete_file: Delete the temporary file after uploading (Optional)
- ``True`` - Delete (Default)
- ``False`` - Do not delete
@ -1057,7 +1057,7 @@ class OutputModel(BaseModel):
``register_uri`` or ``weights_filename``, but not both.
:param int iteration: The iteration number.
: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)
- ``False`` - Do not update
@ -1182,7 +1182,7 @@ class OutputModel(BaseModel):
is the previously used URI. (Optional)
:param str target_filename: The newly created filename in the storage destination URI location. The default
is the value specified in the ``weights_filename`` parameter. (Optional)
:param bool auto_delete_file: Delete temporary file after uploading? (Optional)
:param bool auto_delete_file: Delete temporary file after uploading (Optional)
- ``True`` - Delete (Default)
- ``False`` - Do not delete