From 25a26f1a0bb74c0e41b18426b94b150fb32358f7 Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Wed, 9 Aug 2023 14:35:38 +0300
Subject: [PATCH] Edit tensorboardX logging control (#638)

---
 docs/integrations/tensorboard.md  |  2 ++
 docs/integrations/tensorboardx.md | 21 +++++++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/docs/integrations/tensorboard.md b/docs/integrations/tensorboard.md
index d69a5284..c88037d7 100644
--- a/docs/integrations/tensorboard.md
+++ b/docs/integrations/tensorboard.md
@@ -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.
 
diff --git a/docs/integrations/tensorboardx.md b/docs/integrations/tensorboardx.md
index 9c37320a..0bd9e426 100644
--- a/docs/integrations/tensorboardx.md
+++ b/docs/integrations/tensorboardx.md
@@ -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.