Learn R Programming

⚠️There's a newer version (1.6.0) of this package.Take me there.

bbotk - Black-Box Optimization Toolkit

Package website: release | dev

bbotk is a black-box optimization framework for R. It features highly configurable search spaces via the paradox package and optimizes every user-defined objective function. The package includes several optimization algorithms e.g. Random Search, Grid Search, Iterated Racing, Bayesian Optimization (in mlr3mbo) and Hyperband (in mlr3hyperband). bbotk is the base package of mlr3tuning, mlr3fselect and miesmuschel.

Resources

There are several sections about black-box optimization in the mlr3book. Often the sections about tuning are also relevant for general black-box optimization.

Installation

Install the latest release from CRAN.

install.packages("bbotk")

Install the development version from GitHub.

pak::pkg_install("mlr-org/bbotk")

Example

# define the objective function
fun = function(xs) {
  - (xs[[1]] - 2)^2 - (xs[[2]] + 3)^2 + 10
}

# set domain
domain = ps(
  x1 = p_dbl(-10, 10),
  x2 = p_dbl(-5, 5)
)

# set codomain
codomain = ps(
  y = p_dbl(tags = "maximize")
)

# create objective
objective = ObjectiveRFun$new(
  fun = fun,
  domain = domain,
  codomain = codomain,
  properties = "deterministic"
)

# initialize instance
instance = oi(
  objective = objective,
  terminator = trm("evals", n_evals = 20)
)

# load optimizer
optimizer = opt("gensa")

# trigger optimization
optimizer$optimize(instance)
##    x1 x2  x_domain  y
## 1:  2 -3 <list[2]> 10
# best performing configuration
instance$result
##    x1 x2  x_domain  y
## 1:  2 -3 <list[2]> 10
# all evaluated configuration
as.data.table(instance$archive)
##            x1        x2          y           timestamp batch_nr x_domain_x1 x_domain_x2
##  1: -4.689827 -1.278761 -37.716445 2024-08-13 17:52:54        1   -4.689827   -1.278761
##  2: -5.930364 -4.400474 -54.851999 2024-08-13 17:52:54        2   -5.930364   -4.400474
##  3:  7.170817 -1.519948 -18.927907 2024-08-13 17:52:54        3    7.170817   -1.519948
##  4:  2.045200 -1.519948   7.807403 2024-08-13 17:52:54        4    2.045200   -1.519948
##  5:  2.045200 -2.064742   9.123250 2024-08-13 17:52:54        5    2.045200   -2.064742
## ---                                                                                    
## 16:  2.000000 -3.000000  10.000000 2024-08-13 17:52:54       16    2.000000   -3.000000
## 17:  2.000001 -3.000000  10.000000 2024-08-13 17:52:54       17    2.000001   -3.000000
## 18:  1.999999 -3.000000  10.000000 2024-08-13 17:52:54       18    1.999999   -3.000000
## 19:  2.000000 -2.999999  10.000000 2024-08-13 17:52:54       19    2.000000   -2.999999
## 20:  2.000000 -3.000001  10.000000 2024-08-13 17:52:54       20    2.000000   -3.000001

Copy Link

Version

Install

install.packages('bbotk')

Monthly Downloads

5,811

Version

1.1.1

License

LGPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Marc Becker

Last Published

October 15th, 2024

Functions in bbotk (1.1.1)

Objective

Objective Function with Domain and Codomain
Archive

Data Storage
CallbackBatch

Create Batch Optimization Callback
Codomain

Codomain of Function
ContextAsync

Asynchronous Optimization Context
ArchiveAsync

Rush Data Storage
CallbackAsync

Create Asynchronous Optimization Callback
ContextBatch

Batch Optimization Context
ObjectiveRFun

Objective interface with custom R function
ArchiveBatch

Data Table Storage
ObjectiveRFunDt

Objective interface for basic R functions.
OptimInstanceAsyncMultiCrit

Multi Criteria Optimization Instance for Asynchronous Optimization
OptimInstance

Optimization Instance
ObjectiveRFunMany

Objective Interface with Custom R Function
OptimInstanceAsyncSingleCrit

Single Criterion Optimization Instance for Asynchronous Optimization
OptimInstanceAsync

Optimization Instance for Asynchronous Optimization
OptimInstanceBatchSingleCrit

Single Criterion Optimization Instance for Batch Optimization
OptimInstanceMultiCrit

Multi Criteria Optimization Instance for Batch Optimization
OptimizerBatch

Batch Optimizer
OptimInstanceBatchMultiCrit

Multi Criteria Optimization Instance for Batch Optimization
OptimizerAsync

Asynchronous Optimizer
OptimInstanceBatch

Optimization Instance for Batch Optimization
OptimInstanceSingleCrit

Single Criterion Optimization Instance for Batch Optimization
Optimizer

Optimizer
Progressor

Progressor
bbotk.backup

Backup Archive Callback
bbotk_assertions

Assertion for bbotk objects
Terminator

Abstract Terminator Class
branin

Branin Function
bbotk-package

bbotk: Black-Box Optimization Toolkit
bb_optimize

Black-Box Optimization
bbotk_reflections

Reflections for bbotk
mlr_optimizers_async_design_points

Asynchronous Optimization via Design Points
mlr_optimizers

Dictionary of Optimizer
bbotk_worker_loop

Worker loop for Rush
mlr_optimizers_design_points

Optimization via Design Points
mlr_optimizers_local_search

Optimization via Local Search
mlr_optimizers_cmaes

Optimization via Covariance Matrix Adaptation Evolution Strategy
mlr_optimizers_nloptr

Optimization via Non-linear Optimization
callback_batch

Create Batch Optimization Callback
as_terminator

Convert to a Terminator
callback_async

Create Asynchronous Optimization Callback
mlr_optimizers_async_random_search

Asynchronous Optimization via Random Search
assign_result_default

Default Assign Result Function
mlr_optimizers_async_grid_search

Asynchronous Optimization via Grid Search
mlr_optimizers_focus_search

Optimization via Focus Search
is_dominated

Calculate which points are dominated
mlr_optimizers_gensa

Optimization via Generalized Simulated Annealing
mlr_optimizers_grid_search

Optimization via Grid Search
mlr_optimizers_irace

Optimization via Iterated Racing
mlr_terminators_evals

Terminator that stops after a number of evaluations
mlr_terminators_none

None Terminator
mlr_terminators_stagnation

Terminator that stops when optimization does not improve
mlr_terminators_stagnation_batch

Terminator that stops when optimization does not improve
mlr_terminators_perf_reached

Performance Level Terminator
mlr_terminators_run_time

Run Time Terminator
mlr_terminators_combo

Combine Terminators
mlr_terminators_clock_time

Clock Time Terminator
mlr_terminators

Dictionary of Terminators
mlr_optimizers_random_search

Optimization via Random Search
shrink_ps

Shrink a ParamSet towards a point.
optimize_batch_default

Default Batch Optimization Function
search_start

Get start values for optimizers
mlr_terminators_stagnation_hypervolume

Stagnation Hypervolume Terminator
terminated_error

Termination Error
reexports

Objects exported from other packages
nds_selection

Best points w.r.t. non dominated sorting with hypervolume contribution.
oi_async

Syntactic Sugar for Asynchronous Optimization Instance Construction
oi

Syntactic Sugar for Optimization Instance Construction
optimize_async_default

Default Asynchronous Optimization
opt

Syntactic Sugar Optimizer Construction
trafo_xs

Calculate the transformed x-values
trm

Syntactic Sugar Terminator Construction
transform_xdt_to_xss

Calculates the transformed x-values