-
Notifications
You must be signed in to change notification settings - Fork 82
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
Percent better than baseline #1050
Conversation
669881c
to
2d15079
Compare
Codecov Report
@@ Coverage Diff @@
## main #1050 +/- ##
=======================================
Coverage 99.91% 99.91%
=======================================
Files 194 194
Lines 10986 11084 +98
=======================================
+ Hits 10977 11075 +98
Misses 9 9
Continue to review full report at Codecov.
|
e29454b
to
b12fe4e
Compare
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.
This is great! The tests are solid and the impl is clear and easy to follow.
Approved, pending one request: please update the user guide for objectives to describe the two new required parameters.
@@ -11,6 +11,8 @@ class CostBenefitMatrix(BinaryClassificationObjective): | |||
name = "Cost Benefit Matrix" | |||
greater_is_better = True |
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.
@angela97lin I forgot to check this -- we should document why we chose this. I.e. is this score quantifying the cost (lower is better) or the benefit (higher is better)?
For this PR, we just need perfect_score
here to align with greater_is_better
, which it appears to do
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.
Gotcha, I can document this as I work on #1026. It's a little difficult to document this directly on the attribute since we don't expose it but I'll add it to the CostBenefitMatrix class docstring.
@dsherry Thanks for the feedback! I've modified the custom objectives document in the user guide and followed your comments. @kmax12 felt that we should compute the relative difference for all objectives (even if they are percentages) so I've also made that change. That entailed doing some minor tweaks to the tests and removing |
988559e
to
dee80fa
Compare
@freddyaboulton cool, thanks for the heads up. I reread and looks good! |
…related to computing % better than baseline.
dee80fa
to
c791631
Compare
Pull Request Description
Closes #984 .
Demo of new rankings table
After creating the pull request: in order to pass the release_notes_updated check you will need to update the "Future Release" section of
docs/source/release_notes.rst
to include this pull request by adding :pr:123
.