Skip to contents

A simple mlr3misc::Dictionary storing objects of class AcqFunction. Each acquisition function has an associated help page, see mlr_acqfunctions_[id].

For a more convenient way to retrieve and construct an acquisition function, see acqf() and acqfs().

Format

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

Methods

See mlr3misc::Dictionary.

Examples

library(data.table)
as.data.table(mlr_acqfunctions)
#> Key: <key>
#>               key                                                        label
#>            <char>                                                       <char>
#>  1:           aei                               Augmented Expected Improvement
#>  2:            cb                               Lower / Upper Confidence Bound
#>  3:          ehvi                             Expected Hypervolume Improvement
#>  4:        ehvigh           Expected Hypervolume Improvement via GH Quadrature
#>  5:            ei                                         Expected Improvement
#>  6:        ei_log                            Expected Improvement on Log Scale
#>  7:          eips                              Expected Improvement Per Second
#>  8:          mean                                               Posterior Mean
#>  9:         multi Acquisition Function Wrapping Multiple Acquisition Functions
#> 10:            pi                                   Probability Of Improvement
#> 11:            sd                                 Posterior Standard Deviation
#> 12:        smsego                                                      SMS-EGO
#> 13: stochastic_cb                    Stochastic Lower / Upper Confidence Bound
#> 14: stochastic_ei                              Stochastic Expected Improvement
#>                                         man
#>                                      <char>
#>  1:           mlr3mbo::mlr_acqfunctions_aei
#>  2:            mlr3mbo::mlr_acqfunctions_cb
#>  3:          mlr3mbo::mlr_acqfunctions_ehvi
#>  4:        mlr3mbo::mlr_acqfunctions_ehvigh
#>  5:            mlr3mbo::mlr_acqfunctions_ei
#>  6:        mlr3mbo::mlr_acqfunctions_ei_log
#>  7:          mlr3mbo::mlr_acqfunctions_eips
#>  8:          mlr3mbo::mlr_acqfunctions_mean
#>  9:         mlr3mbo::mlr_acqfunctions_multi
#> 10:            mlr3mbo::mlr_acqfunctions_pi
#> 11:            mlr3mbo::mlr_acqfunctions_sd
#> 12:        mlr3mbo::mlr_acqfunctions_smsego
#> 13: mlr3mbo::mlr_acqfunctions_stochastic_cb
#> 14: mlr3mbo::mlr_acqfunctions_stochastic_ei
acqf("ei")
#> 
#> ── <AcqFunctionEI> ─────────────────────────────────────────────────────────────
#> • Domain:
#> Empty data.table (0 rows and 5 cols): id,class,lower,upper,nlevels
#> • Codomain:
#> Empty data.table (0 rows and 4 cols): id,class,lower,upper
#> • Constants:
#>         id    class lower upper nlevels
#>     <char>   <char> <num> <num>   <num>
#> 1: epsilon ParamDbl     0   Inf     Inf