-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
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.
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
Conversation
Clearer and more illustrative description about the `beta` parameter
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the PR @pnucci !
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thomasjpfan just one thing: with that suggestion, we lost the word "importance". Now we are saying "ratio of recall to precision". I still believe we should say something like
"ratio of recall importance to precision importance"
or
"importance ratio of recall to precision"
after all, beta
is not a ratio of the metrics, just a ratio of their importance/weights
what are your thoughts?
I was trying to think of a way not to say importance twice. In any case, I am okay with your original suggestion:
|
Hi @thomasjpfan, are you ok with the last proposal? are we good to approve it? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the update! LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM as it is. Thanks @pnucci!
…t-learn#25548) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Clearer and more illustrative description about the
beta
parameter. The original text mentions "weight of recall", without being clear that it's a ratio. Two intuitive examples are added, instead of discussing the asymptotic behaviour ofbeta
.Reference Issues/PRs
What does this implement/fix? Explain your changes.
Simple improvement in the documentation for f_beta_score, to make it more accurate and pragmatic.
Any other comments?