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 (#690)

Browse Source
This commit is contained in:
pollfly
2023-10-11 12:29:56 +03:00
committed by GitHub
parent 3a4b10e43b
commit e6257d2843
9 changed files with 29 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -106,13 +106,12 @@ logger.report_surface(
### Confusion Matrices
Report confusion matrices by calling the [Logger.report_matrix](../../references/sdk/logger.md#report_matrix)
method.
Report confusion matrices by calling [`Logger.report_confusion_matrix()`](../../references/sdk/logger.md#report_confusion_matrix).
```python
# report confusion matrix
confusion = np.random.randint(10, size=(10, 10))
logger.report_matrix(
logger.report_confusion_matrix(
"example_confusion",
"ignored",
iteration=iteration,
@@ -126,8 +125,8 @@ logger.report_matrix(
### Histograms
Report histograms by calling the [Logger.report_histogram](../../references/sdk/logger.md#report_histogram)
method. To report more than one series on the same plot, use the same `title` argument.
Report histograms by calling [`Logger.report_histogram()`](../../references/sdk/logger.md#report_histogram).
To report more than one series on the same plot, use the same `title` argument.
```python
# report a single histogram
@@ -170,11 +169,10 @@ 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 **DEBUG SAMPLES**.
Report audio, HTML, image, and video by calling [`Logger.report_media()`](../../references/sdk/logger.md#report_media)
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.
The media for these examples is downloaded using [`StorageManager.get_local_copy()`](../../references/sdk/storage.md#storagemanagerget_local_copy).
For example, to download an image:
@@ -224,7 +222,7 @@ logger.report_media('video', 'big bunny', iteration=1, local_path=video_local_co
## Text
Report text messages by calling the [Logger.report_text](../../references/sdk/logger.md#report_text).
Report text messages by calling [`Logger.report_text()`](../../references/sdk/logger.md#report_text).
```python
logger.report_text("hello, this is plain text")

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

@@ -14,9 +14,9 @@ When the script runs, it creates an experiment named `2D plots reporting` in the
## Histograms
Report histograms by calling the [Logger.report_histogram](../../references/sdk/logger.md#report_histogram)
method. To report more than one series on the same plot, use same the `title` argument. For different plots, use different
`title` arguments. Specify the type of histogram with the `mode` parameter. The `mode` values are `group` (the default),
Report histograms by calling [`Logger.report_histogram()`](../../references/sdk/logger.md#report_histogram).
To report more than one series on the same plot, use same the `title` argument. For different plots, use different
`title` arguments. Specify the type of histogram with the `mode` parameter. The `mode` values are `group` (default),
`stack`, and `relative`.
```python
@@ -59,13 +59,12 @@ Logger.current_logger().report_histogram(
## Confusion Matrices
Report confusion matrices by calling the [Logger.report_matrix](../../references/sdk/logger.md#report_matrix)
method.
Report confusion matrices by calling [`Logger.report_confusion_matrix()`](../../references/sdk/logger.md#report_confusion_matrix).
```python
# report confusion matrix
confusion = np.random.randint(10, size=(10, 10))
Logger.current_logger().report_matrix(
Logger.current_logger().report_confusion_matrix(
"example_confusion",
"ignored",
iteration=iteration,
@@ -79,7 +78,7 @@ Logger.current_logger().report_matrix(
```python
# report confusion matrix with 0,0 is at the top left
Logger.current_logger().report_matrix(
Logger.current_logger().report_confusion_matrix(
"example_confusion_0_0_at_top",
"ignored",
iteration=iteration,
@@ -92,8 +91,8 @@ Logger.current_logger().report_matrix(
## 2D Scatter Plots
Report 2D scatter plots by calling the [Logger.report_scatter2d](../../references/sdk/logger.md#report_scatter2d)
method. Use the `mode` parameter to plot data points with lines (by default), markers, or both lines and markers.
Report 2D scatter plots by calling [`Logger.report_scatter2d()`](../../references/sdk/logger.md#report_scatter2d).
Use the `mode` parameter to plot data points with lines (by default), markers, or both lines and markers.
```python
scatter2d = np.hstack(