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

Merge script and ipynb example docs (#101)

Browse Source
This commit is contained in:
pollfly
2021-11-04 11:21:05 +02:00
committed by GitHub
parent 1960a5b632
commit 5e7e6fe7c4
7 changed files with 39 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/guides/frameworks/matplotlib/allegro_clearml_matplotlib_example.md
View File

@@ -1,32 +0,0 @@
---
title: Matplotlib - Jupyter Notebook
---
The [jupyter_matplotlib_example.ipynb](https://github.com/allegroai/clearml/blob/master/examples/frameworks/matplotlib/jupyter_matplotlib_example.ipynb)
example demonstrates the integration of **ClearML** into code running in Jupyter Notebook, which uses `matplotlib` to plot
scatter diagrams, and show images. **ClearML** automatically logs the diagrams and images. When the script runs, ClearML
creates an experiment named `Matplotlib example` which is associated with the `Colab notebooks` project.
:::note
In the ``clearml`` GitHub repository, this example includes a clickable icon to open the notebook in Google Colab.
:::
## Plots
The scatter plots appear in the **ClearML Web UI**, in **RESULTS** **>** **PLOTS**.
![image](../../../img/examples_matplotlib_example_01.png)
![image](../../../img/examples_matplotlib_example_02.png)
![image](../../../img/examples_matplotlib_example_03.png)
## Debug Samples
The images appear in **RESULTS** **>** **DEBUG SAMPLES**. Each debug sample image is associated with a metric.
![image](../../../img/examples_matplotlib_example_04.png)
View the debug sample in the image viewer.
![image](../../../img/examples_matplotlib_example_05.png)

19
docs/guides/frameworks/matplotlib/matplotlib_example.md
View File

@@ -2,10 +2,21 @@
title: Matplotlib
---
The [matplotlib_example.py](https://github.com/allegroai/clearml/blob/master/examples/frameworks/matplotlib/matplotlib_example.py)
example demonstrates integrating **ClearML** into code that uses `matplotlib` to plot scatter diagrams, and show images.
**ClearML** automatically logs the diagrams and images. When the script runs, it creates an experiment named `Matplotlib example`,
which is associated with the `examples` project.
The example below demonstrates integrating **ClearML** into code that uses `matplotlib` to plot scatter diagrams, and
show images. **ClearML** automatically logs the diagrams and images.
View the example in [script](https://github.com/allegroai/clearml/blob/master/examples/frameworks/matplotlib/matplotlib_example.py)
or in [Jupyter Notebook](https://github.com/allegroai/clearml/blob/master/examples/frameworks/matplotlib/jupyter_matplotlib_example.ipynb).
:::note
The example in [Jupyter Notebook](https://github.com/allegroai/clearml/blob/master/examples/frameworks/matplotlib/jupyter_matplotlib_example.ipynb),
includes a clickable icon to open the notebook in Google Colab.
:::
When the example runs, it creates an experiment named `Matplotlib example`,
which is associated with the `examples` project (in script) or the `Colab notebooks` project (in Jupyter Notebook).
## Plots