ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-05-08 14:54:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

small edits

Browse Source
This commit is contained in:
revital 2023-07-25 12:08:07 +03:00
parent 4beadb0fff
commit 4cff63feb4
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
clearml/automation/parameters.py
View File

@ -35,14 +35,14 @@ class RandomSeed(object):
class Parameter(RandomSeed):
"""
The base hyper-parameter optimization object.
The base hyperparameter optimization object.
"""
_class_type_serialize_name = 'type'
def __init__(self, name):
# type: (Optional[str]) -> ()
"""
Create a new Parameter for hyper-parameter optimization
Create a new Parameter for hyperparameter optimization
:param str name: The new Parameter name. This is the parameter name that will be passed to a Task.
"""
@ -125,7 +125,7 @@ class UniformParameterRange(Parameter):
"""
Create a parameter to be sampled by the SearchStrategy
:param str name: The parameter name. Match the Task hyper-parameter name.
:param str name: The parameter name. Match the Task hyperparameter name.
: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.
@ -172,7 +172,7 @@ class UniformParameterRange(Parameter):
class LogUniformParameterRange(UniformParameterRange):
"""
Logarithmic uniform randomly sampled hyper-parameter object.
Logarithmic uniform randomly sampled hyperparameter object.
"""
def __init__(
@ -188,7 +188,7 @@ class LogUniformParameterRange(UniformParameterRange):
"""
Create a parameter to be sampled by the SearchStrategy
:param str name: The parameter name. Match the Task hyper-parameter name.
:param str name: The parameter name. Match the Task hyperparameter name.
:param float min_value: The minimum exponent sample to use for uniform random sampling.
:param float max_value: The maximum exponent sample to use for uniform random sampling.
:param float base: The base used to raise the sampled exponent.
@ -228,7 +228,7 @@ class UniformIntegerParameterRange(Parameter):
"""
Create a parameter to be sampled by the SearchStrategy.
:param str name: The parameter name. Match the task hyper-parameter name.
:param str name: The parameter name. Match the task hyperparameter name.
: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``.
@ -272,7 +272,7 @@ class UniformIntegerParameterRange(Parameter):
class DiscreteParameterRange(Parameter):
"""
Discrete randomly sampled hyper-parameter object.
Discrete randomly sampled hyperparameter object.
"""
def __init__(self, name, values=()):
@ -280,7 +280,7 @@ class DiscreteParameterRange(Parameter):
"""
Uniformly sample values form a list of discrete options.
:param str name: The parameter name. Match the task hyper-parameter name.
:param str name: The parameter name. Match the task hyperparameter name.
:param list values: The list/tuple of valid parameter values to sample from.
"""
super(DiscreteParameterRange, self).__init__(name=name)

4
docs/logger.md
View File

@ -12,7 +12,7 @@ Using the **ClearML** [Logger](https://github.com/allegroai/clearml/blob/master/
* [Surface diagrams](#surface-diagrams)
* [Images](#images)
* Track hyper-parameters and OS environment variables
* Track hyperparameters and OS environment variables
* Logging experiment parameter [dictionaries](#logging-experiment-parameter-dictionaries)
* Specifying [environment variables](#specifying-environment-variables-to-track) to track
@ -925,7 +925,7 @@ def report_image(self, title, series, iteration, local_path=None, matrix=None, m
</tbody>
</table>
## Hyper-parameters and Environment Variables
## Hyperparameters and Environment Variables
### Logging Experiment Parameter Dictionaries