idroz / lime

Local Interpretable Model-Agnostic Explanations (R port of original Python package)

lime

This is an R port of the Python lime package (https://github.com/marcotcr/lime) developed by the authors of the lime (Local Interpretable Model-agnostic Explanations) approach for black-box model explanations. All credits goes to the original developers.

The purpose of lime is to explain the predictions of black box classifiers. What this means is that for any given prediction and any given classifier it is able to determine a small set of features in the original data that has driven the outcome of the prediction. To learn more about the methodology of lime read the paper and visit the repository of the original implementation.

The lime package for R does not aim to be a line-by-line port of its Python counterpart. Instead it takes the ideas laid out in the original code and implements them in an API that is idiomatic to R.

An example

The only requirement for the classifier that lime imposes is that it must implement a predict() method accepting a type = 'prob' argument (which outputs the probability for each class). Conveniently, this covers all classifiers available through caret, and if your model of choice is not covered you have the possibility of writing your own predict method.

The following shows how a random forest model is trained on the iris data set and how lime is then used to explain a set of new observations:

library(caret)
library(lime)

# Split up the data set
iris_test <- iris[1:5, 1:4]
iris_train <- iris[-(1:5), 1:4]
iris_lab <- iris[[5]][-(1:5)]

# Create Random Forest model on iris data
model <- train(iris_train, iris_lab, method = 'rf')

# Create explanation function
explain <- lime(iris_train, model)

# Explain new observation
explanation <- explain(iris_test, n_labels = 1, n_features = 2)

# The output is provided in a nice tidy format
tibble::glimpse(explanation)
#> Observations: 10
#> Variables: 11
#> $ case            <chr> "1", "1", "2", "2", "3", "3", "4", "4", "5", "5"
#> $ label           <chr> "setosa", "setosa", "setosa", "setosa", "setos...
#> $ label_prob      <dbl> 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
#> $ model_r2        <dbl> 0.7315530, 0.7315530, 0.7410118, 0.7410118, 0....
#> $ model_intercept <dbl> 0.10223879, 0.10223879, 0.09760455, 0.09760455...
#> $ feature         <chr> "Petal.Width", "Petal.Length", "Petal.Width", ...
#> $ feature_value   <dbl> 0.2, 1.4, 0.2, 1.4, 0.2, 1.3, 0.2, 1.5, 0.2, 1.4
#> $ feature_weight  <dbl> 0.4414165, 0.4404250, 0.4447930, 0.4449105, 0....
#> $ feature_desc    <chr> "Petal.Width <= 0.4", "Petal.Length <= 1.6", "...
#> $ data            <list> [[5.1, 3.5, 1.4, 0.2], [5.1, 3.5, 1.4, 0.2], ...
#> $ prediction      <list> [[1, 0, 0], [1, 0, 0], [1, 0, 0], [1, 0, 0], ...

# An can be visualised directly
plot_features(explanation)

Installation

lime is still a work in progress and is thus not available on CRAN yet. In order to try it out install it directly from GitHub:

# install.packages('devtools')
devtools::install_github('thomasp85/lime')

Scope

In addition to standard tabular data the Python implementation also provides specialized explainers for text and image data. Furthermore, the article also discusses how lime can be used for explaining models rather than predictions, using an approach called submodular picks. Lastly, there's obvious extensions to the approach such as using different algorithms for the local fit step, supporting regressors in addition to classifiers, and providing additional feature selection algorithms. All of the above will hopefully find its way to this port in due time...