Skip to content

DOC improve the UG documentation of the classification report #868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 7, 2021
Merged

DOC improve the UG documentation of the classification report #868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
020b148
Update metrics.rst -- say what bottom row of `classification_report_i…
DavidRosen Oct 11, 2021
79394a3
CI solve issue of bash install file
glemaitre Dec 7, 2021
43c9be7
review
glemaitre Dec 7, 2021
cb01a77
Merge remote-tracking branch 'origin/master' into pr/DavidRosen/868
glemaitre Dec 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions build_tools/azure/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ elif [[ "$DISTRIB" == "conda-pip-latest-tensorflow" ]]; then
python -m pip install numpy scipy scikit-learn pandas tensorflow

elif [[ "$DISTRIB" == "conda-latest-tensorflow" ]]; then
make_conda " python=$PYTHON_VERSION numpy scipy scikit-learn pandas tensorflow"
make_conda "python=$PYTHON_VERSION numpy scipy scikit-learn pandas tensorflow"

elif [[ "$DISTRIB" == "conda-minimum-tensorflow" ]]; then
TO_INSTALL="$python=$PYTHON_VERSION"
TO_INSTALL="python=$PYTHON_VERSION"
TO_INSTALL="$TO_INSTALL $(get_dep numpy $NUMPY_VERSION)"
TO_INSTALL="$TO_INSTALL $(get_dep scipy $SCIPY_VERSION)"
TO_INSTALL="$TO_INSTALL $(get_dep scikit-learn $SKLEARN_VERSION)"
Expand All @@ -87,7 +87,7 @@ elif [[ "$DISTRIB" == "conda-minimum-tensorflow" ]]; then
make_conda $TO_INSTALL

elif [[ "$DISTRIB" == "conda-pip-latest-keras" ]]; then
make_conda "=$PYTHON_VERSION"
make_conda "python=$PYTHON_VERSION"
python -m pip install -U pip

python -m pip install numpy scipy scikit-learn pandas keras
Expand All @@ -96,7 +96,7 @@ elif [[ "$DISTRIB" == "conda-latest-keras" ]]; then
make_conda "=$PYTHON_VERSION numpy scipy scikit-learn pandas keras"

elif [[ "$DISTRIB" == "conda-minimum-keras" ]]; then
TO_INSTALL="=$PYTHON_VERSION"
TO_INSTALL="python=$PYTHON_VERSION"
TO_INSTALL="$TO_INSTALL $(get_dep numpy $NUMPY_VERSION)"
TO_INSTALL="$TO_INSTALL $(get_dep scipy $SCIPY_VERSION)"
TO_INSTALL="$TO_INSTALL $(get_dep scikit-learn $SKLEARN_VERSION)"
Expand All @@ -105,7 +105,7 @@ elif [[ "$DISTRIB" == "conda-minimum-keras" ]]; then
make_conda $TO_INSTALL

elif [[ "$DISTRIB" == "conda-pip-scipy-dev" ]]; then
make_conda "=$PYTHON_VERSION"
make_conda "python=$PYTHON_VERSION"
python -m pip install -U pip
echo "Installing numpy and scipy master wheels"
dev_anaconda_url=https://pypi.anaconda.org/scipy-wheels-nightly/simple
Expand Down
14 changes: 10 additions & 4 deletions doc/metrics.rst
View file
Open in desktop
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