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

Update to PR Curve docs #1074

Merged
merged 3 commits into from Jun 24, 2020

Conversation

rebeccabilbro
Copy link
Member

@rebeccabilbro rebeccabilbro commented Jun 10, 2020

This PR closes #602 and closes #1049, which called on us to flesh out and clarify the interpretation and usage of the PrecisionRecallCurve visualizer.

I have made the following changes:

  1. Added explanatory text to the docstrings of the visualizer and its quick method per Better Documentation for Precision-Recall Curves #602
  2. Fleshed out the docs with examples and use cases per Better Documentation for Precision-Recall Curves #602
  3. Updated the definition of "precision" given the discussion in Definition of “Precision” seems incorrect... #1049

Sample Code and Plot

Added model comparison examples to the docs, e.g.:

image

CHECKLIST

  • Is the commit message formatted correctly?
  • Have you noted the new functionality/bugfix in the release notes of the next release?
  • Included a sample plot to visually illustrate your changes?
  • Do all of your functions and methods have docstrings?
  • Have you added/updated unit tests where appropriate?
  • Have you updated the baseline images if necessary?
  • Have you run the unit tests using pytest?
  • Is your code style correct (are you using PEP8, pyflakes)?
  • Have you documented your new feature/functionality in the docs?
  • Have you built the docs using make html?

Copy link
Member

@bbengfort bbengfort left a comment

Choose a reason for hiding this comment

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

Thank you for taking this on!

@bbengfort bbengfort self-requested a review June 11, 2020 16:18
@bbengfort
Copy link
Member

Also, sorry about the confusion, I didn't see @Kautumn06 was asked to review - so I took myself off of the review.

@rebeccabilbro
Copy link
Member Author

Thank you @bbengfort!
@Kautumn06 — when you're ready, I'd sure appreciate your careful inspection of the new documentation around PR curves. I already found a few typos 😊 and I'm sure you'll find more!

Copy link
Member

@bbengfort bbengfort left a comment

Choose a reason for hiding this comment

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

This is a very comprehensive update of all of the locations we describe precision and recall. I really appreciate the thought and care you put into this!

Note that I'm taking this PR review so that @Kautumn06 can focus on #1078

@bbengfort bbengfort removed the request for review from Kautumn06 June 24, 2020 13:09
@rebeccabilbro rebeccabilbro merged commit e206bc2 into DistrictDataLabs:develop Jun 24, 2020
@rebeccabilbro rebeccabilbro deleted the precision-def branch June 24, 2020 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Definition of “Precision” seems incorrect... Better Documentation for Precision-Recall Curves
2 participants