ContextBatch

<p>A CallbackBatch accesses and modifies data during the optimization via the <code>ContextBatch</code>.
See the section on active bindings for a list of modifiable objects.
See <code>callback_batch()</code> for a list of stages which that <code>ContextBatch</code>.</p>

Features highly configurable search spaces via the 'paradox'
package and optimizes every user-defined objective function. The
package includes several optimization algorithms e.g. Random Search,
Iterated Racing, Bayesian Optimization (in 'mlr3mbo') and Hyperband
(in 'mlr3hyperband'). bbotk is the base package of 'mlr3tuning',
'mlr3fselect' and 'miesmuschel'.

Marc Becker

bbotk

Black-Box Optimization Toolkit

Jakob Richter

Michel Lang

Bernd Bischl

Martin Binder

Olaf Mersmann

ContextBatch function

<p><code>mlr3misc::Context</code> -&gt; <code>ContextBatch</code></p>

Super class

<p><div class="r6-fields"></div></p><dl>
<dt><code>instance</code></dt>
<dd><p>(OptimInstance).</p></dd><p></p><p>
<dt><code>optimizer</code></dt>
<dd><p>(Optimizer).</p></dd></p><p>
</p></dl><p></p>

Public fields

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>xdt</code></dt>
<dd><p>(<a href="https://rdatatable.gitlab.io/data.table/reference/data.table.html">data.table::data.table</a>)<br>
The points of the latest batch.
Contains the values in the search space i.e. transformations are not yet applied.</p></dd><p></p><p>
<dt><code>result</code></dt>
<dd><p>(<a href="https://rdatatable.gitlab.io/data.table/reference/data.table.html">data.table::data.table</a>)<br>
The result of the optimization.</p></dd></p><p>
</p></dl><p></p>

Active bindings


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/ContextBatch%24new()?package=bbotk&version=1.1.1" data-mini-rdoc="bbotk::ContextBatch$new()"><code>ContextBatch$new()</code></a></p></li>
<li><p><a href="/link/ContextBatch%24clone()?package=bbotk&version=1.1.1" data-mini-rdoc="bbotk::ContextBatch$clone()"><code>ContextBatch$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="Context" data-id="format"><a href="/link/mlr3misc%3A%3AContext%24format()?package=bbotk&version=1.1.1" data-mini-rdoc="bbotk::mlr3misc::Context$format()"><code>mlr3misc::Context$format()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Context" data-id="print"><a href="/link/mlr3misc%3A%3AContext%24print()?package=bbotk&version=1.1.1" data-mini-rdoc="bbotk::mlr3misc::Context$print()"><code>mlr3misc::Context$print()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-ContextBatch-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Creates a new instance of this <a href="https://r6.r-lib.org/reference/R6Class.html">R6</a> class.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ContextBatch$new(inst, optimizer)</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>inst</code></dt>
<dd><p>(OptimInstance).</p></dd></dl></div></p><p>
<dt><code>optimizer</code></dt>
<dd><p>(Optimizer).</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-ContextBatch-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>ContextBatch$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

Batch Optimization Context — ContextBatch

<p><div class="r6-fields"></p><dl>
<dt><code>instance</code></dt>
<dd><p>(OptimInstance).</p></dd>


<dt><code>optimizer</code></dt>
<dd><p>(Optimizer).</p></dd>


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

<p><div class="r6-active-bindings"></p><dl>
<dt><code>xdt</code></dt>
<dd><p>(<a href='https://rdatatable.gitlab.io/data.table/reference/data.table.html'>data.table::data.table</a>)<br />
The points of the latest batch.
Contains the values in the search space i.e. transformations are not yet applied.</p></dd>


<dt><code>result</code></dt>
<dd><p>(<a href='https://rdatatable.gitlab.io/data.table/reference/data.table.html'>data.table::data.table</a>)<br />
The result of the optimization.</p></dd>


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


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

<ul>
<li><p><a href='#method-ContextBatch-new'><code>ContextBatch$new()</code></a></p></li>
<li><p><a href='#method-ContextBatch-clone'><code>ContextBatch$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="Context" data-id="format"><a href='../../mlr3misc/html/Context.html#method-Context-format'><code>mlr3misc::Context$format()</code></a></span></li>
<li><span class="pkg-link" data-pkg="mlr3misc" data-topic="Context" data-id="print"><a href='../../mlr3misc/html/Context.html#method-Context-print'><code>mlr3misc::Context$print()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-ContextBatch-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Creates a new instance of this <a href='https://r6.r-lib.org/reference/R6Class.html'>R6</a> class.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ContextBatch$new(inst, optimizer)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>inst</code></dt>
<dd><p>(OptimInstance).</p></dd>


<dt><code>optimizer</code></dt>
<dd><p>(Optimizer).</p></dd>


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

</div><p><hr>
<a id="method-ContextBatch-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>ContextBatch$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>


ContextBatch: Batch Optimization Context

Description

Arguments

Super class

Public fields

Active bindings

Methods

Public methods

Method `new()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Description

Arguments

Super class

Public fields

Active bindings

Methods

Public methods

Method new()

Usage

Arguments

Method clone()

Usage

Arguments

Method `new()`

Method `clone()`