expand on docstring

sethah · Feb 13, 2018 · 3c86317 · 3c86317
1 parent e448019
commit 3c86317
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/python/mxnet/metric.py b/python/mxnet/metric.py
@@ -477,7 +477,9 @@ def update(self, labels, preds):
 
 class _BinaryClassificationMixin(object):
     """
-    Private mixin for keeping track of TPR, FPR, TNR, FNR counts for a classification metric.
+    Private mixin for classification metrics. True/false positive rate and true/false negative
+    rate are sufficient statistics for various concrete metrics. This class provides the machinery
+    to track those statistics across mini-batches of (label, prediction) pairs.
     """
 
     def __init__(self):