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

Small edits (#257)

Browse Source
This commit is contained in:
pollfly
2022-05-22 10:27:30 +03:00
committed by GitHub
parent bd1c132578
commit c20e9ef111
57 changed files with 129 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/guides/reporting/3d_plots_reporting.md
View File

@@ -7,7 +7,7 @@ example demonstrates reporting a series as a surface plot and as a 3D scatter pl
When the script runs, it creates an experiment named `3D plot reporting`, which is associated with the `examples` project.
ClearML reports these plots in the **ClearML Web UI** **>** experiment page **>** **RESULTS** tab **>** **PLOTS** sub-tab.
ClearML reports these plots in the **ClearML Web UI** **>** experiment page **>** **PLOTS** tab.
## Surface Plot
@@ -27,7 +27,7 @@ Logger.current_logger().report_surface(
zaxis="title Z",
)
```
Visualize the reported surface plot in **RESULTS** **>** **PLOTS**.
Visualize the reported surface plot in **PLOTS**.
![Surface plot](../../img/examples_reporting_02.png)
@@ -49,5 +49,5 @@ Logger.current_logger().report_scatter3d(
)
```
Visualize the reported 3D scatter plot in **RESULTS** **>** **PLOTS**.
Visualize the reported 3D scatter plot in **PLOTS**.
![3d scatter plot](../../img/examples_reporting_01.png)

6
docs/guides/reporting/clearml_logging_example.md
View File

@@ -18,7 +18,7 @@ In the ``clearml`` GitHub repository, this example includes a clickable icon to
## Scalars
To reports scalars, call the [Logger.report_scalar](../../references/sdk/logger.md#report_scalar)
method. The scalar plots appear in the **web UI** in **RESULTS** **>** **SCALARS**.
method. The scalar plots appear in the **web UI** in **SCALARS**.
```python
# report two scalar series on two different graphs
@@ -40,7 +40,7 @@ for i in range(10):
## Plots
Plots appear in **RESULTS** **>** **PLOTS**.
Plots appear in **PLOTS**.
### 2D Plots
@@ -171,7 +171,7 @@ logger.report_histogram(
## Media
Report audio, HTML, image, and video by calling the [Logger.report_media](../../references/sdk/logger.md#report_media)
method using the `local_path` parameter. They appear in **RESULTS** **>** **DEBUG SAMPLES**.
method using the `local_path` parameter. They appear in **DEBUG SAMPLES**.
The media for these examples is downloaded using the [StorageManager.get_local_copy](../../references/sdk/storage.md#storagemanagerget_local_copy)
method.

7
docs/guides/reporting/explicit_reporting.md
View File

@@ -290,10 +290,9 @@ python pytorch_mnist_tutorial.py
1. In the **ARTIFACTS** tab, **DATA AUDIT** section, click **Test_Loss_Correct**. The registered Pandas DataFrame appears,
including the file path, size, hash, metadata, and a preview.
1. In the **OTHER** section, click **Loss**. The uploaded numpy array appears, including its related information.
1. Click the **RESULTS** tab.
1. Click the **CONSOLE** sub-tab, and see the debugging message showing the Pandas DataFrame sample.
1. Click the **SCALARS** sub-tab, and see the scalar plots for epoch logging loss.
1. Click the **PLOTS** sub-tab, and see the confusion matrix and histogram.
1. Click the **CONSOLE** tab, and see the debugging message showing the Pandas DataFrame sample.
1. Click the **SCALARS** tab, and see the scalar plots for epoch logging loss.
1. Click the **PLOTS** tab, and see the confusion matrix and histogram.
## Next Steps

4
docs/guides/reporting/html_reporting.md
View File

@@ -6,8 +6,8 @@ The [html_reporting.py](https://github.com/allegroai/clearml/blob/master/example
demonstrates reporting local HTML files and HTML by URL, using the [Logger.report_media](../../references/sdk/logger.md#report_media)
method.
ClearML reports these HTML debug samples in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>**
**DEBUG SAMPLES** sub-tab.
ClearML reports these HTML debug samples in the **ClearML Web UI** **>** experiment details **>**
**DEBUG SAMPLES** tab.
When the script runs, it creates an experiment named `html samples reporting`, which is associated with the `examples` project.

4
docs/guides/reporting/image_reporting.md
View File

@@ -48,8 +48,8 @@ Logger.current_logger().report_image(
)
```
ClearML reports these images as debug samples in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab
**>** **DEBUG SAMPLES** sub-tab.
ClearML reports these images as debug samples in the **ClearML Web UI** **>** experiment details **>**
**DEBUG SAMPLES** tab.
![image](../../img/examples_reporting_07.png)

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

@@ -8,7 +8,7 @@ example demonstrates using ClearML to log plots and images generated by Matplotl
## Plots
The Matplotlib and Seaborn plots that are reported using the [Logger.report_matplotlib_figure](../../references/sdk/logger.md#report_matplotlib_figure)
method appear in the experiment’s **RESULTS** **>** **PLOTS**.
method appear in the experiment’s **PLOTS**.
![Experiment Matplotlib plots](../../img/manual_matplotlib_reporting_01.png)
@@ -17,6 +17,6 @@ method appear in the experiment’s **RESULTS** **>** **PLOTS**.
## Debug Samples
Matplotlib figures can be logged as images by using the [Logger.report_matplotlib_figure](../../references/sdk/logger.md#report_matplotlib_figure)
method, and passing `report_image=True`. The images are stored in the experiment’s **RESULTS > DEBUG SAMPLES**.
method, and passing `report_image=True`. The images are stored in the experiment’s **DEBUG SAMPLES**.
![Experiment debug sample](../../img/manual_matplotlib_reporting_03.png)

8
docs/guides/reporting/media_reporting.md
View File

@@ -13,8 +13,8 @@ ClearML uploads media to the bucket specified in the ClearML configuration file
(storage for [artifacts](../../clearml_sdk/task_sdk.md#setting-upload-destination) is different). Set credentials for storage in the ClearML
[configuration file](../../configs/clearml_conf.md).
ClearML reports media in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **DEBUG SAMPLES**
sub-tab.
ClearML reports media in the **ClearML Web UI** **>** experiment details **>** **DEBUG SAMPLES**
tab.
When the script runs, it creates an experiment named `audio and video reporting`, which is associated with the `examples`
project.
@@ -38,7 +38,7 @@ Logger.current_logger().report_media(
)
```
The reported audio can be viewed in the **DEBUG SAMPLES** sub-tab. Double click a thumbnail, and the audio player opens.
The reported audio can be viewed in the **DEBUG SAMPLES** tab. Double click a thumbnail, and the audio player opens.
![image](../../img/examples_reporting_08.png)
@@ -55,6 +55,6 @@ Logger.current_logger().report_media(
)
```
The reported video can be viewed in the **DEBUG SAMPLES** sub-tab. Double click a thumbnail, and the video player opens.
The reported video can be viewed in the **DEBUG SAMPLES** tab. Double click a thumbnail, and the video player opens.
![image](../../img/examples_reporting_09.png)

4
docs/guides/reporting/pandas_reporting.md
View File

@@ -4,8 +4,8 @@ title: Tables Reporting (Pandas and CSV Files)
The [pandas_reporting.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/pandas_reporting.py) example demonstrates reporting tabular data from Pandas DataFrames and CSV files as tables.
ClearML reports these tables in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **PLOTS**
sub-tab.
ClearML reports these tables in the **ClearML Web UI** **>** experiment details **>** **PLOTS**
tab.
When the script runs, it creates an experiment named `table reporting`, which is associated with the `examples` project.

4
docs/guides/reporting/plotly_reporting.md
View File

@@ -33,7 +33,7 @@ task.get_logger().report_plotly(
When the script runs, it creates an experiment named `plotly reporting`, which is associated with the examples project.
ClearML reports Plotly plots in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **PLOTS**
sub-tab.
ClearML reports Plotly plots in the **ClearML Web UI** **>** experiment details **>** **PLOTS**
tab.
![image](../../img/examples_reporting_13.png)

4
docs/guides/reporting/scalar_reporting.md
View File

@@ -3,8 +3,8 @@ title: Scalars Reporting
---
The [scalar_reporting.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/scalar_reporting.py) script
demonstrates explicit scalar reporting. ClearML reports scalars in the **ClearML Web UI** **>** experiment details **>**
**RESULTS** tab **>** **SCALARS** sub-tab.
demonstrates explicit scalar reporting. ClearML reports scalars in the **ClearML Web UI** **>** experiment details
**>** **SCALARS** tab.
When the script runs, it creates an experiment named `scalar reporting`, which is associated with the `examples` project.

2
docs/guides/reporting/scatter_hist_confusion_mat_reporting.md
View File

@@ -8,7 +8,7 @@ example demonstrates reporting series data in the following 2D formats:
* [Confusion matrices](#confusion-matrices)
* [Scatter plots](#2d-scatter-plots)
ClearML reports these tables in the **ClearML Web UI**, experiment details **>** **RESULTS** tab **>** **PLOTS** sub-tab.
ClearML reports these tables in the **ClearML Web UI**, experiment details **>** **PLOTS** tab.
When the script runs, it creates an experiment named `2D plots reporting`, which is associated with the `examples` project.

2
docs/guides/reporting/text_reporting.md
View File

@@ -6,7 +6,7 @@ The [text_reporting.py](https://github.com/allegroai/clearml/blob/master/example
demonstrates reporting explicit text, by calling the [Logger.report_text](../../references/sdk/logger.md#report_text)
method.
ClearML reports these tables in the **ClearML Web UI**, experiment details, **RESULTS** tab, **CONSOLE** sub-tab.
ClearML reports these tables in the **ClearML Web UI**, experiment details, **CONSOLE** tab.
When the script runs, it creates an experiment named `text reporting`, which is associated with the `examples` project.