From 23cc47f844378b23fb89270cb2105cef75ddb975 Mon Sep 17 00:00:00 2001 From: be-marc Date: Mon, 13 Nov 2023 10:37:23 +0100 Subject: [PATCH] release: 0.7.3 --- DESCRIPTION | 2 +- NEWS.md | 2 +- README.md | 32 ++++++++++++++++---------------- man/mlr_terminators_evals.Rd | 2 +- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index c38712391..3f98b5ead 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: bbotk Title: Black-Box Optimization Toolkit -Version: 0.7.2.9000 +Version: 0.7.3 Authors@R: c(person(given = "Marc", family = "Becker", diff --git a/NEWS.md b/NEWS.md index ce2be4d39..fe4c82e3d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# bbotk 0.7.2.9000 +# bbotk 0.7.3 * fix: `OptimInstance$print()` errored when the search space was empty. diff --git a/README.md b/README.md index 289770fc4..58df9863c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # bbotk - Black-Box Optimization Toolkit -Package website: [release](https://bbotk.mlr-org.com/) | +Package website: [release](https://bbotk.mlr-org.com/) \| [dev](https://bbotk.mlr-org.com/dev/) @@ -26,22 +26,22 @@ base package of [mlr3tuning](https://github.com/mlr-org/mlr3tuning), The package includes the basic building blocks of optimization: - - `Optimizer`: Objects of this class allow you to optimize an object +- `Optimizer`: Objects of this class allow you to optimize an object of the class `OptimInstance`. - - `OptimInstance`: Defines the optimization problem, consisting of an +- `OptimInstance`: Defines the optimization problem, consisting of an `Objective`, the `search_space`, and a `Terminator`. All evaluations on the `OptimInstance` will be automatically stored in its own `Archive`. - - `Objective`: Objects of this class contain the objective function. +- `Objective`: Objects of this class contain the objective function. The class ensures that the objective function is called in the right way and defines, whether the function should be minimized or maximized. - - `Terminator`: Objects of this class control the termination of the +- `Terminator`: Objects of this class control the termination of the optimization independent of the optimizer. ## Resources - - Package +- Package [vignette](https://CRAN.R-project.org/package=bbotk/vignettes/bbotk.html) ## Installation @@ -120,16 +120,16 @@ as.data.table(instance$archive) ``` ## x1 x2 y timestamp batch_nr x_domain_x1 x_domain_x2 - ## 1: -4.689827 -1.278761 -37.716445 2022-11-18 11:17:17 1 -4.689827 -1.278761 - ## 2: -5.930364 -4.400474 -54.851999 2022-11-18 11:17:17 2 -5.930364 -4.400474 - ## 3: 7.170817 -1.519948 -18.927907 2022-11-18 11:17:17 3 7.170817 -1.519948 - ## 4: 2.045200 -1.519948 7.807403 2022-11-18 11:17:17 4 2.045200 -1.519948 - ## 5: 2.045200 -2.064742 9.123250 2022-11-18 11:17:17 5 2.045200 -2.064742 - ## 6: 2.045200 -2.064742 9.123250 2022-11-18 11:17:17 6 2.045200 -2.064742 - ## 7: 2.045201 -2.064742 9.123250 2022-11-18 11:17:17 7 2.045201 -2.064742 - ## 8: 2.045199 -2.064742 9.123250 2022-11-18 11:17:17 8 2.045199 -2.064742 - ## 9: 2.045200 -2.064741 9.123248 2022-11-18 11:17:17 9 2.045200 -2.064741 - ## 10: 2.045200 -2.064743 9.123252 2022-11-18 11:17:17 10 2.045200 -2.064743 + ## 1: -4.689827 -1.278761 -37.716445 2023-11-13 10:35:33 1 -4.689827 -1.278761 + ## 2: -5.930364 -4.400474 -54.851999 2023-11-13 10:35:33 2 -5.930364 -4.400474 + ## 3: 7.170817 -1.519948 -18.927907 2023-11-13 10:35:33 3 7.170817 -1.519948 + ## 4: 2.045200 -1.519948 7.807403 2023-11-13 10:35:33 4 2.045200 -1.519948 + ## 5: 2.045200 -2.064742 9.123250 2023-11-13 10:35:33 5 2.045200 -2.064742 + ## 6: 2.045200 -2.064742 9.123250 2023-11-13 10:35:33 6 2.045200 -2.064742 + ## 7: 2.045201 -2.064742 9.123250 2023-11-13 10:35:33 7 2.045201 -2.064742 + ## 8: 2.045199 -2.064742 9.123250 2023-11-13 10:35:33 8 2.045199 -2.064742 + ## 9: 2.045200 -2.064741 9.123248 2023-11-13 10:35:33 9 2.045200 -2.064741 + ## 10: 2.045200 -2.064743 9.123252 2023-11-13 10:35:33 10 2.045200 -2.064743 ### Quick optimization with `bb_optimize` diff --git a/man/mlr_terminators_evals.Rd b/man/mlr_terminators_evals.Rd index 921f970c5..111c747fb 100644 --- a/man/mlr_terminators_evals.Rd +++ b/man/mlr_terminators_evals.Rd @@ -10,7 +10,7 @@ An evaluation is defined by one resampling of a parameter value. The total number of evaluations \eqn{B} is defined as \deqn{ - B = \mathrm{n_evals} + k * D + B = \mathtt{n\_evals} + \mathtt{k} * D }{ B = n_evals + k * D }