Shap Versions Save

A game theoretic approach to explain the output of any machine learning model.

v0.45.0

1 month ago

This is a fairly significant release containing a number of breaking changes.

Thank you to a number of new contributors for their contributions to this release! We are eager to grow the pool of maintainers, so please do get in touch on #3559 if you are interested in being part of the team.

What's Changed

Breaking changes

Added

Fixed

.. plus a large number of documentation, testing and other maintenance updates by @CloseChoice , @yuanx749 , @LakshmanKishore and others.

New Contributors

Full Changelog: https://github.com/shap/shap/compare/v0.44.1...v0.45.0

v0.44.1

3 months ago

Patch release to fix an issue with the display of force plots.

Fixed

Other

  • Further improvements to documentation

Full Changelog: https://github.com/shap/shap/compare/v0.44.0...v0.44.1

v0.44.0

5 months ago

This release contains a number enhancements and bug fixes.

What's Changed

Added

Fixed

Documentation

  • A large number of example notebooks fixed and updated by @connortann, @znacer , @thatlittleboy, @CloseChoice and @stompsjo

New Contributors

Full Changelog: https://github.com/shap/shap/compare/v0.43.0...V0.44.0

v0.43.0

6 months ago

What's Changed

This release contains a number of bug fixes and improvements.

Following the NEP 29 deprecation policy, this release drops support for python 3.7.

Breaking changes

Added

Fixed

There have also been a large number of improvements to the tutorials and examples, by @connortann, @znacer, @arshiaar, @thatlittleboy, @dsgibbons, @owenlamont and @CloseChoice

New Contributors

Full Changelog: https://github.com/shap/shap/compare/v0.42.1...v0.43.0

v0.42.1

9 months ago

Patch release to provide wheels for a broader range of architectures.

Added

Fixed

Full Changelog: https://github.com/slundberg/shap/compare/v0.42.0...v0.42.1

v0.42.0

10 months ago

This release incorporates many changes that were originally contributed by the SHAP community via @dsgibbons's Community Fork, which has now been merged into the main shap repository. PRs from this origin are labelled here as fork#123.

This will be the last release that supports python 3.7.

Added

  • Added support for python 3.11 (fork#72 by @connortann).
  • Added n_points parameter to all functions in shap.datasets (fork#39 by @thatlittleboy).
  • Added __call__ to KernelExplainer (#2966 by @dwolfeu).
  • Added contributing guidelines (#2996 by @connortann).

Fixed

  • Fixed plot.waterfall to support yticklabels with boolean features (fork#58 by @dwolfeu).
  • Prevent TreeExplainer.__call__ from throwing ValueError when passed a pandas DataFrame containing Categorical columns (fork#88 by @thatlittleboy).
  • Fixed sampling in shap.datasets to sample without replacement (fork#36 by @thatlittleboy).
  • Fixed an UnboundLocalError problem arising from passing a dictionary input to shap.plots.bar (#3001 by @thatlittleboy).
  • Fixed tensorflow import issue with Pyspark when using Gradient (#2983 by @skamdar).
  • Fixed the aspect ratio of the colorbar in shap.plots.heatmap, and use the ax matplotlib API internally for plotting (#3040 by @thatlittleboy).
  • Fixed deprecation warnings for numba>=0.44 (fork#9 and fork#68 by @connortann).
  • Fixed deprecation warnings for numpy>=1.24 from numpy types (fork#7 by @dsgibbons).
  • Fixed deprecation warnings for Ipython>=8 from Ipython.core.display (fork#13 by @thatlittleboy).
  • Fixed deprecation warnings for tensorflow>=2.11 from tf.optimisers (fork#16 by @simonangerbauer).
  • Fixed deprecation warnings for sklearn>=1.2 from sklearn.linear_model (fork#22 by @dsgibbons).
  • Fixed deprecation warnings for xgboost>=1.4 from ntree_limit in tree explainer (#2987 by @adnene-guessoum).
  • Fixed build on Windows and MacOS (#3015 by @PrimozGodec; #3028, #3029 and #3031 by @connortann).
  • Fixed creation of ragged arrays in shap.explainers.Exact (#3064 by @connortann).

Changed

  • Updates to docstrings of several shap.plots functions (#3003, #3005 by @thatlittleboy).

Removed

  • Deprecated the Boston house price dataset (fork#38 by @thatlittleboy).
  • Removed the unused mimic.py file and MimicExplainer code (fork#53 by @thatlittleboy).

Maintenance

  • Fixed failing unit tests (fork#29 by @dsgibbons, fork#20 by @simonangerbauer, #3044 and fork#24 by @connortann).
  • Include CUDA GPU C extension files in the source distribution (#3009 by @jklaise).
  • Fixed installation of package via setuptools (fork#51 by @thatlittleboy).
  • Introduced a minimal set of ruff linting (fork#25, fork#26, fork#27, #2973, #2972 and #2976 by @connortann; #2968, #2986 by @thatlittleboy).
  • Updated project metadata to PEP 517 (#3022 by @connortann).
  • Introduced more thorough testing on CI against newer dependencies (fork#61 and #3017 by @connortann)
  • Reduced unit test time by ~5 mins (#3046 by @connortann).
  • Introduced fixtures for reproducible fuzz testing (#3048 by @connortann).

v0.41.0

1 year ago

Lots of bugs fixes and API improvements.

  • Fixed rare bug with XGBoost model loading by @TheZL @lrjball
  • Fixed the beeswarm plot so it does not modify the passed explanation object, @ravwojdyla
  • Automatic wheel building using GH actions by @quantumtec
  • GC collection for memory in KernelExplainer by @Qingtian-Zou
  • Fixed max_evals params for PartitionExplainer
  • JIT optimize the PartitionExplainer
  • Fix colorbar formatting issues @SleepyPepperHead
  • New benchmark notebooks
  • Use display_data for plotting when possible @yuuuxt
  • Improved GPUTreeShap compilation and params @RAMitchell
  • Fix TF API change in DeepExplainer @filusn
  • Add torch tensor support for plots @alexander-pv
  • Switch to Github actions for testing instead of Travis
  • New California demo dataset @swalsh1123
  • Fix waterfall plot bug @RichardScottOZ
  • Handle missing matplotlib installation @klieret
  • Add linearize link support for Additive explainer (Nandish Gupta)
  • Fix exceptions to be more specific @alexisdrakopoulos @collinb9
  • Add color map option for plotting @tlabarta
  • Release fixed numpy version requirement @rmehyde
  • And many other contributions kindly made by @WeichenXu123 @imatiach-msft @zeshengli @nkthiebaut @songololo @GiovannaNicora @joshzwiebel @Ashishbodla @navdeep-G @smathewmanuel @ycouble @anubhavmaity @adityasaini70 @ngupta20 @jckkvs @abs428 @JulesCollenne @Tiagosf00 @javirandor and @Thuener

v0.40.0

2 years ago

This release contains many bugs fixes and lots of new functionality, specifically for transformer based NLP models. Some highlights include:

  • New plots, bug fixes, docs, and features for NLP model explanations (see docs for details).
  • important permutation explainer performance fix by @sander-sn
  • New joint scatter plots to plot many at once on the same y-scale
  • better tree model memory usage by @morriskurz
  • new docs by @coryroyce
  • new wheel building by @PrimozGodec
  • dark mode improvements for the docs by @gialmisi
  • api tweaks by @c56pony @nsorros @jebarb

v0.39.0

3 years ago

Lots of new text explainer work courtesy of @ryserrao and serialization courtesy of @vivekchettiar! (will note all the other changes later)

v0.38.1

3 years ago

Fixes a version mismatch with the v0.38.0 release and serialization updates.