Update text reporting example
Some checks failed
CI / build (push) Has been cancelled

This commit is contained in:
Noam Wasersprung 2025-04-28 10:08:07 +03:00 committed by GitHub
commit f9ff5a5d8e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 35 additions and 4 deletions

View File

@ -3,15 +3,46 @@ title: Text Reporting
---
The [text_reporting.py](https://github.com/clearml/clearml/blob/master/examples/reporting/text_reporting.py) script
demonstrates reporting explicit text by calling [`Logger.report_text()`](../../references/sdk/logger.md#report_text).
ClearML reports the text in the **ClearML Web UI**, in the task's **CONSOLE** tab.
demonstrates reporting text output and samples.
When the script runs, it creates a task named `text reporting` in the `examples` project.
## Reporting Text to Console
To report text to the task console, call [`Logger.report_text()`](../../references/sdk/logger.md#report_text):
```python
# report text
Logger.current_logger().report_text("hello, this is plain text")
```
![image](../../img/examples_reporting_text.png)
Text reported with `Logger.report_text()` appears in the task's **CONSOLE** tab in the ClearML Web UI.
![Text to console](../../img/examples_reporting_text.png#light-mode-only)
![Text to console](../../img/examples_reporting_text_dark.png#dark-mode-only)
## Reporting Text as Debug Samples
To report longer text as a debug sample (e.g., logs, large text outputs, or structured text files),
use [`Logger.report_media()`](../../references/sdk/logger.md#report_media) with a text stream and `.txt` file extension:
```python
text_to_send = """
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Suspendisse ac justo ut dolor scelerisque posuere.
...
"""
Logger.current_logger().report_media(
title="text title",
series="text series",
iteration=1,
stream=six.StringIO(text_to_send),
file_extension=".txt",
)
```
Text samples appear in the task's **DEBUG SAMPLES** tab in the ClearML Web UI.
![Text debug sample](../../img/examples_reporting_text_debug.png#light-mode-only)
![Text debug sample](../../img/examples_reporting_text_debug_dark.png#dark-mode-only)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB