clearml-docs/docs/guides/reporting/scalar_reporting.md

title
Scalars Reporting

The scalar_reporting.py script demonstrates explicit scalar reporting. ClearML reports scalars in the ClearML Web UI > task's SCALARS tab.

When the script runs, it creates a task named scalar reporting in the examples project.

Reporting Scalar Series

To report scalar series, call Logger.report_scalar(). To report more than one series on the same plot, use the same title argument. For different plots, use different title arguments.

# report two scalar series on the same graph
for i in range(100):
    Logger.current_logger().report_scalar(
        title="unified graph", series="series A", iteration=i, value=1./(i+1)
    )
    Logger.current_logger().report_scalar(
        title="unified graph", series="series B", iteration=i, value=10./(i+1)
    )
    
# report two scalar series on two different graphs
for i in range(100):
    Logger.current_logger().report_scalar(
        title="graph A", series="series A", iteration=i, value=1./(i+1)
    )
    Logger.current_logger().report_scalar(
        title="graph B", series="series B", iteration=i, value=10./(i+1)
    )

Reporting Single Scalar Values

To report single scalar values (individual metrics, not part of a series), use Logger.report_single_value().

# Report individual scalar values
Logger.current_logger().report_single_value(name="metric A", value=486)
Logger.current_logger().report_single_value(name="metric B", value=305.95)

Single value scalars are shown in the UI in the task's SCALARS tab under the Summary table.