2021-05-13 23:48:51 +00:00
---
title: Logger
---
The ClearML **Logger** object is used to report experiments' results such as metrics, graphs, and debug samples. It is a
member of the [Task ](task.md ) object.
ClearML integrates with the leading visualization libraries, and automatically captures reports to them.
## Types of Logged Results
2022-01-18 11:23:47 +00:00
ClearML supports four types of reports:
2021-05-13 23:48:51 +00:00
- Text - Mostly captured automatically from stdout and stderr but can be logged manually.
- Scalars - Time series data. X-axis is always a sequential number, usually iterations but can be epochs or others.
- Plots - General graphs and diagrams, such as histograms, confusion matrices line plots, and custom plotly charts.
- Debug Samples - Images, audio, and videos. Can be reported per iteration.
## Automatic Reporting
2021-09-01 06:41:27 +00:00
ClearML automatically captures metrics reported to tools, such as TensorBoard and Matplotlib, with no additional code
2021-05-13 23:48:51 +00:00
necessary.
In addition, ClearML will capture and log everything written to standard output, from debug messages to errors to
library warning messages.
GPU, CPU, Memory and Network information is also automatically captured.
2021-09-01 06:41:27 +00:00
### Supported Packages
- [TensorBoard ](https://www.tensorflow.org/tensorboard )
- [TensorBoardX ](https://github.com/lanpa/tensorboardX )
- [Matplotlib ](https://matplotlib.org/ )
### Automatic Reporting Examples
Check out some of ClearML's automatic reporting examples for supported packages:
* TensorBoard
* [TensorBoard PR Curve ](../guides/frameworks/tensorflow/tensorboard_pr_curve.md ) - logging TensorBoard outputs and
TensorFlow flags
* [TensorBoard Toy ](../guides/frameworks/tensorflow/tensorboard_toy.md ) - logging TensorBoard histograms, scalars, images, text, and
TensorFlow flags
* [Tensorboard with PyTorch ](../guides/frameworks/pytorch/pytorch_tensorboard.md ) - logging TensorBoard scalars, debug samples, and text integrated into
code that uses PyTorch
2021-12-19 10:34:06 +00:00
* TensorBoardX
* [TensorBoardX with Pytorch ](../guides/frameworks/tensorboardx/tensorboardx.md ) - logging TensorBoardX scalars, debug
2021-09-01 06:41:27 +00:00
samples, and text in code using PyTorch
2021-12-19 10:34:06 +00:00
* [MegEngine MNIST ](../guides/frameworks/megengine/megengine_mnist.md ) - logging scalars using TensorBoardX's `SummaryWriter`
2021-09-01 06:41:27 +00:00
* Matplotlib
2021-11-04 09:21:05 +00:00
* [Matplotlib ](../guides/frameworks/matplotlib/matplotlib_example.md ) - logging scatter diagrams plotted with Matplotlib
2021-09-01 06:41:27 +00:00
* [Matplotlib with PyTorch ](../guides/frameworks/pytorch/pytorch_matplotlib.md ) - logging debug images shown
by Matplotlib
2021-05-13 23:48:51 +00:00
## Manual Reporting
ClearML also supports manually reporting multiple types of metrics and plots, such as line plots, histograms, and even plotly
charts.
The object used for reporting metrics is called **logger** and is obtained by calling
```python
logger = task.get_logger()
```
2021-09-01 06:41:27 +00:00
### Media Reporting
2021-05-13 23:48:51 +00:00
ClearML also supports reporting media (such as audio, video and images) for every iteration.
This section is mostly used for debugging. It's recommended to use [artifacts ](artifacts.md#artifacts ) for storing script
outputs that would be used later on.
2021-12-26 07:26:38 +00:00
Only the last X results of each title / series are saved to prevent overloading the server.
2021-05-13 23:48:51 +00:00
See details in [Logger.report_media ](../references/sdk/logger.md#report_media ).
2021-09-01 06:41:27 +00:00
### Explicit Reporting Examples
Check out ClearML's explicit reporting examples for various types of results:
- [Text ](../guides/reporting/text_reporting.md )
- [Scalars ](../guides/reporting/scalar_reporting.md )
- Plots
- [2d plots ](../guides/reporting/scatter_hist_confusion_mat_reporting.md )
- Histograms
- Confusion matrices
- Scatter plots
- [3d plots ](../guides/reporting/3d_plots_reporting.md )
- Surface plots
- Scatter plots
- [Tables ](../guides/reporting/pandas_reporting.md )
- Pandas DataFrames
- CSV file
- [Matplotlib figures ](../guides/reporting/manual_matplotlib_reporting.md )
- [Plotly figures ](../guides/reporting/plotly_reporting.md )
- Debug Samples
- [Images ](../guides/reporting/image_reporting.md )
- [HTML ](../guides/reporting/html_reporting.md )
- [Media - images, audio, video ](../guides/reporting/media_reporting.md )
- Explicit reporting in Jupyter Notebook [example ](../guides/reporting/clearml_logging_example.md )
