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.

Sign up for GitHub

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

Jump to bottom

Add feature values and SHAP explanation object to ExplainabityResult #1545

Closed
rijkvandermeulen opened this issue Feb 8, 2023 · 2 comments · Fixed by #1546
Closed

Add feature values and SHAP explanation object to ExplainabityResult #1545

rijkvandermeulen opened this issue Feb 8, 2023 · 2 comments · Fixed by #1546
Labels
improvement New feature or improvement

Comments

@rijkvandermeulen
Copy link
Contributor

Currently the ExplainabilityResult object only contains the explained forecast (i.e., the shapley values for each prediction). I think it would be useful to also store the corresponding feature values and potentially also the SHAP explanation object itself. This will give the end user more options to work with the forecasts that are explained.
@rijkvandermeulen rijkvandermeulen added the triage Issue waiting for triaging label Feb 8, 2023
rijkvandermeulen pushed a commit to rijkvandermeulen/darts that referenced this issue Feb 8, 2023
unit8co#1545 added entry to CHANGELOG.md
95218df
@rijkvandermeulen rijkvandermeulen mentioned this issue Feb 8, 2023
Merged
rijkvandermeulen pushed a commit to rijkvandermeulen/darts that referenced this issue Feb 8, 2023
unit8co#1545 update docstrings for correctness API reference docs
5e65c54
@hrzn
Copy link
Contributor

hrzn commented Feb 10, 2023 •
edited
Loading

Sounds like a good idea to me!

@hrzn hrzn added improvement New feature or improvement and removed triage Issue waiting for triaging labels Feb 10, 2023
@hrzn hrzn linked a pull request Feb 10, 2023 that will close this issue
Feature/add feature values to explainability result #1546
Merged
rijkvandermeulen pushed a commit to rijkvandermeulen/darts that referenced this issue Mar 12, 2023
unit8co#1545 implement _query_explainability_result() helper to avoid…
7176e11 
… code duplication
dennisbader added a commit that referenced this issue Mar 12, 2023
@rijkvandermeulen @madtoinou @dennisbader
Feature/add feature values to explainability result (#1546)
f7c292a 
* store feature values and shap.Explanation object in ExplainabilityResult

* accounted for is_multioutputregressor

* #1545 added entry to CHANGELOG.md

* #1545 update docstrings for correctness API reference docs

* #1580 create ShapExplainabilityResult subclass and remove decorator

* #1580 adjust unit tests to have dedicated with statement per assert + other small stuff

* #1580 change asserts in unit test from ExplainabilityResult to ShapExplainabilityResult

* #1580 test get_feature_values() against raw output shap

* #1580 adjust docstring

* #1580 fixing small stuff

* #1580 added one assert to unit test

* #1545 implement _query_explainability_result() helper to avoid code duplication

---------

Co-authored-by: Rijk van der Meulen <rijk.vandermeulen@eyeon.nl>
Co-authored-by: madtoinou <32447896+madtoinou@users.noreply.github.com>
Co-authored-by: Dennis Bader <dennis.bader@gmx.ch>
@dennisbader
Copy link
Collaborator

Fixed in #1546

alexcolpitts96 pushed a commit to alexcolpitts96/darts that referenced this issue May 31, 2023
@rijkvandermeulen @madtoinou
@dennisbader @alexcolpitts96
Feature/add feature values to explainability result (unit8co#1546)
26626d2 
* store feature values and shap.Explanation object in ExplainabilityResult

* accounted for is_multioutputregressor

* unit8co#1545 added entry to CHANGELOG.md

* unit8co#1545 update docstrings for correctness API reference docs

* unit8co#1580 create ShapExplainabilityResult subclass and remove decorator

* unit8co#1580 adjust unit tests to have dedicated with statement per assert + other small stuff

* unit8co#1580 change asserts in unit test from ExplainabilityResult to ShapExplainabilityResult

* unit8co#1580 test get_feature_values() against raw output shap

* unit8co#1580 adjust docstring

* unit8co#1580 fixing small stuff

* unit8co#1580 added one assert to unit test

* unit8co#1545 implement _query_explainability_result() helper to avoid code duplication

---------

Co-authored-by: Rijk van der Meulen <rijk.vandermeulen@eyeon.nl>
Co-authored-by: madtoinou <32447896+madtoinou@users.noreply.github.com>
Co-authored-by: Dennis Bader <dennis.bader@gmx.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
improvement New feature or improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature/add feature values to explainability result rijkvandermeulen/darts
3 participants
@hrzn @dennisbader @rijkvandermeulen