clearml-docs/docs/guides/frameworks/tensorboardx/tensorboardx.md

---
title: TensorBoardX with PyTorch
---

The [pytorch_tensorboardX.py](https://github.com/clearml/clearml/blob/master/examples/frameworks/tensorboardx/pytorch_tensorboardX.py) 
example demonstrates the integration of ClearML into code that uses PyTorch and TensorBoardX. 

The script does the following:
* Trains a simple deep neural network on the PyTorch built-in [MNIST](https://pytorch.org/vision/stable/datasets.html#mnist) dataset
* Creates a task named `pytorch with tensorboardX` in the `examples` project
* ClearML automatically captures scalars and text logged using the TensorBoardX `SummaryWriter` object, and 
  the model created by PyTorch 

## Scalars

The loss and accuracy metric scalar plots appear in the task's page in the **ClearML web UI**, under
**SCALARS**. The also includes resource utilization plots, which are titled **:monitor: machine**.

![Scalars](../../../img/examples_pytorch_tensorboardx_03.png#light-mode-only)
![Scalars](../../../img/examples_pytorch_tensorboardx_03_dark.png#dark-mode-only)

## Hyperparameters

ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** 
**HYPERPARAMETERS** **>** **Args**.

![Hyperparameters](../../../img/examples_pytorch_tensorboardx_01.png#light-mode-only)
![Hyperparameters](../../../img/examples_pytorch_tensorboardx_01_dark.png#dark-mode-only)

## Console

Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.

![Console log](../../../img/examples_pytorch_tensorboardx_02.png#light-mode-only)
![Console log](../../../img/examples_pytorch_tensorboardx_02_dark.png#dark-mode-only)

## Artifacts

Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks 
models and any snapshots created using PyTorch. 

![Artifacts](../../../img/examples_pytorch_tensorboardx_04.png#light-mode-only)
![Artifacts](../../../img/examples_pytorch_tensorboardx_04_dark.png#dark-mode-only)

Clicking on the model's name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can 
view the model's details and access the model.

![Model details](../../../img/examples_pytorch_tensorboardx_model.png#light-mode-only)
![Model details](../../../img/examples_pytorch_tensorboardx_model_dark.png#dark-mode-only)
Initial commit 2021-05-13 23:48:51 +00:00			`---`
Rewrite TensorBoard and TensorboardX integration pages (#633) 2023-08-08 16:13:00 +00:00			`title: TensorBoardX with PyTorch`
Initial commit 2021-05-13 23:48:51 +00:00			`---`

Update links 2025-02-13 08:48:26 +00:00			`The [pytorch_tensorboardX.py](https://github.com/clearml/clearml/blob/master/examples/frameworks/tensorboardx/pytorch_tensorboardX.py)`
Example edits (#158) 2022-01-13 07:42:36 +00:00			`example demonstrates the integration of ClearML into code that uses PyTorch and TensorBoardX.`
Initial commit 2021-05-13 23:48:51 +00:00
			`The script does the following:`
Small edits (#161) 2022-01-16 09:13:53 +00:00			`* Trains a simple deep neural network on the PyTorch built-in [MNIST](https://pytorch.org/vision/stable/datasets.html#mnist) dataset`
Change terminology (#1028) 2025-02-06 15:31:11 +00:00			* Creates a task named `pytorch with tensorboardX` in the `examples` project
Example edits (#158) 2022-01-13 07:42:36 +00:00			* ClearML automatically captures scalars and text logged using the TensorBoardX `SummaryWriter` object, and
Small edits (#161) 2022-01-16 09:13:53 +00:00			`the model created by PyTorch`
Initial commit 2021-05-13 23:48:51 +00:00
			`## Scalars`

Change terminology (#1028) 2025-02-06 15:31:11 +00:00			`The loss and accuracy metric scalar plots appear in the task's page in the ClearML web UI, under`
Small edits (#257) 2022-05-22 07:27:30 +00:00			`SCALARS. The also includes resource utilization plots, which are titled :monitor: machine.`
Initial commit 2021-05-13 23:48:51 +00:00
update sklearn, tensorboardx example images 2025-03-10 12:55:42 +00:00			`![Scalars](../../../img/examples_pytorch_tensorboardx_03.png#light-mode-only)`
			`![Scalars](../../../img/examples_pytorch_tensorboardx_03_dark.png#dark-mode-only)`
Initial commit 2021-05-13 23:48:51 +00:00
			`## Hyperparameters`

Small edits (#260) 2022-05-26 06:54:41 +00:00			ClearML automatically logs command line options defined with `argparse`. They appear in CONFIGURATION >
Small edits (#434) 2023-01-12 10:49:55 +00:00			`HYPERPARAMETERS > Args.`
Initial commit 2021-05-13 23:48:51 +00:00
update sklearn, tensorboardx example images 2025-03-10 12:55:42 +00:00			`![Hyperparameters](../../../img/examples_pytorch_tensorboardx_01.png#light-mode-only)`
			`![Hyperparameters](../../../img/examples_pytorch_tensorboardx_01_dark.png#dark-mode-only)`
Initial commit 2021-05-13 23:48:51 +00:00
Update documentation 2021-05-18 22:31:01 +00:00			`## Console`
Initial commit 2021-05-13 23:48:51 +00:00
Small edits (#257) 2022-05-22 07:27:30 +00:00			`Text printed to the console for training progress, as well as all other console output, appear in CONSOLE.`
Initial commit 2021-05-13 23:48:51 +00:00
update sklearn, tensorboardx example images 2025-03-10 12:55:42 +00:00			`![Console log](../../../img/examples_pytorch_tensorboardx_02.png#light-mode-only)`
			`![Console log](../../../img/examples_pytorch_tensorboardx_02_dark.png#dark-mode-only)`
Initial commit 2021-05-13 23:48:51 +00:00
			`## Artifacts`

Change terminology (#1028) 2025-02-06 15:31:11 +00:00			`Models created by the task appear in the task's ARTIFACTS tab. ClearML automatically logs and tracks`
Example edits (#158) 2022-01-13 07:42:36 +00:00			`models and any snapshots created using PyTorch.`
Initial commit 2021-05-13 23:48:51 +00:00
update sklearn, tensorboardx example images 2025-03-10 12:55:42 +00:00			`![Artifacts](../../../img/examples_pytorch_tensorboardx_04.png#light-mode-only)`
			`![Artifacts](../../../img/examples_pytorch_tensorboardx_04_dark.png#dark-mode-only)`
Initial commit 2021-05-13 23:48:51 +00:00
Small edits (#676) 2023-10-01 07:31:48 +00:00			`Clicking on the model's name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can`
			`view the model's details and access the model.`
Initial commit 2021-05-13 23:48:51 +00:00
update sklearn, tensorboardx example images 2025-03-10 12:55:42 +00:00			`![Model details](../../../img/examples_pytorch_tensorboardx_model.png#light-mode-only)`
			`![Model details](../../../img/examples_pytorch_tensorboardx_model_dark.png#dark-mode-only)`
Initial commit 2021-05-13 23:48:51 +00:00