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

Small edits (#870)

Browse Source
This commit is contained in:
pollfly
2024-07-14 09:42:51 +03:00
committed by GitHub
parent 2a92231e82
commit b08ae93e9f
4 changed files with 41 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/integrations/ignite.md
View File

@@ -38,22 +38,22 @@ during training and validation.
Integrate ClearML with the following steps:
1. Create a `ClearMLLogger` object:
```python
from ignite.contrib.handlers.clearml_logger import *
```python
from ignite.contrib.handlers.clearml_logger import *
clearml_logger = ClearMLLogger(task_name="ignite", project_name="examples")
```
This creates a [ClearML Task](../fundamentals/task.md) called `ignite` in the `examples` project, which captures your
script's information, including Git details, uncommitted code, python environment.
clearml_logger = ClearMLLogger(task_name="ignite", project_name="examples")
```
This creates a [ClearML Task](../fundamentals/task.md) called `ignite` in the `examples` project, which captures your
script's information, including Git details, uncommitted code, python environment.
You can also pass the following parameters to the `ClearMLLogger` object:
* `task_type` – The type of experiment (see [task types](../fundamentals/task.md#task-types)).
* `report_freq` – The histogram processing frequency (handles histogram values every X calls to the handler). Affects
`GradsHistHandler` and `WeightsHistHandler` (default: 100).
* `histogram_update_freq_multiplier` – The histogram report frequency (report first X histograms and once every X
reports afterwards) (default: 10).
* `histogram_granularity` - Histogram sampling granularity (default: 50).
You can also pass the following parameters to the `ClearMLLogger` object:
* `task_type` – The type of experiment (see [task types](../fundamentals/task.md#task-types)).
* `report_freq` – The histogram processing frequency (handles histogram values every X calls to the handler). Affects
`GradsHistHandler` and `WeightsHistHandler` (default: 100).
* `histogram_update_freq_multiplier` – The histogram report frequency (report first X histograms and once every X
reports afterwards) (default: 10).
* `histogram_granularity` - Histogram sampling granularity (default: 50).
1. Attach the `ClearMLLogger` to output handlers to log metrics: