Skip to content

Commit

Permalink
release: 1.0.0 (#237)
Browse files Browse the repository at this point in the history
* release: 1.0.0

* chore: remove remotes

* docs: links

* docs: links

* docs: links
  • Loading branch information
be-marc authored Jun 28, 2024
1 parent 6ae723e commit 22bbf91
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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", , "[email protected]", role = c("cre", "aut"),
comment = c(ORCID = "0000-0002-8115-0400")),
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 3 additions & 3 deletions R/Codomain.R
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion R/helper.R
Original file line number Diff line number Diff line change
Expand Up @@ -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?
#'
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down Expand Up @@ -157,5 +157,5 @@ result$par
result$value
```

## y1
## y1
## -142.5479
2 changes: 1 addition & 1 deletion man-roxygen/field_context.R
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#' @field context ([Context])\cr
#' @field context ([ContextBatch])\cr
#' Stores the context for the callbacks.
6 changes: 3 additions & 3 deletions man/Codomain.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/Objective.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/search_start.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 22bbf91

Please sign in to comment.