From e695251dd4faa774d6d26ad6dec1fca468055306 Mon Sep 17 00:00:00 2001
From: allegroai <>
Date: Tue, 13 Sep 2022 15:05:28 +0300
Subject: [PATCH] Add a single metric reporting example

---
 examples/reporting/single_scalar_reporting.py | 36 +++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 examples/reporting/single_scalar_reporting.py

diff --git a/examples/reporting/single_scalar_reporting.py b/examples/reporting/single_scalar_reporting.py
new file mode 100644
index 00000000..c9556a2b
--- /dev/null
+++ b/examples/reporting/single_scalar_reporting.py
@@ -0,0 +1,36 @@
+# ClearML - Example of manual single value scalars reporting
+#
+from clearml import Task
+
+
+def main():
+    # Connecting ClearML with the current process,
+    # from here on everything is logged automatically
+    task = Task.init(project_name="examples", task_name="Scalar reporting (Single Value)")
+
+    # Get the task logger,
+    # You can also call Task.current_task().get_logger() from anywhere in your code.
+    logger = task.get_logger()
+
+    # report scalars
+    logger.report_single_value(name="metric_A", value=125)
+    logger.report_single_value(name="metric_B", value=305.95)
+    logger.report_single_value(name="metric_C", value=486)
+
+    # force flush reports
+    # If flush is not called, reports are flushed in the background every couple of seconds,
+    # and at the end of the process execution
+    logger.flush(wait=True)
+
+    # get scalars
+    # Getting one metric
+    metric_B = task.get_reported_single_value('metric_B')
+    print('metric_B is', metric_B)
+
+    # Getting all metrics at once
+    metric_all = task.get_reported_single_values()
+    print('All metrics', metric_all)
+
+
+if __name__ == "__main__":
+    main()