ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 13:21:46 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Edit tensorboardX logging control (#638)

Browse Source
This commit is contained in:
pollfly 2023-08-09 14:35:38 +03:00 committed by GitHub
parent a1520d5f7b
commit 25a26f1a0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/integrations/tensorboard.md
View File

@ -43,6 +43,8 @@ auto_connect_frameworks={
}
```
Note that the `tensorboard` key enables/disables automatic logging for both `TensorBoard` and `TensorboardX`.
## Manual Logging
To augment its automatic logging, ClearML also provides an explicit logging interface.

21
docs/integrations/tensorboardx.md
View File

@ -23,6 +23,27 @@ View the TensorboardX outputs in the [WebApp](../webapp/webapp_overview.md), in
![TensorboardX WebApp scalars](../img/examples_pytorch_tensorboardx_03.png)
## Automatic Logging Control
By default, when ClearML is integrated into your script, it captures all of your TensorboardX plots, images, metrics, videos, and text.
But, you may want to have more control over what your experiment logs.
To control a task's framework logging, use the `auto_connect_frameworks` parameter of [`Task.init()`](../references/sdk/task.md#taskinit).
Completely disable all automatic logging by setting the parameter to `False`. For finer grained control of logged
frameworks, input a dictionary, with framework-boolean pairs.
For example:
```python
auto_connect_frameworks={
'tensorboard': False,'matplotlib': False, 'tensorflow': False, 'pytorch': True,
'xgboost': False, 'scikit': True, 'fastai': True, 'lightgbm': False,
'hydra': True, 'detect_repository': True, 'tfdefines': True, 'joblib': True,
'megengine': True, 'jsonargparse': True, 'catboost': True
}
```
Note that the `tensorboard` key enables/disables automatic logging for both `TensorboardX` and `TensorBoard`.
## Manual Logging
To augment its automatic logging, ClearML also provides an explicit logging interface.