Skip to content

DOC Added references to the Matthews correlation coefficient function in the user guide #19958

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 8 commits into from
Jun 6, 2024
Merged

DOC Added references to the Matthews correlation coefficient function in the user guide #19958

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e285abe
added references to the Matthews correlation coefficient function
davidechicco Apr 22, 2021
ad9384e
edited model evaluation references
davidechicco Apr 22, 2021
b7ef776
Merge remote-tracking branch 'upstream/main' into DavideChicco_branch…
adrinjalali Apr 15, 2024
a85085f
remove extra ref
adrinjalali Apr 15, 2024
70789d1
DOC remove extra references
adrinjalali May 25, 2024
1094f6f
Merge remote-tracking branch 'upstream/main' into DavideChicco_branch…
adrinjalali May 25, 2024
e5bac93
fix reference
adrinjalali Jun 3, 2024
c59452d
Merge remote-tracking branch 'upstream/main' into DavideChicco_branch…
adrinjalali Jun 3, 2024
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
8 changes: 8 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 @@ -1267,6 +1267,7 @@ When there are more than two labels, the value of the MCC will no longer range
between -1 and +1. Instead the minimum value will be somewhere between -1 and 0
depending on the number and distribution of ground true labels. The maximum
value is always +1.
For additional information, see [WikipediaMCC2021]_.

Here is a small example illustrating the usage of the :func:`matthews_corrcoef`
function:
Expand All @@ -1277,6 +1278,13 @@ function:
>>> matthews_corrcoef(y_true, y_pred)
-0.33...

.. topic:: References:

.. [WikipediaMCC2021] Wikipedia contributors. Phi coefficient.
Wikipedia, The Free Encyclopedia. April 21, 2021, 12:21 CEST.
Available at: https://en.wikipedia.org/wiki/Phi_coefficient
Accessed April 21, 2021.

.. _multilabel_confusion_matrix:

Multi-label confusion matrix
Expand Down
Loading