lime README

The project's README from github.com/marcotcr/lime. As one markdown file: README.md.

lime

Build Status Binder

This project is about explaining what machine learning classifiers (or models) are doing. At the moment, we support explaining individual predictions for text classifiers or classifiers that act on tables (numpy arrays of numerical or categorical data) or images, with a package called lime (short for local interpretable model-agnostic explanations). Lime is based on the work presented in this paper (bibtex here for citation). Here is a link to the promo video:

KDD promo video

Our plan is to add more packages that help users understand and interact meaningfully with machine learning.

Lime is able to explain any black box classifier, with two or more classes. All we require is that the classifier implements a function that takes in raw text or a numpy array and outputs a probability for each class. Support for scikit-learn classifiers is built-in.

Installation

The lime package is on PyPI. Simply run:

pip install lime

Or clone the repository and run:

pip install .

We dropped python2 support in 0.2.0, 0.1.1.37 was the last version before that.

Screenshots

Below are some screenshots of lime explanations. These are generated in html, and can be easily produced and embedded in ipython notebooks. We also support visualizations using matplotlib, although they don't look as nice as these ones.

Two class case, text

Negative (blue) words indicate atheism, while positive (orange) words indicate christian. The way to interpret the weights by applying them to the prediction probabilities. For example, if we remove the words Host and NNTP from the document, we expect the classifier to predict atheism with probability 0.58 - 0.14 - 0.11 = 0.31.

twoclass

Multiclass case

multiclass

Tabular data

tabular

Images (explaining prediction of 'Cat' in pros and cons)

Tutorials and API

For example usage for text classifiers, take a look at the following two tutorials (generated from ipython notebooks):

For classifiers that use numerical or categorical data, take a look at the following tutorial (this is newer, so please let me know if you find something wrong):

For image classifiers:

For regression:

Submodular Pick:

The raw (non-html) notebooks for these tutorials are available here.

The API reference is available here.

What are explanations?

Intuitively, an explanation is a local linear approximation of the model's behaviour. While the model may be very complex globally, it is easier to approximate it around the vicinity of a particular instance. While treating the model as a black box, we perturb the instance we want to explain and learn a sparse linear model around it, as an explanation. The figure below illustrates the intuition for this procedure. The model's decision function is represented by the blue/pink background, and is clearly nonlinear. The bright red cross is the instance being explained (let's call it X). We sample instances around X, and weight them according to their proximity to X (weight here is indicated by size). We then learn a linear model (dashed line) that approximates the model well in the vicinity of X, but not necessarily globally. For more information, read our paper, or take a look at this blog post.

Contributing

Please read this.

lime (marcotcr/lime)

Searching Database…

12.2K ·GitHub
Lime
Что это такое?LIME (Local Interpretable Model-agnostic Explanations) — это пакет для Python, который объясняет отдельные предсказания любого классификатора машинного обучения, работает ли он с текстом, табличными данными или изображениями.
Это библиотека, которую я импортирую, или самостоятельное приложение?Это библиотека для Python, которую устанавливают через pip и вызывают из своего кода или Jupyter-блокнотов; объяснения можно выводить в виде HTML или графиков matplotlib.
Нужен ли мне конкретный фреймворк для моей модели?Нет, привязки к фреймворку нет: классификатору нужна только функция, которая принимает сырой текст или массив numpy и возвращает вероятности по каждому классу. Классификаторы Scikit-learn поддерживаются из коробки, а в учебных материалах есть примеры и для Keras, PyTorch и H2O.
Есть ли подводные камни при установке, о которых мне стоит знать?Поддержка Python 2 была прекращена в версии 0.2.0, поэтому нужен Python 3; последняя версия с поддержкой Python 2 — 0.1.1.37.
Что именно показывает объяснение LIME?Это локальная линейная аппроксимация поведения модели вокруг конкретного предсказания — например, взвешенные слова, которые подтолкнули классификацию текста к одному или другому классу.
Работает ли это только для задач классификации?В основном да, но в учебных материалах есть и простой пример регрессии, так что инструмент не ограничен классификаторами.
Что такое Submodular Pick?Это дополнительный метод в пакете для выбора репрезентативного набора объяснённых примеров без повторов, чтобы просматривать их, а не проверять предсказания по одному.
Можно ли попробовать, не написав код с нуля?Да — в репозитории есть готовые учебные Jupyter-блокноты для классификаторов текста, табличных данных и изображений (включая примеры с Keras, PyTorch и H2O), которые можно сразу адаптировать.
What are similar projects?fashion-mnist, shap, pytorch-grad-cam, autogluon, machine-learning-zoomcamp, d2l-en, fastbook, sktime
Which topics is it in?explainable-ai, tabular-data, interpretability, text-classification, keras, scikit-learn, classification, image-classification, jupyter-notebook, numpy, paper, python-library
Creator
marcotcr
Size
20.6 MB
Stars
12.2K
Updated
CommitJul 29Release0.2.0.0Apr 03
Age
10y
Commits · 90 Days