Skip to content

Commit 913b43d

Browse files
committed
Deploying to gh-pages from @ 784c8cb 🚀
1 parent 932a901 commit 913b43d

36 files changed

+101
-10
lines changed

dev/pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ pandoc: 3.1.11
22
pkgdown: 2.2.0
33
pkgdown_sha: ~
44
articles: {}
5-
last_built: 2026-03-04T10:59Z
5+
last_built: 2026-03-04T14:42Z
66
urls:
77
reference: https://mlr3mbo.mlr-org.com/reference
88
article: https://mlr3mbo.mlr-org.com/articles

dev/reference/AcqFunction.html

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

dev/reference/AcqFunction.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ Other Acquisition Function:
102102

103103
- [`AcqFunction$eval_dt()`](#method-AcqFunction-eval_dt)
104104

105+
- [`AcqFunction$assert_surrogate()`](#method-AcqFunction-assert_surrogate)
106+
105107
- [`AcqFunction$clone()`](#method-AcqFunction-clone)
106108

107109
Inherited methods
@@ -126,8 +128,9 @@ the active binding `$surrogate`.
126128
AcqFunction$new(
127129
id,
128130
constants = ParamSet$new(),
129-
surrogate,
131+
surrogate = NULL,
130132
requires_predict_type_se,
133+
surrogate_class,
131134
direction,
132135
packages = NULL,
133136
label = NA_character_,
@@ -157,6 +160,11 @@ the active binding `$surrogate`.
157160
Whether the acquisition function requires the surrogate to have `"se"`
158161
as `$predict_type`.
159162

163+
- `surrogate_class`:
164+
165+
(`character(1)`)
166+
Allowed class of the surrogate.
167+
160168
- `direction`:
161169

162170
(`"same"` \| `"minimize"` \| `"maximize"`). Optimization direction of
@@ -259,6 +267,31 @@ acquisition functions, e.g. `data.table(y = 1:2)` or
259267

260268
------------------------------------------------------------------------
261269

270+
### Method `assert_surrogate()`
271+
272+
Validate that the surrogate is compatible with this acquisition
273+
function. Asserts the surrogate class and that `$predict_type` is `"se"`
274+
if required. Subclasses with additional requirements must override this
275+
method.
276+
277+
#### Usage
278+
279+
AcqFunction$assert_surrogate(surrogate)
280+
281+
#### Arguments
282+
283+
- `surrogate`:
284+
285+
([Surrogate](https://mlr3mbo.mlr-org.com/dev/reference/Surrogate.md))
286+
Surrogate to validate.
287+
288+
#### Returns
289+
290+
The validated
291+
[Surrogate](https://mlr3mbo.mlr-org.com/dev/reference/Surrogate.md).
292+
293+
------------------------------------------------------------------------
294+
262295
### Method `clone()`
263296

264297
The objects of this class are cloneable with this method.

dev/reference/mlr_acqfunctions_aei.html

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

dev/reference/mlr_acqfunctions_aei.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ Inherited methods
8787
- [`bbotk::Objective$format()`](https://bbotk.mlr-org.com/reference/Objective.html#method-format)
8888
- [`bbotk::Objective$help()`](https://bbotk.mlr-org.com/reference/Objective.html#method-help)
8989
- [`bbotk::Objective$print()`](https://bbotk.mlr-org.com/reference/Objective.html#method-print)
90+
- [`mlr3mbo::AcqFunction$assert_surrogate()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-assert_surrogate)
9091
- [`mlr3mbo::AcqFunction$eval_dt()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-eval_dt)
9192
- [`mlr3mbo::AcqFunction$eval_many()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-eval_many)
9293
- [`mlr3mbo::AcqFunction$reset()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-reset)

dev/reference/mlr_acqfunctions_cb.html

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

dev/reference/mlr_acqfunctions_cb.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Inherited methods
6767
- [`bbotk::Objective$format()`](https://bbotk.mlr-org.com/reference/Objective.html#method-format)
6868
- [`bbotk::Objective$help()`](https://bbotk.mlr-org.com/reference/Objective.html#method-help)
6969
- [`bbotk::Objective$print()`](https://bbotk.mlr-org.com/reference/Objective.html#method-print)
70+
- [`mlr3mbo::AcqFunction$assert_surrogate()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-assert_surrogate)
7071
- [`mlr3mbo::AcqFunction$eval_dt()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-eval_dt)
7172
- [`mlr3mbo::AcqFunction$eval_many()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-eval_many)
7273
- [`mlr3mbo::AcqFunction$reset()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-reset)

dev/reference/mlr_acqfunctions_ehvi.html

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

dev/reference/mlr_acqfunctions_ehvi.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Inherited methods
7777
- [`bbotk::Objective$format()`](https://bbotk.mlr-org.com/reference/Objective.html#method-format)
7878
- [`bbotk::Objective$help()`](https://bbotk.mlr-org.com/reference/Objective.html#method-help)
7979
- [`bbotk::Objective$print()`](https://bbotk.mlr-org.com/reference/Objective.html#method-print)
80+
- [`mlr3mbo::AcqFunction$assert_surrogate()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-assert_surrogate)
8081
- [`mlr3mbo::AcqFunction$eval_dt()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-eval_dt)
8182
- [`mlr3mbo::AcqFunction$eval_many()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-eval_many)
8283
- [`mlr3mbo::AcqFunction$reset()`](https://mlr3mbo.mlr-org.com/dev/reference/AcqFunction.html#method-reset)

dev/reference/mlr_acqfunctions_ehvigh.html

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

0 commit comments

Comments
 (0)