Skip to content

[MRG] Fix issue #4964 model evaluation docs #5839

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

Closed
wants to merge 3 commits into from
Closed

[MRG] Fix issue #4964 model evaluation docs #5839

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b5f0b4
add Brier_score_loss to model validation doc #4804
tingleeGIS Jul 11, 2015
e7c8cab
Added necessary imports to fix issue #4964.
Nov 16, 2015
b9cbd21
Fixing some of the comparison values.
Nov 16, 2015
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
40 changes: 40 additions & 0 deletions doc/modules/model_evaluation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1014,6 +1014,46 @@ set [0,1] has an error: ::
for an example of zero one loss usage to perform recursive feature
elimination with cross-validation.

.. _brier_score_loss:

Brier score loss
----------------

The :func:`brier_score_loss` function returns a score of the mean square difference
between the actual outcome and the predicted probability of the possible outcome.
The actual outcome has to be 1 or 0 (true or false), while the predicted probability
of the actual outcome happens can be value between 0 and 1. The brier score loss is
also between 0 to 1 and the lower the score (the mean square difference is smaller),
the more accurate the prediction is.

.. math::

BS = \frac{1}{N} \sum_{t=1}^{N}(f_t - o_t)^2

where : :math:`N` is the total number of predictions, :math:`f_t` is the predicted probablity of the actual outcome :math:`o_t`

>>> import numpy as np
>>> from sklearn.metrics import brier_score_loss
>>> from sklearn.metrics import zero_one_loss
>>> y_true = np.array([0, 1, 1, 0])
>>> y_true_categorical = np.array(["spam", "ham", "ham", "spam"])
>>> y_prob = np.array([0.1, 0.9, 0.8, 0.3])
>>> brier_score_loss(y_true, y_prob)
0.0375...
>>> zero_one_loss(y_true, y_pred, normalize=False)
4
>>> brier_score_loss(y_true, 1-y_prob, pos_label=0)
0.0375...
>>> brier_score_loss(y_true_categorical, y_prob, pos_label="ham")
0.0375...
>>> brier_score_loss(y_true, np.array(y_prob) > 0.5)
0.0

.. topic:: Example:

* See :ref:`example_calibration_plot_calibration.py`
for an example of Brier score loss usage to perform probability calibration of classifiers.


.. _multilabel_ranking_metrics:

Expand Down