Skip to content

Commit a97fdbf

Browse files
committed
docs: minor wording changes
1 parent 0716dd1 commit a97fdbf

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

R/AcqFunction.R

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,15 @@ AcqFunction = R6Class("AcqFunction",
8282
},
8383

8484
#' @description
85-
#' Evaluates multiple input values on the objective function.
85+
#' Evaluates multiple input values on the acquisition function.
8686
#'
8787
#' @param xss (`list()`)\cr
8888
#' A list of lists that contains multiple x values, e.g.
8989
#' `list(list(x1 = 1, x2 = 2), list(x1 = 3, x2 = 4))`.
9090
#'
9191
#' @return data.table::data.table() that contains one y-column for
92-
#' single-objective functions and multiple y-columns for multi-objective functions,
93-
#' e.g. `data.table(y = 1:2)` or `data.table(y1 = 1:2, y2 = 3:4)`.
92+
#' single-objective acquisition functions and multiple y-columns for multi-objective
93+
#' acquisition functions, e.g. `data.table(y = 1:2)` or `data.table(y1 = 1:2, y2 = 3:4)`.
9494
eval_many = function(xss) {
9595
if (self$check_values) lapply(xss, self$domain$assert)
9696
res = invoke(private$.fun, rbindlist(xss, use.names = TRUE, fill = TRUE), .args = self$constants$values)
@@ -105,8 +105,8 @@ AcqFunction = R6Class("AcqFunction",
105105
#' One point per row, e.g. `data.table(x1 = c(1, 3), x2 = c(2, 4))`.
106106
#'
107107
#' @return data.table::data.table() that contains one y-column for
108-
#' single-objective functions and multiple y-columns for multi-objective
109-
#' functions, e.g. `data.table(y = 1:2)` or `data.table(y1 = 1:2, y2 = 3:4)`.
108+
#' single-objective acquisition functions and multiple y-columns for multi-objective
109+
#' acquisition functions, e.g. `data.table(y = 1:2)` or `data.table(y1 = 1:2, y2 = 3:4)`.
110110
eval_dt = function(xdt) {
111111
if (self$check_values) self$domain$assert_dt(xdt)
112112
res = invoke(private$.fun, xdt, .args = self$constants$values)
@@ -118,7 +118,7 @@ AcqFunction = R6Class("AcqFunction",
118118
active = list(
119119
#' @field direction (`"same"` | `"minimize"` | `"maximize"`)\cr
120120
#' Optimization direction of the acquisition function relative to the direction of the
121-
#' objective function of the [bbotk::OptimInstance].
121+
#' objective function of the [bbotk::OptimInstance] related to the passed [bbotk::Archive].
122122
#' Must be `"same"`, `"minimize"`, or `"maximize"`.
123123
direction = function(rhs) {
124124
if (missing(rhs)) {

R/AcqOptimizer.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#' result in computing the q- or multi-Expected Improvement) but rather the top `n_candidates` are selected from the
1313
#' [bbotk::ArchiveBatch] of the acquisition function [bbotk::OptimInstanceBatch].
1414
#' Note that setting `n_candidates > 1` is usually not a sensible idea but it is still supported for experimental reasons.
15-
#' Note that in the case of the acquisition function [bbotk::OptimInstanceBatch] being multi-criteria, due to using an [AcqFunctionMulti],
15+
#' Note that in the case of the acquisition function [bbotk::OptimInstanceBatch] being multi-objective, due to using an [AcqFunctionMulti],
1616
#' selection of the best candidates is performed via non-dominated-sorting.
1717
#' Default is `1`.
1818
#' }
@@ -26,7 +26,7 @@
2626
#' the actual [bbotk::OptimInstance] (which is contained in the archive of the [AcqFunction])?
2727
#' This is sensible when using a population based acquisition function optimizer, e.g., local search or mutation.
2828
#' Default is `FALSE`.
29-
#' Note that in the case of the [bbotk::OptimInstance] being multi-criteria, selection of the best point(s) is performed via non-dominated-sorting.
29+
#' Note that in the case of the [bbotk::OptimInstance] being multi-objective, selection of the best point(s) is performed via non-dominated-sorting.
3030
#' }
3131
#' \item{`warmstart_size`}{`integer(1) | "all"`\cr
3232
#' Number of best points selected from the [bbotk::Archive] of the actual [bbotk::OptimInstance] that are to be used for warm starting.

man/AcqFunction.Rd

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/AcqOptimizer.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)