InterpretationMethod

<p>Superclass container for Interpretation Method objects</p>

Interpretability methods to analyze the behavior and
predictions of any machine learning model.  Implemented methods are:
Feature importance described by Fisher et al. (2018)
<doi:10.48550/arxiv.1801.01489>, accumulated local effects plots described by Apley
(2018) <doi:10.48550/arxiv.1612.08468>, partial dependence plots described by
Friedman (2001) <www.jstor.org/stable/2699986>, individual conditional
expectation ('ice') plots described by Goldstein et al.  (2013)
<doi:10.1080/10618600.2014.907095>, local models (variant of 'lime')
described by Ribeiro et. al (2016) <doi:10.48550/arXiv.1602.04938>, the Shapley
Value described by Strumbelj et. al (2014)
<doi:10.1007/s10115-013-0679-x>, feature interactions described by
Friedman et. al <doi:10.1214/07-AOAS148> and tree surrogate models.

Giuseppe Casalicchio

Interpretable Machine Learning

Christoph Molnar

Patrick Schratz

InterpretationMethod function

<p><div class="r6-fields"></div></p><dl>
<dt><code>results</code></dt>
<dd><p><a href="/link/data.frame?package=iml&version=0.11.4" data-mini-rdoc="iml::data.frame">data.frame</a><br>
The aggregated results of the experiment</p></dd><p></p><p>
<dt><code>predictor</code></dt>
<dd><p>Predictor object.</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/InterpretationMethod%24new()?package=iml&version=0.11.4" data-mini-rdoc="iml::InterpretationMethod$new()"><code>InterpretationMethod$new()</code></a></p></li>
<li><p><a href="/link/InterpretationMethod%24plot()?package=iml&version=0.11.4" data-mini-rdoc="iml::InterpretationMethod$plot()"><code>InterpretationMethod$plot()</code></a></p></li>
<li><p><a href="/link/InterpretationMethod%24print()?package=iml&version=0.11.4" data-mini-rdoc="iml::InterpretationMethod$print()"><code>InterpretationMethod$print()</code></a></p></li>
<li><p><a href="/link/InterpretationMethod%24clone()?package=iml&version=0.11.4" data-mini-rdoc="iml::InterpretationMethod$clone()"><code>InterpretationMethod$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-InterpretationMethod-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create an InterpretationMethod object</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>InterpretationMethod$new(predictor)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>predictor</code></dt>
<dd><p>Predictor<br>
The object (created with <code>Predictor$new()</code>) holding the machine
learning model and the data.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-InterpretationMethod-plot"></a></p><div class="section" id="method-plot-">
<h3>Method <code><a href="/link/plot()?package=iml&version=0.11.4" data-mini-rdoc="iml::plot()">plot()</a></code></h3>
<p>Plot function. Calls <code>private$generatePlot()</code> of the
respective subclass.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>InterpretationMethod$plot(...)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>...</code></dt>
<dd><p>Passed to <code>private$generatePlot()</code>.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-InterpretationMethod-print"></a></p><div class="section" id="method-print-">
<h3>Method <code><a href="/link/print()?package=iml&version=0.11.4" data-mini-rdoc="iml::print()">print()</a></code></h3>
<p>Printer for InterpretationMethod objects</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>InterpretationMethod$print()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-InterpretationMethod-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>InterpretationMethod$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Interpretation Method — InterpretationMethod

<p><div class="r6-fields"></p><dl>
<dt><code>results</code></dt>
<dd><p><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a><br />
The aggregated results of the experiment</p></dd>


<dt><code>predictor</code></dt>
<dd><p>Predictor object.</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-InterpretationMethod-new'><code>InterpretationMethod$new()</code></a></p></li>
<li><p><a href='#method-InterpretationMethod-plot'><code>InterpretationMethod$plot()</code></a></p></li>
<li><p><a href='#method-InterpretationMethod-print'><code>InterpretationMethod$print()</code></a></p></li>
<li><p><a href='#method-InterpretationMethod-clone'><code>InterpretationMethod$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-InterpretationMethod-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create an InterpretationMethod object</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>InterpretationMethod$new(predictor)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>predictor</code></dt>
<dd><p>Predictor<br />
The object (created with <code>Predictor$new()</code>) holding the machine
learning model and the data.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-InterpretationMethod-plot"></a></p><div class='section' id='method-plot-'>
<h3>Method <code><a href='https://rdrr.io/r/graphics/plot.default.html'>plot()</a></code></h3>
<p>Plot function. Calls <code>private$generatePlot()</code> of the
respective subclass.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>InterpretationMethod$plot(...)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>...</code></dt>
<dd><p>Passed to <code>private$generatePlot()</code>.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-InterpretationMethod-print"></a></p><div class='section' id='method-print-'>
<h3>Method <code><a href='https://rdrr.io/r/base/print.html'>print()</a></code></h3>
<p>Printer for InterpretationMethod objects</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>InterpretationMethod$print()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-InterpretationMethod-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>InterpretationMethod$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


InterpretationMethod: Interpretation Method

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `plot()`

Usage

Arguments

Method `print()`

Usage

Method `clone()`

Usage

Arguments

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method plot()

Usage

Arguments

Method print()

Usage

Method clone()

Usage

Arguments

Method `new()`

Method `plot()`

Method `print()`

Method `clone()`