CallbackResample

<p>Specialized mlr3misc::Callback to customize the behavior of <code>resample()</code> and <code>benchmark()</code> in mlr3.
For example, callbacks can be used to extract information from models on the worker or to store intermediate results to disk.
The <code>callback_resample()</code> function is used to create instances of this class.
Predefined callbacks are stored in the dictionary mlr_callbacks and can be retrieved with <code>clbk()</code>.
For more information on callbacks, see the <code>callback_resample()</code> documentation.</p>

Efficient, object-oriented programming on the
building blocks of machine learning. Provides 'R6' objects for tasks,
learners, resamplings, and measures. The package is geared towards
scalability and larger datasets by supporting parallelization and
out-of-memory data-backends like databases. While 'mlr3' focuses on
the core computational operations, add-on packages provide additional
functionality.

Marc Becker

mlr3

Machine Learning in R - Next Generation

Michel Lang

Bernd Bischl

Jakob Richter

Patrick Schratz

Giuseppe Casalicchio

Stefan Coors

Quay Au

Martin Binder

Florian Pfisterer

Raphael Sonabend

Lennart Schneider

Sebastian Fischer

Lona Koers

John Zobolas

CallbackResample function

<p><code>mlr3misc::Callback</code> -&gt; <code>CallbackResample</code></p>

Super class

<p><div class="r6-fields"></div></p><dl>
<dt><code>on_resample_begin</code></dt>
<dd><p>(<code>function()</code>)<br>
Stage called at the beginning of the resampling iteration.
Called in <code>workhorse()</code> (internal).</p></dd><p></p><p>
<dt><code>on_resample_before_train</code></dt>
<dd><p>(<code>function()</code>)<br>
Stage called before training the learner.
Called in <code>workhorse()</code> (internal).</p></dd></p><p>
<dt><code>on_resample_before_predict</code></dt>
<dd><p>(<code>function()</code>)<br>
Stage called before predicting.
Called in <code>workhorse()</code> (internal).</p></dd></p><p>
<dt><code>on_resample_end</code></dt>
<dd><p>(<code>function()</code>)<br>
Stage called at the end of the resample iteration.
Called in <code>workhorse()</code> (internal).</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/CallbackResample%24clone()?package=mlr3&version=0.23.0" data-mini-rdoc="mlr3::CallbackResample$clone()"><code>CallbackResample$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="call"><a href="/link/mlr3misc%3A%3ACallback%24call()?package=mlr3&version=0.23.0" data-mini-rdoc="mlr3::mlr3misc::Callback$call()"><code>mlr3misc::Callback$call()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="format"><a href="/link/mlr3misc%3A%3ACallback%24format()?package=mlr3&version=0.23.0" data-mini-rdoc="mlr3::mlr3misc::Callback$format()"><code>mlr3misc::Callback$format()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="help"><a href="/link/mlr3misc%3A%3ACallback%24help()?package=mlr3&version=0.23.0" data-mini-rdoc="mlr3::mlr3misc::Callback$help()"><code>mlr3misc::Callback$help()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="initialize"><a href="/link/mlr3misc%3A%3ACallback%24initialize()?package=mlr3&version=0.23.0" data-mini-rdoc="mlr3::mlr3misc::Callback$initialize()"><code>mlr3misc::Callback$initialize()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="print"><a href="/link/mlr3misc%3A%3ACallback%24print()?package=mlr3&version=0.23.0" data-mini-rdoc="mlr3::mlr3misc::Callback$print()"><code>mlr3misc::Callback$print()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-CallbackResample-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>CallbackResample$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

Resample Callback — CallbackResample

<p><div class="r6-fields"></p><dl>
<dt><code>on_resample_begin</code></dt>
<dd><p>(<code>function()</code>)<br />
Stage called at the beginning of the resampling iteration.
Called in <code>workhorse()</code> (internal).</p></dd>


<dt><code>on_resample_before_train</code></dt>
<dd><p>(<code>function()</code>)<br />
Stage called before training the learner.
Called in <code>workhorse()</code> (internal).</p></dd>


<dt><code>on_resample_before_predict</code></dt>
<dd><p>(<code>function()</code>)<br />
Stage called before predicting.
Called in <code>workhorse()</code> (internal).</p></dd>


<dt><code>on_resample_end</code></dt>
<dd><p>(<code>function()</code>)<br />
Stage called at the end of the resample iteration.
Called in <code>workhorse()</code> (internal).</p></dd>


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


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

<ul>
<li><p><a href='#method-CallbackResample-clone'><code>CallbackResample$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="call"><a href='../../mlr3misc/html/Callback.html#method-Callback-call'><code>mlr3misc::Callback$call()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="format"><a href='../../mlr3misc/html/Callback.html#method-Callback-format'><code>mlr3misc::Callback$format()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="help"><a href='../../mlr3misc/html/Callback.html#method-Callback-help'><code>mlr3misc::Callback$help()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="initialize"><a href='../../mlr3misc/html/Callback.html#method-Callback-initialize'><code>mlr3misc::Callback$initialize()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Callback" data-id="print"><a href='../../mlr3misc/html/Callback.html#method-Callback-print'><code>mlr3misc::Callback$print()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-CallbackResample-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>CallbackResample$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>


CallbackResample: Resample Callback

Description

Arguments

Super class

Public fields

Methods

Public methods

Method `clone()`

Usage

Arguments

Description

Arguments

Super class

Public fields

Methods

Public methods

Method clone()

Usage

Arguments

Method `clone()`