fs: Syntactic Sugar for FSelect Construction

View source: R/sugar.R

fsR Documentation

Syntactic Sugar for FSelect Construction

Description

Functions to retrieve objects, set parameters and assign to fields in one go. Relies on mlr3misc::dictionary_sugar_get() to extract objects from the respective mlr3misc::Dictionary:

  • fs() for a FSelector from mlr_fselectors.

  • fss() for a list of a FSelector from mlr_fselectors.

  • trm() for a bbotk::Terminator from mlr_terminators.

  • trms() for a list of Terminators from mlr_terminators.

Usage

fs(.key, ...)

fss(.keys, ...)

Arguments

.key

(character(1))
Key passed to the respective dictionary to retrieve the object.

...

(any)
Additional arguments.

.keys

(character())
Keys passed to the respective dictionary to retrieve multiple objects.

Value

R6::R6Class object of the respective type, or a list of R6::R6Class objects for the plural versions.

Examples

# random search with batch size of 5
fs("random_search", batch_size = 5)

# run time terminator with 20 seconds
trm("run_time", secs = 20)

mlr3fselect documentation built on Oct. 30, 2024, 9:19 a.m.