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 1 Packages Projects Releases Wiki Activity

Edit docstrings (#1084)

Browse Source
This commit is contained in:
pollfly
2023-07-25 12:19:24 +03:00
committed by GitHub
parent 09363b0d30
commit c451589298
6 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
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
@@ -819,7 +819,7 @@ def report_surface(self, title, series, matrix, iteration, xlabels=None, ylabels
### Images
Use to report an image and upload its contents to the bucket specified in the **ClearML** configuration file,
or a [a default upload destination](#set-default-upload-destination), if you set a default.
or a [default upload destination](#set-default-upload-destination), if you set a default.
First [get the current logger](#get-the-current-logger) and then use it (see an [example script](https://github.com/allegroai/clearml/blob/master/examples/manual_reporting.py)) with the following method.
@@ -925,13 +925,13 @@ 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
In order for **ClearML** to log a dictionary of parameters, use the `Task.connect` method.
For example, to log the hyper-parameters <code>learning_rate</code>, <code>batch_size</code>, <code>display_step</code>, <code>model_path</code>, <code>n_hidden_1</code>, and <code>n_hidden_2</code>:
For example, to log the hyperparameters <code>learning_rate</code>, <code>batch_size</code>, <code>display_step</code>, <code>model_path</code>, <code>n_hidden_1</code>, and <code>n_hidden_2</code>:
```python
# Create a dictionary of parameters