Skip to content

Commit

Permalink
DOC improve the UG documentation of the classification report (scikit…
Browse files Browse the repository at this point in the history
…-learn-contrib#868)

Co-authored-by: Guillaume Lemaitre <[email protected]>
  • Loading branch information
DavidRosen and glemaitre authored Dec 7, 2021
1 parent 5f7dc45 commit dde338b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions doc/metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,16 @@ each class and averaged over classes, giving an equal weight to each class.
Summary of important metrics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The :func:`classification_report_imbalanced` will compute a set of metrics
per class and summarize it in a table. The parameter `output_dict` allows
to get a string or a Python dictionary. This dictionary can be reused to create
a Pandas dataframe for instance.
The :func:`classification_report_imbalanced` will compute a set of metrics per
class and summarize it in a table. The parameter `output_dict` allows to get a
string or a Python dictionary. This dictionary can be reused to create a Pandas
dataframe for instance.

The bottom row (i.e "avg/total") contains the weighted average by the support
(i.e column "sup") of each column.

Note that the weighted average of the class recalls is also known as the
classification accuracy.

.. _pairwise_metrics:

Expand Down

0 comments on commit dde338b

Please sign in to comment.