DOC example of extracting true positive, false negative, etc. (scikit-learn#8469)

jnothman · maskani-moh · commit 3d2795b8fc1e · 2017-11-15T12:11:36.000-05:00
diff --git a/sklearn/metrics/classification.py b/sklearn/metrics/classification.py
@@ -236,6 +236,11 @@ def confusion_matrix(y_true, y_pred, labels=None, sample_weight=None):
            [0, 0, 1],
            [1, 0, 2]])
 
+    In the binary case, we can extract true positives, etc as follows:
+    >>> tn, fp, fn, tp = confusion_matrix([0, 1, 0, 1], [1, 1, 1, 0]).ravel()
+    >>> (tn, fp, fn, tp)
+    (0, 2, 1, 1)
+
     """
     y_type, y_true, y_pred = _check_targets(y_true, y_pred)
     if y_type not in ("binary", "multiclass"):
