v0.6.2 (2021-11-18)
Added
- Documentation on using black-box and white-box models in the context of alibi, see here.
AnchorTabular,AnchorImageandAnchorTextnow expose an additionaldtypekeyword argument with a default value ofnp.float32. This is to ensure that whenever a userpredictoris called internally with dummy data a correct data type can be ensured (#506).- Custom exceptions. A new public module
alibi.exceptionsdefining thealibiexception hierarchy. This introduces two exceptions,AlibiPredictorCallExceptionandAlibiPredictorReturnTypeError. See #520 for more details.
Changed
- For
AnchorImage, coerceimage_shapeargument into a tuple to implicitly allow passing a list input which eases use of configuration files. In the future the typing will be improved to be more explicit about allowed types with runtime type checking. - Updated the minimum
shapversion to the latest0.40.0as this fixes an installation issue ifalibiandshapare installed with the same command.
Fixed
- Fix a bug with version saving being overwritten on subsequent saves (#481).
- Fix a bug in the Integrated Gradients notebook with transformer models due to a regression in the upstream
transformerslibrary (#528). - Fix a bug in
IntegratedGradientswithforward_kwargsnot always being correctly passed (#525). - Fix a bug resetting
TreeShappredictor (#534).
Development
- Now using
readthedocsDocker image in our CI to replicate the doc building environment exactly. Also enabledreadthedocsbuild on PR feature which allows browsing the built docs on every PR. - New notebook execution testing framework via Github Actions. There are two new GA workflows, test_all_notebooks which is run once a week and can be triggered manually, and test_changed_notebooks which detects if any notebooks have been modified in a PR and executes only those. Not all notebooks are amenable to be tested automatically due to long running times or complex software/hardware dependencies. We maintain a list of notebooks to be excluded in the testing script under testing/test_notebooks.py.
- Now using
myst(a markdown superset) for more flexible documentation (#482). - Added a CITATION.cff file.