Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org, springer.com, nature.com
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: dyplomath
  • License: other
  • Language: Python
  • Default Branch: master
  • Size: 25.5 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

Alibi Logo

Build Status Documentation Status codecov PyPI - Python Version PyPI - Package Version Conda (channel only) GitHub - License Slack channel


Alibi is a Python library aimed at machine learning model inspection and interpretation. The focus of the library is to provide high-quality implementations of black-box, white-box, local and global explanation methods for classification and regression models. * Documentation

If you're interested in outlier detection, concept drift or adversarial instance detection, check out our sister project alibi-detect.


Anchor explanations for images


Integrated Gradients for text


Counterfactual examples


Accumulated Local Effects

Table of Contents

Installation and Usage

Alibi can be installed from:

  • PyPI or GitHub source (with pip)
  • Anaconda (with conda/mamba)

With pip

  • Alibi can be installed from PyPI:

bash pip install alibi

  • Alternatively, the development version can be installed: bash pip install git+https://github.com/SeldonIO/alibi.git

  • To take advantage of distributed computation of explanations, install alibi with ray: bash pip install alibi[ray]

  • For SHAP support, install alibi as follows: bash pip install alibi[shap]

With conda

To install from conda-forge it is recommended to use mamba, which can be installed to the base conda enviroment with:

bash conda install mamba -n base -c conda-forge

  • For the standard Alibi install: bash mamba install -c conda-forge alibi

  • For distributed computing support: bash mamba install -c conda-forge alibi ray

  • For SHAP support: bash mamba install -c conda-forge alibi shap

Usage

The alibi explanation API takes inspiration from scikit-learn, consisting of distinct initialize, fit and explain steps. We will use the AnchorTabular explainer to illustrate the API:

```python from alibi.explainers import AnchorTabular

initialize and fit explainer by passing a prediction function and any other required arguments

explainer = AnchorTabular(predictfn, featurenames=featurenames, categorymap=categorymap) explainer.fit(Xtrain)

explain an instance

explanation = explainer.explain(x) ```

The explanation returned is an Explanation object with attributes meta and data. meta is a dictionary containing the explainer metadata and any hyperparameters and data is a dictionary containing everything related to the computed explanation. For example, for the Anchor algorithm the explanation can be accessed via explanation.data['anchor'] (or explanation.anchor). The exact details of available fields varies from method to method so we encourage the reader to become familiar with the types of methods supported.

Supported Methods

The following tables summarize the possible use cases for each method.

Model Explanations

| Method | Models | Explanations | Classification | Regression | Tabular | Text | Images | Categorical features | Train set required | Distributed | |:-------------------------------------------------------------------------------------------------------------|:------------:|:---------------------:|:--------------:|:----------:|:-------:|:----:|:------:|:--------------------:|:------------------:|:-----------:| | ALE | BB | global | ✔ | ✔ | ✔ | | | | | | | Partial Dependence | BB WB | global | ✔ | ✔ | ✔ | | | ✔ | | | | PD Variance | BB WB | global | ✔ | ✔ | ✔ | | | ✔ | | | | Permutation Importance | BB | global | ✔ | ✔ | ✔ | | | ✔ | | | | Anchors | BB | local | ✔ | | ✔ | ✔ | ✔ | ✔ | For Tabular | | | CEM | BB* TF/Keras | local | ✔ | | ✔ | | ✔ | | Optional | | | Counterfactuals | BB* TF/Keras | local | ✔ | | ✔ | | ✔ | | No | | | Prototype Counterfactuals | BB* TF/Keras | local | ✔ | | ✔ | | ✔ | ✔ | Optional | | | Counterfactuals with RL | BB | local | ✔ | | ✔ | | ✔ | ✔ | ✔ | | | Integrated Gradients | TF/Keras | local | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | Optional | | | Kernel SHAP | BB | local

global | ✔ | ✔ | ✔ | | | ✔ | ✔ | ✔ | | Tree SHAP | WB | local

global | ✔ | ✔ | ✔ | | | ✔ | Optional | | | Similarity explanations | WB | local | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |

Model Confidence

These algorithms provide instance-specific scores measuring the model confidence for making a particular prediction.

|Method|Models|Classification|Regression|Tabular|Text|Images|Categorical Features|Train set required| |:---|:---|:---:|:---:|:---:|:---:|:---:|:---:|:---| |Trust Scores|BB|✔| |✔|✔(1)|✔(2)| |Yes| |Linearity Measure|BB|✔|✔|✔| |✔| |Optional|

Key: - BB - black-box (only require a prediction function) - BB* - black-box but assume model is differentiable - WB - requires white-box model access. There may be limitations on models supported - TF/Keras - TensorFlow models via the Keras API - Local - instance specific explanation, why was this prediction made? - Global - explains the model with respect to a set of instances - (1) - depending on model - (2) - may require dimensionality reduction

Prototypes

These algorithms provide a distilled view of the dataset and help construct a 1-KNN interpretable classifier.

|Method|Classification|Regression|Tabular|Text|Images|Categorical Features|Train set labels| |:-----|:-------------|:---------|:------|:---|:-----|:-------------------|:---------------| |ProtoSelect|✔| |✔|✔|✔|✔| Optional |

References and Examples

Citations

If you use alibi in your research, please consider citing it.

BibTeX entry:

@article{JMLR:v22:21-0017, author = {Janis Klaise and Arnaud Van Looveren and Giovanni Vacanti and Alexandru Coca}, title = {Alibi Explain: Algorithms for Explaining Machine Learning Models}, journal = {Journal of Machine Learning Research}, year = {2021}, volume = {22}, number = {181}, pages = {1-7}, url = {http://jmlr.org/papers/v22/21-0017.html} }

Owner

  • Login: dyplomath
  • Kind: user

lsdkfjlskmcweijfl

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Klaise"
  given-names: "Janis"
  orcid: "https://orcid.org/0000-0002-7774-8047"
- family-names: "Van Looveren"
  given-names: "Arnaud"
  orcid: "https://orcid.org/0000-0002-8347-5305"
- family-names: "Vacanti"
  given-names: "Giovanni"
- family-names: "Coca"
  given-names: "Alexandru"
- family-names: "Samoilescu"
  given-names: "Robert"
- family-names: "Scillitoe"
  given-names: "Ashley"
  orcid: "https://orcid.org/0000-0001-8971-7224"
- family-names: "Athorne"
  given-names: "Alex"
title: "Alibi Explain: Algorithms for Explaining Machine Learning Models"
version: 0.9.5
date-released: 2024-01-22
url: "https://github.com/SeldonIO/alibi"
preferred-citation:
  type: article
  authors:
  - family-names: "Klaise"
    given-names: "Janis"
    orcid: "https://orcid.org/0000-0002-7774-8047"
  - family-names: "Van Looveren"
    given-names: "Arnaud"
    orcid: "https://orcid.org/0000-0002-8347-5305"
  - family-names: "Vacanti"
    given-names: "Giovanni"
  - family-names: "Coca"
    given-names: "Alexandru"
  journal: "Journal of Machine Learning Research"
  month: 6
  start: 1 # First page number
  end: 7 # Last page number
  title: "Alibi Explain: Algorithms for Explaining Machine Learning Models"
  issue: 181
  volume: 22
  year: 2021
  url: http://jmlr.org/papers/v22/21-0017.html

GitHub Events

Total
Last Year

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • codecov/codecov-action v4 composite
  • mxschmitt/action-tmate v3 composite
.github/workflows/security.yaml actions
  • actions/checkout v4 composite
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • snyk/actions/python-3.10 master composite
.github/workflows/test_all_notebooks.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/test_changed_notebooks.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • tj-actions/changed-files v1.1.2 composite
requirements/dev.txt pypi
  • catboost >=1.0.0,<2.0.0 development
  • flake8 >=3.7.7,<7.0.0 development
  • ipykernel >=5.1.0,<7.0.0 development
  • jupytext >=1.12.0,<2.0.0 development
  • mypy >=1.0,<2.0 development
  • nbconvert >=6.0.7,<8.0.0 development
  • pre-commit >=1.20.0,<4.0.0 development
  • pytest >=5.3.5,<8.0.0 development
  • pytest-cov >=2.6.1,<5.0.0 development
  • pytest-custom_exit_code >=0.3.0 development
  • pytest-lazy-fixture >=0.6.3,<0.7.0 development
  • pytest-mock >=3.10.0,<4.0.0 development
  • pytest-timeout >=1.4.2,<3.0.0 development
  • pytest-xdist >=1.28.0,<4.0.0 development
  • torch >=1.9.0,<3.0.0 development
  • tox >=3.21.0,<5.0.0 development
  • twine >3.2.0,<5.0.0 development
  • types-requests >=2.25.0,<3.0.0 development
requirements/docs.txt pypi
  • ipykernel >=5.1.0,<7.0.0
  • ipython >=7.2.0,<9.0.0
  • myst-parser >=1.0,<3.0
  • nbsphinx >=0.8.5,<0.10.0
  • sphinx >=4.2.0,<8.0.0
  • sphinx-rtd-theme >=1.0.0,<2.0.0
  • sphinx_design ==0.5.0
  • sphinxcontrib-apidoc >=0.3.0,<0.5.0
  • typing-extensions >=3.7.4.3
setup.py pypi
  • numpy >=1.16.2,
  • pandas >=1.0.0,
  • scikit-learn >=1.0.0,
  • spacy *
testing/requirements.txt pypi
  • ipywidgets >=7.6 test
  • seaborn >=0.9.0 test
  • xgboost >=0.90 test