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

Adding deprecation warning to explain_prediction. #1860

Merged
merged 4 commits into from
Feb 19, 2021

Conversation

freddyaboulton
Copy link
Contributor

Pull Request Description

Fixes #1822


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.

@codecov
Copy link

codecov bot commented Feb 18, 2021

Codecov Report

Merging #1860 (7555dbb) into main (b1b3961) will increase coverage by 0.1%.
The diff coverage is 100.0%.

Impacted file tree graph

@@            Coverage Diff            @@
##             main    #1860     +/-   ##
=========================================
+ Coverage   100.0%   100.0%   +0.1%     
=========================================
  Files         260      260             
  Lines       20832    20838      +6     
=========================================
+ Hits        20826    20832      +6     
  Misses          6        6             
Impacted Files Coverage Δ
...nderstanding/prediction_explanations/explainers.py 100.0% <100.0%> (ø)
...s/prediction_explanations_tests/test_explainers.py 100.0% <100.0%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b1b3961...7555dbb. Read the comment docs.

Copy link
Contributor

@angela97lin angela97lin left a comment

Choose a reason for hiding this comment

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

LGTM! :shipit:

Do we have an issue filed for removing explain_prediction yet? :O

@@ -25,6 +25,11 @@ Release Notes
* Pin graphviz version for windows builds :pr:`1847`
* Unpin graphviz version for windows builds :pr:`1851`

.. warning::

**Breaking Changes**
Copy link
Contributor

Choose a reason for hiding this comment

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

This is only listed as a breaking change but not in the other sections of the release notes? :O Is this intentional 👀

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I originally had it in both but then felt it was redundant. Do we have a guideline in place for this?

Copy link
Contributor

Choose a reason for hiding this comment

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

To date, we've listed in both places. And a single PR could contain multiple lines of change in release notes. However for something this small, I think this is fine.

@freddyaboulton
Copy link
Contributor Author

@angela97lin Yes! We have #1832

Copy link
Contributor

@bchen1116 bchen1116 left a comment

Choose a reason for hiding this comment

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

Nice!

@angela97lin
Copy link
Contributor

@freddyaboulton Amazing, didn't realize it was filed a while ago. Thank you!

Copy link
Collaborator

@jeremyliweishih jeremyliweishih left a comment

Choose a reason for hiding this comment

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

🚢

@freddyaboulton freddyaboulton force-pushed the 1822-deprecate-explain_prediction branch from 7a0687a to 6318ba1 Compare February 19, 2021 15:44
@dsherry
Copy link
Contributor

dsherry commented Feb 19, 2021

Passing RTD build here.

Copy link
Contributor

@dsherry dsherry left a comment

Choose a reason for hiding this comment

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

Looks good!

@dsherry dsherry merged commit 9886fa6 into main Feb 19, 2021
@freddyaboulton freddyaboulton deleted the 1822-deprecate-explain_prediction branch February 19, 2021 20:00
Copy link
Contributor

@chukarsten chukarsten left a comment

Choose a reason for hiding this comment

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

I really love the simple PRs.

@chukarsten
Copy link
Contributor

LGTM! :shipit:

Do we have an issue filed for removing explain_prediction yet? :O
We sure do! It's targeted for next sprint.

#1832

@chukarsten chukarsten mentioned this pull request Feb 23, 2021
@dsherry dsherry mentioned this pull request Mar 10, 2021
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.

Deprecate the explain_prediction function
6 participants