add multilabel f1 eval usage (#221)

huggingface · Aug 3, 2022 · 0b8be61 · 0b8be61
1 parent 1e67b71
commit 0b8be61
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/metrics/f1/f1.py b/metrics/f1/f1.py
@@ -78,6 +78,12 @@
         >>> results = f1_metric.compute(predictions=predictions, references=references, average=None)
         >>> print(results)
         {'f1': array([0.8, 0. , 0. ])}
+
+    Example 5-A multi-label example
+        >>> f1_metric = evaluate.load("f1", "multilabel")
+        >>> results = f1_metric.compute(predictions=[[0, 1, 1], [1, 1, 0]], references=[[0, 1, 1], [0, 1, 0]], average="macro")
+        >>> print(round(results['f1'], 2))
+        0.67
 """