mlr_terminators_perf_reached {bbotk}R Documentation

Performance Level Terminator

Description

Class to terminate the optimization after a performance level has been hit.

Dictionary

This Terminator can be instantiated via the dictionary mlr_terminators or with the associated sugar function trm():

mlr_terminators$get("perf_reached")
trm("perf_reached")

Parameters

level

numeric(1)
Performance level that needs to be reached. Default is 0. Terminates if the performance exceeds (respective measure has to be maximized) or falls below (respective measure has to be minimized) this value.

Super class

bbotk::Terminator -> TerminatorPerfReached

Methods

Public methods

Inherited methods

Method new()

Creates a new instance of this R6 class.

Usage
TerminatorPerfReached$new()

Method is_terminated()

Is TRUE iff the termination criterion is positive, and FALSE otherwise.

Usage
TerminatorPerfReached$is_terminated(archive)
Arguments
archive

(Archive).

Returns

logical(1).


Method clone()

The objects of this class are cloneable with this method.

Usage
TerminatorPerfReached$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

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

Examples

TerminatorPerfReached$new()
trm("perf_reached")

[Package bbotk version 0.8.0 Index]