v0.8.0 (2022-09-26)
Added
- New feature
PartialDependenceandTreePartialDependenceexplainers implementing partial dependence (PD) global explanations. Also included is aplot_pdutility function for flexible plotting of the resulting PD plots (docs, #721). - New
exceptions.NotFittedErrorexception which is raised whenever a compulsory call to afitmethod has not been carried out. Specifically, this is now raised inAnchorTabular.explainwhenAnchorTabular.fithas been skipped (#732). - Various improvements to docs and examples (#695, #701, #698, #703, #717, #711, #750, #784).
Fixed
- Edge case in
AnchorTabularwhere an error is raised during anexplaincall if the instance contains a categorical feature value not seen in the training data (#742).
Changed
- Improved handling of custom
grid_pointsfor theALEexplainer (#731). - Renamed our custom exception classes to remove the verbose
Alibi*prefix and standardised the*Errorsuffix. Concretely:exceptions.AlibiPredictorCallExceptionis nowexceptions.PredictorCallErrorexceptions.AlibiPredictorReturnTypeErroris nowexceptions.PredictorReturnTypeError. Backwards compatibility has been maintained by subclassing the new exception classes by the old ones, but these will likely be removed in a future version (#733).
- Warn users when
TreeShapis used with more than 100 samples in the background dataset which is due to a limitation in the upstreamshappackage (#710). - Minimum version of
scikit-learnbumped to1.0.0mainly due to upcoming deprecations (#776). - Minimum version of
scikit-imagebumped to0.17.2to fix a possible bug when using theslicsegmentation function withAnchorImage(#753). - Maximum supported version of
attrsbumped to22.x(#727). - Maximum supported version of
tensorflowbumped to2.10.x(#745). - Maximum supported version of
raybumped to2.x(#740). - Maximum supported version of
numbabumped to0.56.x(#724). - Maximum supported version of
shapbumped to0.41.x(#702). - Updated
shapexample notebooks to recommend installingmatplotlib==3.5.3due to failure ofshapplotting functions withmatplotlib==3.6.0(#776).
Development
- Extend optional dependency checks to ensure the correct submodules are present (#714).
- Introduce
pytest-custom_exit_codeto let notebook CI pass when no notebooks are selected for tests (#728). - Use UTF-8 encoding when loading
README.mdinsetup.pyto avoid a possible failure of installation for some users (#744). - Updated guidance for class docstrings (#743).
- Reinstate
raytests (#756). - We now exclude test files from test coverage for a more accurate representation of coverage (#751). Note that this has led to a drop in code covered which will be addressed in due course (#760).
- The Python
3.10.xversion on CI has been pinned to3.10.6due to typechecking failures, pending a new release ofmypy(#761). - The
test_changed_notebooksworkflow can now be triggered manually and is run on push/PR for any branch (#762). - Use
codecovflags for more granular reporting of code coverage (#759). - Option to ssh into Github Actions runs for remote debugging of CI pipelines (#770).
- Version of
sphinxbumped to5.xbut capped at<5.1.0to avoid CI failures (#722). - Version of
myst-parserbumped to0.18.x(#693). - Version of
flake8bumped to5.x(#729). - Version of
ipykernelbumped to6.x(#431). - Version of
ipythonbumped to8.x(#572). - Version of
pytestbumped to7.x(#591). - Version of
sphinx-designbumped to0.3.0(#739). - Version of
nbconvertbumped to7.x(#738).