Skip to content

Commit dde338b

Browse files
DOC improve the UG documentation of the classification report (#868)
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
1 parent 5f7dc45 commit dde338b

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

doc/metrics.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,16 @@ each class and averaged over classes, giving an equal weight to each class.
6565
Summary of important metrics
6666
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6767

68-
The :func:`classification_report_imbalanced` will compute a set of metrics
69-
per class and summarize it in a table. The parameter `output_dict` allows
70-
to get a string or a Python dictionary. This dictionary can be reused to create
71-
a Pandas dataframe for instance.
68+
The :func:`classification_report_imbalanced` will compute a set of metrics per
69+
class and summarize it in a table. The parameter `output_dict` allows to get a
70+
string or a Python dictionary. This dictionary can be reused to create a Pandas
71+
dataframe for instance.
72+
73+
The bottom row (i.e "avg/total") contains the weighted average by the support
74+
(i.e column "sup") of each column.
75+
76+
Note that the weighted average of the class recalls is also known as the
77+
classification accuracy.
7278

7379
.. _pairwise_metrics:
7480

0 commit comments

Comments
 (0)