ResultAssigner: Result Assigner Base Class

In mlr3mbo: Flexible Bayesian Optimization

Result Assigner Base Class

Description

Abstract result assigner class.

A result assigner is responsible for assigning the final optimization result to the bbotk::OptimInstance. Normally, it is only used within an OptimizerMbo.

Active bindings

label

(character(1))
Label for this object.

man

(character(1))
String in the format ⁠[pkg]::[topic]⁠ pointing to a manual page for this object.

packages

(character())
Set of required packages. A warning is signaled if at least one of the packages is not installed, but loaded (not attached) later on-demand via requireNamespace().

Methods

Public methods

• ResultAssigner$new()

• ResultAssigner$assign_result()

• ResultAssigner$format()

• ResultAssigner$print()

• ResultAssigner$clone()

---

Method new()

Creates a new instance of this R6 class.

Usage

ResultAssigner$new(label = NA_character_, man = NA_character_)

Arguments

label

(character(1))
Label for this object.

man

(character(1))
String in the format ⁠[pkg]::[topic]⁠ pointing to a manual page for this object.

---

Method assign_result()

Assigns the result, i.e., the final point(s) to the instance.

Usage

ResultAssigner$assign_result(instance)

Arguments

instance

(bbotk::OptimInstanceBatchSingleCrit | bbotk::OptimInstanceBatchMultiCrit)
The bbotk::OptimInstance the final result should be assigned to.

---

Method format()

Helper for print outputs.

Usage

ResultAssigner$format()

Returns

(character(1)).

---

Method print()

Print method.

Usage

ResultAssigner$print()

Returns

(character()).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ResultAssigner$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other Result Assigner: mlr_result_assigners, mlr_result_assigners_archive, mlr_result_assigners_surrogate

mlr3mbo documentation built on Oct. 17, 2024, 1:06 a.m.