-
Notifications
You must be signed in to change notification settings - Fork 87
/
README.Rmd
133 lines (99 loc) · 4.67 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
---
output: github_document
---
<!-- badges: start -->
[](https://github.com/christophM/iml/actions)
[](https://CRAN.R-project.org/package=iml)
[](https://CRAN.R-project.org/package=iml)
[](https://codecov.io/github/christophM/iml?branch=master)
[](https://doi.org/10.21105/joss.00786)
<!-- badges: end -->
# iml
`iml ` is an R package that interprets the behavior and explains predictions of machine learning models. <img src="https://github.com/christophM/iml/blob/master/man/figures/iml.png?raw=true" align="right" height=140/>
It implements model-agnostic interpretability methods - meaning they can be used with any machine learning model.
## Features
- Feature importance
- Partial dependence plots
- Individual conditional expectation plots (ICE)
- Accumulated local effects
- Tree surrogate
- LocalModel: Local Interpretable Model-agnostic Explanations
- Shapley value for explaining single predictions
Read more about the methods in the [Interpretable Machine Learning](https://christophm.github.io/interpretable-ml-book/agnostic.html) book.
## Tutorial
Start an interactive notebook tutorial by clicking on this badge [](http://beta.mybinder.org/v2/gh/christophM/iml/master?filepath=./notebooks/tutorial-intro.ipynb)
```{r global_options, include=FALSE}
library(knitr)
opts_chunk$set(echo = TRUE, warning = FALSE, message = FALSE,
fig.path = "man/figures/README-")
set.seed(42)
```
## Installation
The package can be installed directly from CRAN and the development version from GitHub:
```{r, results = "hide", eval = FALSE}
# Stable version
install.packages("iml")
# Development version
remotes::install_github("christophM/iml")
```
## News
Changes of the packages can be accessed in the [NEWS file](https://christophm.github.io/iml/news/index.html).
## Quickstart
First we train a Random Forest to predict the Boston median housing value.
How does `lstat` influence the prediction individually and on average? (Accumulated local effects)
```{r}
library("iml")
library("randomForest")
data("Boston", package = "MASS")
rf = randomForest(medv ~ ., data = Boston, ntree = 50)
X = Boston[which(names(Boston) != "medv")]
model = Predictor$new(rf, data = X, y = Boston$medv)
effect = FeatureEffects$new(model)
effect$plot(features = c("lstat", "age", "rm"))
```
## Contribute
Please check the [contribution guidelines](CONTRIBUTING.md)
## Citation
If you use iml in a scientific publication, please cite it as:
```
Molnar, Christoph, Giuseppe Casalicchio, and Bernd Bischl. "iml: An R package for interpretable machine learning." Journal of Open Source Software 3.26 (2018): 786.
```
BibTeX:
```{tex}
@article{molnar2018iml,
title={iml: An R package for interpretable machine learning},
author={Molnar, Christoph and Casalicchio, Giuseppe and Bischl, Bernd},
journal={Journal of Open Source Software},
volume={3},
number={26},
pages={786},
year={2018}
}
```
## License
```{r, results='asis', echo=FALSE}
cat(sprintf(paste0("© 2018 - %s [Christoph Molnar](https://christophm.github.io/)"),
format(Sys.time(), "%Y")))
```
The contents of this repository are distributed under the MIT license. See
below for details:
```
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
## Funding
This work is funded by the Bavarian State Ministry of Education, Science and the Arts in the framework of the Centre Digitisation.Bavaria (ZD.B)