diff --git a/DESCRIPTION b/DESCRIPTION index ce2f34e3..ccfc0616 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: bbotk Title: Black-Box Optimization Toolkit -Version: 0.8.0.9000 +Version: 1.0.0 Authors@R: c( person("Marc", "Becker", , "marcbecker@posteo.de", role = c("cre", "aut"), comment = c(ORCID = "0000-0002-8115-0400")), diff --git a/NEWS.md b/NEWS.md index 3c5a79d6..b9f9952a 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# bbotk (development version) +# bbotk 1.0.0 * feat: Introduce asynchronous optimization with the `OptimizerAsync` and `OptimInstanceAsync` classes. * BREAKING CHANGE: The `Optimizer` class is `OptimizerBatch` now. diff --git a/R/Codomain.R b/R/Codomain.R index d787ae50..f97853ed 100644 --- a/R/Codomain.R +++ b/R/Codomain.R @@ -1,12 +1,12 @@ #' @title Codomain of Function #' #' @description -#' A [ParamSet] defining the codomain of a function. The parameter +#' A [paradox::ParamSet] defining the codomain of a function. The parameter #' set must contain at least one target parameter tagged with `"minimize"` or #' `"maximize"`. The codomain may contain extra parameters which are ignored #' when calling the [Archive] methods `$best()`, `$nds_selection()` and #' `$cols_y`. This class is usually constructed internally from a -#' [ParamSet] when [Objective] is initialized. +#' [paradox::ParamSet] when [Objective] is initialized. #' #' @export #' @examples @@ -43,7 +43,7 @@ Codomain = R6Class("Codomain", inherit = paradox::ParamSet, #' #' @param params (`list()`)\cr #' Named list with which to initialize the codomain. - #' This argument is analogous to [ParamSet]'s `$initialize()` `params` argument. + #' This argument is analogous to [paradox::ParamSet]'s `$initialize()` `params` argument. initialize = function(params) { assert_list(params) diff --git a/R/helper.R b/R/helper.R index b172f54b..3aa93127 100644 --- a/R/helper.R +++ b/R/helper.R @@ -77,7 +77,7 @@ trafo_xs = function(xs, search_space) { #' Returns a named numeric vector with start #' values for optimizers. #' -#' @param search_space [ParamSet]. +#' @param search_space [paradox::ParamSet]. #' @param type (`character(1)`)\cr #' `random` start values or `center` of search space? #' diff --git a/README.md b/README.md index f183c3cd..aa6eb963 100644 --- a/README.md +++ b/README.md @@ -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 2024-02-29 11:22:29 1 -4.689827 -1.278761 - ## 2: -5.930364 -4.400474 -54.851999 2024-02-29 11:22:29 2 -5.930364 -4.400474 - ## 3: 7.170817 -1.519948 -18.927907 2024-02-29 11:22:29 3 7.170817 -1.519948 - ## 4: 2.045200 -1.519948 7.807403 2024-02-29 11:22:29 4 2.045200 -1.519948 - ## 5: 2.045200 -2.064742 9.123250 2024-02-29 11:22:29 5 2.045200 -2.064742 - ## 6: 2.045200 -2.064742 9.123250 2024-02-29 11:22:29 6 2.045200 -2.064742 - ## 7: 2.045201 -2.064742 9.123250 2024-02-29 11:22:29 7 2.045201 -2.064742 - ## 8: 2.045199 -2.064742 9.123250 2024-02-29 11:22:29 8 2.045199 -2.064742 - ## 9: 2.045200 -2.064741 9.123248 2024-02-29 11:22:29 9 2.045200 -2.064741 - ## 10: 2.045200 -2.064743 9.123252 2024-02-29 11:22:29 10 2.045200 -2.064743 + ## 1: -4.689827 -1.278761 -37.716445 2024-06-21 09:34:39 1 -4.689827 -1.278761 + ## 2: -5.930364 -4.400474 -54.851999 2024-06-21 09:34:39 2 -5.930364 -4.400474 + ## 3: 7.170817 -1.519948 -18.927907 2024-06-21 09:34:39 3 7.170817 -1.519948 + ## 4: 2.045200 -1.519948 7.807403 2024-06-21 09:34:39 4 2.045200 -1.519948 + ## 5: 2.045200 -2.064742 9.123250 2024-06-21 09:34:39 5 2.045200 -2.064742 + ## 6: 2.045200 -2.064742 9.123250 2024-06-21 09:34:39 6 2.045200 -2.064742 + ## 7: 2.045201 -2.064742 9.123250 2024-06-21 09:34:39 7 2.045201 -2.064742 + ## 8: 2.045199 -2.064742 9.123250 2024-06-21 09:34:39 8 2.045199 -2.064742 + ## 9: 2.045200 -2.064741 9.123248 2024-06-21 09:34:39 9 2.045200 -2.064741 + ## 10: 2.045200 -2.064743 9.123252 2024-06-21 09:34:39 10 2.045200 -2.064743 ### Quick optimization with `bb_optimize` @@ -157,5 +157,5 @@ result$par result$value ``` - ## y1 + ## y1 ## -142.5479 diff --git a/man-roxygen/field_context.R b/man-roxygen/field_context.R index 3c68b10f..679f1ce8 100644 --- a/man-roxygen/field_context.R +++ b/man-roxygen/field_context.R @@ -1,2 +1,2 @@ -#' @field context ([Context])\cr +#' @field context ([ContextBatch])\cr #' Stores the context for the callbacks. diff --git a/man/Codomain.Rd b/man/Codomain.Rd index f5cbb275..2c34eb83 100644 --- a/man/Codomain.Rd +++ b/man/Codomain.Rd @@ -4,12 +4,12 @@ \alias{Codomain} \title{Codomain of Function} \description{ -A \link{ParamSet} defining the codomain of a function. The parameter +A \link[paradox:ParamSet]{paradox::ParamSet} defining the codomain of a function. The parameter set must contain at least one target parameter tagged with \code{"minimize"} or \code{"maximize"}. The codomain may contain extra parameters which are ignored when calling the \link{Archive} methods \verb{$best()}, \verb{$nds_selection()} and \verb{$cols_y}. This class is usually constructed internally from a -\link{ParamSet} when \link{Objective} is initialized. +\link[paradox:ParamSet]{paradox::ParamSet} when \link{Objective} is initialized. } \examples{ @@ -114,7 +114,7 @@ Creates a new instance of this \link[R6:R6Class]{R6} class. \describe{ \item{\code{params}}{(\code{list()})\cr Named list with which to initialize the codomain. -This argument is analogous to \link{ParamSet}'s \verb{$initialize()} \code{params} argument.} +This argument is analogous to \link[paradox:ParamSet]{paradox::ParamSet}'s \verb{$initialize()} \code{params} argument.} } \if{html}{\out{}} } diff --git a/man/Objective.Rd b/man/Objective.Rd index e36c39cd..334c45b3 100644 --- a/man/Objective.Rd +++ b/man/Objective.Rd @@ -15,7 +15,7 @@ The \code{Objective} class describes a black-box objective function that maps an \item{\code{callbacks}}{(list of \link[mlr3misc:Callback]{mlr3misc::Callback})\cr Callbacks applied during the optimization.} -\item{\code{context}}{(\link{Context})\cr +\item{\code{context}}{(\link{ContextBatch})\cr Stores the context for the callbacks.} \item{\code{id}}{(\code{character(1)})).} diff --git a/man/search_start.Rd b/man/search_start.Rd index 411d2b70..6dc5d67a 100644 --- a/man/search_start.Rd +++ b/man/search_start.Rd @@ -7,7 +7,7 @@ search_start(search_space, type = "random") } \arguments{ -\item{search_space}{\link{ParamSet}.} +\item{search_space}{\link[paradox:ParamSet]{paradox::ParamSet}.} \item{type}{(\code{character(1)})\cr \code{random} start values or \code{center} of search space?}