bbotk (version 1.5.0)

ContextAsync: Asynchronous Optimization Context

Description

A CallbackAsync accesses and modifies data during the optimization via the ContextAsync. See the section on active bindings for a list of modifiable objects. See callback_async() for a list of stages which access ContextAsync.

Super class

mlr3misc::Context -> ContextAsync

Public fields

instance

(OptimInstance).

optimizer

(Optimizer).

Active bindings

xs

(list())
The point to be evaluated in instance$.eval_point().

xs_trafoed

(list())
The transformed point to be evaluated in instance$.eval_point().

extra

(list())
Additional information of the point to be evaluated in instance$.eval_point().

ys

(list())
The result of the evaluation in instance$.eval_point().

result_xdt

(data.table::data.table)
The xdt passed to instance$assign_result().

result_y

(numeric(1))
The y passed to instance$assign_result(). Only available for single criterion optimization.

result_ydt

(data.table::data.table)
The ydt passed to instance$assign_result(). Only available for multi criterion optimization.

result_extra

(data.table::data.table)
Additional information about the result passed to instance$assign_result().

result

(data.table::data.table)
The result of the optimization in instance$assign_result().

Methods

Public methods

• ContextAsync$new()

• ContextAsync$clone()

Inherited methods

• mlr3misc::Context$format()
• mlr3misc::Context$print()

---

Method new()

Creates a new instance of this R6 class.

Usage

ContextAsync$new(inst, optimizer)

Arguments

inst

(OptimInstance).

optimizer

(Optimizer).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ContextAsync$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Changes to $instance and $optimizer in the stages executed on the workers are not reflected in the main process.