Progressor

<p>Wraps <code><a href="https://progressr.futureverse.org/reference/progressor.html">progressr::progressor()</a></code> function and stores current progress.</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

Progressor function

<p><div class="r6-fields"></div></p><dl>
<dt><code>progressor</code></dt>
<dd><p>(<code><a href="https://progressr.futureverse.org/reference/progressor.html">progressr::progressor()</a></code>).</p></dd><p></p><p>
<dt><code>max_steps</code></dt>
<dd><p>(<code>integer(1)</code>).</p></dd></p><p>
<dt><code>current_steps</code></dt>
<dd><p>(<code>integer(1)</code>).</p></dd></p><p>
<dt><code>unit</code></dt>
<dd><p>(<code>character(1)</code>).</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/Progressor%24new()?package=bbotk&version=1.5.0" data-mini-rdoc="bbotk::Progressor$new()"><code>Progressor$new()</code></a></p></li>
<li><p><a href="/link/Progressor%24update()?package=bbotk&version=1.5.0" data-mini-rdoc="bbotk::Progressor$update()"><code>Progressor$update()</code></a></p></li>
<li><p><a href="/link/Progressor%24clone()?package=bbotk&version=1.5.0" data-mini-rdoc="bbotk::Progressor$clone()"><code>Progressor$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Progressor-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>Progressor$new(progressor, unit)</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>progressor</code></dt>
<dd><p>(<code><a href="https://progressr.futureverse.org/reference/progressor.html">progressr::progressor()</a></code>)<br>
Progressor function.</p></dd></dl></div></p><p>
<dt><code>unit</code></dt>
<dd><p>(<code>character(1)</code>)<br>
Unit of progress.</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-Progressor-update"></a></p><div class="section" id="method-update-">
<h3>Method <code><a href="/link/update()?package=bbotk&version=1.5.0" data-mini-rdoc="bbotk::update()">update()</a></code></h3>
<p>Updates <code><a href="https://progressr.futureverse.org/reference/progressor.html">progressr::progressor()</a></code> with current steps.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Progressor$update(terminator, archive)</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>terminator</code></dt>
<dd><p>(Terminator).</p></dd></dl></div></p><p>
<dt><code>archive</code></dt>
<dd><p>(Archive).</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-Progressor-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>Progressor$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

<p>Wraps <code><a href='https://progressr.futureverse.org/reference/progressor.html'>progressr::progressor()</a></code> function and stores current progress.</p>

Progressor — Progressor

<p><div class="r6-fields"></p><dl>
<dt><code>progressor</code></dt>
<dd><p>(<code><a href='https://progressr.futureverse.org/reference/progressor.html'>progressr::progressor()</a></code>).</p></dd>


<dt><code>max_steps</code></dt>
<dd><p>(<code>integer(1)</code>).</p></dd>


<dt><code>current_steps</code></dt>
<dd><p>(<code>integer(1)</code>).</p></dd>


<dt><code>unit</code></dt>
<dd><p>(<code>character(1)</code>).</p></dd>


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


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

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

</div><p><hr>
<a id="method-Progressor-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>Progressor$new(progressor, unit)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>progressor</code></dt>
<dd><p>(<code><a href='https://progressr.futureverse.org/reference/progressor.html'>progressr::progressor()</a></code>)<br />
Progressor function.</p></dd>


<dt><code>unit</code></dt>
<dd><p>(<code>character(1)</code>)<br />
Unit of progress.</p></dd>


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

</div><p><hr>
<a id="method-Progressor-update"></a></p><div class='section' id='method-update-'>
<h3>Method <code><a href='https://rdrr.io/r/stats/update.html'>update()</a></code></h3>
<p>Updates <code><a href='https://progressr.futureverse.org/reference/progressor.html'>progressr::progressor()</a></code> with current steps.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Progressor$update(terminator, archive)</code></pre><p></div></p>
</div>

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


<dt><code>archive</code></dt>
<dd><p>(Archive).</p></dd>


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

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


Progressor: Progressor

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `update()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method update()

Usage

Arguments

Method clone()

Usage

Arguments

Method `new()`

Method `update()`

Method `clone()`