aboutsummaryrefslogtreecommitdiff
path: root/doc/source/api/output.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/api/output.rst')
-rw-r--r--doc/source/api/output.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/source/api/output.rst b/doc/source/api/output.rst
index 5aea51ec..34c8b1ff 100644
--- a/doc/source/api/output.rst
+++ b/doc/source/api/output.rst
@@ -497,6 +497,11 @@ A :class:`Metric` has the following attributes:
or they may have been added by the workload to help distinguish between
otherwise identical metrics.
+``label``
+ This is a string constructed from the name and classifiers, to provide a
+ more unique identifier, e.g. for grouping values across iterations. The
+ format is in the form ``name/cassifier1=value1/classifier2=value2/...``.
+
:class:`Artifact`
-----------------