Skip to content
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

DOC Improve plot_precision_recall #28967

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lucyleeow
Copy link
Member

Reference Issues/PRs

closes #18719

What does this implement/fix? Explain your changes.

  • Avoid using the term 'false positive rate' as this is a technical term meaning FP/FP+TN, which is not accurate here. (False discovery rate would be more accurate as it is FP/FP+TP but I've avoided use of either term). Also avoided use of 'false negative rate' even though this is not a technical term.
  • Avoid focusing on 'number' of results returned, as technically proportion of relevant results returned is more relevant
  • Moves precision/recall definitions up.
  • Removes F1 definition, we only mention it once and never talk about it again and it does not tie in to any other part of the example

Any other comments?

Happy to change wording.

Copy link

github-actions bot commented May 7, 2024

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: dc103f4. Link to the linter CI: here

Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. Here is a quick suggestion but otherwise LGTM!

Comment on lines 10 to 12
measure of result relevancy, while recall is a measure of how many of the
relevant results are returned. 'Relevancy' here refers to items that are
postively labeled, true positives and false negatives.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can avoid introducing the word "relevancy" and more directly state:

Suggested change
measure of result relevancy, while recall is a measure of how many of the
relevant results are returned. 'Relevancy' here refers to items that are
postively labeled, true positives and false negatives.
measure of the fraction of relevant items among actually returned items while recall
is a measure of the fraction of items that were returned among all items that should
have been returned.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Precision-recall description improvement
2 participants