Skip to content

Commit 020b148

Browse files
authored
Update metrics.rst -- say what bottom row of classification_report_imbalanced output contains
Especially point out that the Weighted Average Recall that `classification_report_imbalanced` displays is also better known as the Accuracy! Maybe this should also be a change in the API docs for `classification_report_imbalanced` but the "Edit" link there didn't work.
1 parent 56eefdf commit 020b148

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/metrics.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,12 @@ Summary of important metrics
6868
The :func:`classification_report_imbalanced` will compute a set of metrics
6969
per class and summarize it in a table. The parameter `output_dict` allows
7070
to get a string or a Python dictionary. This dictionary can be reused to create
71-
a Pandas dataframe for instance.
71+
a Pandas dataframe for instance. Its "avg/total" bottom row contains
72+
the Weighted Average of each column (weighting is by the sup (Support), i.e. by
73+
the true class proportions), except the sup (Support) column whose total
74+
appears at its bottom. Also note that the avg value at the bottom of the "rec"
75+
column is simply the Accuracy because Weighted Average Recall is just another
76+
name for Accuracy.
7277

7378
.. _pairwise_metrics:
7479

0 commit comments

Comments
 (0)