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

Update Matplotlib integration images

Browse Source
This commit is contained in:
revital 2025-03-19 10:55:17 +02:00
parent aff6306e87
commit b3298d82ab
8 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/guides/reporting/manual_matplotlib_reporting.md
View File

@ -10,13 +10,16 @@ example demonstrates using ClearML to log plots and images generated by Matplotl
The Matplotlib and Seaborn plots reported using [`Logger.report_matplotlib_figure()`](../../references/sdk/logger.md#report_matplotlib_figure) The Matplotlib and Seaborn plots reported using [`Logger.report_matplotlib_figure()`](../../references/sdk/logger.md#report_matplotlib_figure)
appear in the task's **PLOTS** tab. appear in the task's **PLOTS** tab.
![Task Matplotlib plots](../../img/manual_matplotlib_reporting_01.png) ![Task Matplotlib plots](../../img/manual_matplotlib_reporting_01.png#light-mode-only)
![Task Matplotlib plots](../../img/manual_matplotlib_reporting_01_dark.png#dark-mode-only)
![Task Seaborn plot](../../img/manual_matplotlib_reporting_02.png) ![Task Seaborn plot](../../img/manual_matplotlib_reporting_02.png#light-mode-only)
![Task Seaborn plot](../../img/manual_matplotlib_reporting_02_dark.png#dark-mode-only)
## Debug Samples ## Debug Samples
Matplotlib figures can be logged as images by using [`Logger.report_matplotlib_figure()`](../../references/sdk/logger.md#report_matplotlib_figure), Matplotlib figures can be logged as images by using [`Logger.report_matplotlib_figure()`](../../references/sdk/logger.md#report_matplotlib_figure),
and passing `report_image=True`. The images are displayed in the task's **DEBUG SAMPLES**. and passing `report_image=True`. The images are displayed in the task's **DEBUG SAMPLES**.
![Task debug sample](../../img/manual_matplotlib_reporting_03.png) ![Task debug sample](../../img/manual_matplotlib_reporting_03.png#light-mode-only)
![Task debug sample](../../img/manual_matplotlib_reporting_03_dark.png#dark-mode-only)

BIN
docs/img/manual_matplotlib_reporting_01.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 84 KiB

BIN
docs/img/manual_matplotlib_reporting_01_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 83 KiB

BIN
docs/img/manual_matplotlib_reporting_02.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 124 KiB

BIN
docs/img/manual_matplotlib_reporting_02_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 125 KiB

BIN
docs/img/manual_matplotlib_reporting_03.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 52 KiB

BIN
docs/img/manual_matplotlib_reporting_03_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

9
docs/integrations/matplotlib.md
View File

@ -28,7 +28,8 @@ This will create a ClearML Task that captures:
View captured Matplotlib plots and images in the [WebApp](../webapp/webapp_exp_track_visual.md), View captured Matplotlib plots and images in the [WebApp](../webapp/webapp_exp_track_visual.md),
in the task's **Plots** and **Debug Samples** tabs respectively. in the task's **Plots** and **Debug Samples** tabs respectively.
![Task plots](../img/examples_matplotlib_example_01.png) ![Task plots](../img/examples_matplotlib_example_01.png#light-mode-only)
![Task plots](../img/examples_matplotlib_example_01_dark.png#dark-mode-only)
## Automatic Logging Control ## Automatic Logging Control
By default, when ClearML is integrated into your script, it captures all of your matplotlib visualizations. By default, when ClearML is integrated into your script, it captures all of your matplotlib visualizations.
@ -67,12 +68,14 @@ plt.show()
The logged figure is displayed in the task's **Plots** tab. The logged figure is displayed in the task's **Plots** tab.
![Task Matplotlib plots](../img/manual_matplotlib_reporting_01.png) ![Task Matplotlib plots](../img/manual_matplotlib_reporting_01.png#light-mode-only)
![Task Matplotlib plots](../img/manual_matplotlib_reporting_01_dark.png#dark-mode-only)
Matplotlib figures can be logged as images by passing `report_image=True` to `Logger.report_matplotlib_figure()`. Matplotlib figures can be logged as images by passing `report_image=True` to `Logger.report_matplotlib_figure()`.
View the images in the task's **DEBUG SAMPLES** tab. View the images in the task's **DEBUG SAMPLES** tab.
![Task debug sample](../img/manual_matplotlib_reporting_03.png) ![Task debug sample](../img/manual_matplotlib_reporting_03.png#light-mode-only)
![Task debug sample](../img/manual_matplotlib_reporting_03_dark.png#dark-mode-only)
See [Manual Matplotlib Reporting](../guides/reporting/manual_matplotlib_reporting.md) example. See [Manual Matplotlib Reporting](../guides/reporting/manual_matplotlib_reporting.md) example.