8000 DOC Clearer and more illustrative description for f_beta_score by pnucci · Pull Request #25548 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Clearer and more illustrative description for f_beta_score #25548

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
May 22, 2023
Merged

DOC Clearer and more illustrative description for f_beta_score #25548

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6dd6c67
[MRG] Better documentation for f_beta_score
pnucci Feb 6, 2023
9f08339
Update _classification.py
pnucci Feb 6, 2023
8fd0310
Update sklearn/metrics/_classification.py
pnucci Feb 8, 2023
f007947
Update _classification.py
pnucci Feb 8, 2023
305eb75
Merge branch 'main' into pnucci-fbeta-docs
pnucci Apr 13, 2023
287a972
Merge branch 'main' into pnucci-fbeta-docs
pnucci Apr 17, 2023
3183629
Update _classification.py
pnucci May 6, 2023
5b49de6
Merge branch 'main' into pnucci-fbeta-docs
pnucci May 6, 2023
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: 6 additions & 4 deletions sklearn/metrics/_classification.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1274,10 +1274,12 @@ def fbeta_score(
The F-beta score is the weighted harmonic mean of precision and recall,
reaching its optimal value at 1 and its worst value at 0.

The `beta` parameter determines the weight of recall in the combined
score. ``beta < 1`` lends more weight to precision, while ``beta > 1``
favors recall (``beta -> 0`` considers only precision, ``beta -> +inf``
only recall).
The `beta` parameter represents the ratio of recall importance to
precision importance. `beta > 1` gives more weight to recall, while
`beta < 1` favors precision. For example, `beta = 2` makes recall twice
as important as precision, while `beta = 0.5` does the opposite.
Asymptotically, `beta -> +inf` considers only recall, and `beta -> 0`
only precision.

Read more in the :ref:`User Guide <precision_recall_f_measure_metrics>`.

Expand Down
0