bbotk (version 0.5.2)

mlr_terminators: Dictionary of Terminators

Description

A simple mlr3misc::Dictionary storing objects of class Terminator. Each terminator has an associated help page, see mlr_terminators_[id].

This dictionary can get populated with additional terminators by add-on packages.

For a more convenient way to retrieve and construct terminator, see trm()/trms().

Format

R6::R6Class object inheriting from mlr3misc::Dictionary.

Methods

See mlr3misc::Dictionary.

S3 methods

• as.data.table(dict, ..., objects = FALSE) mlr3misc::Dictionary -> data.table::data.table() Returns a data.table::data.table() with fields "key", "label", "properties" and "unit" as columns. If objects is set to TRUE, the constructed objects are returned in the list column named object.

See Also

Sugar functions: trm(), trms()

Other Terminator: Terminator, mlr_terminators_clock_time, mlr_terminators_combo, mlr_terminators_evals, mlr_terminators_none, mlr_terminators_perf_reached, mlr_terminators_run_time, mlr_terminators_stagnation_batch, mlr_terminators_stagnation

Examples

# NOT RUN {
as.data.table(mlr_terminators)
mlr_terminators$get("evals")
trm("evals", n_evals = 10)
# }