Skip to content

Commit 707dacd

Browse files
committed
Update entropy search descriptions
1 parent 054cd5c commit 707dacd

File tree

5 files changed

+36
-8
lines changed

5 files changed

+36
-8
lines changed

botorch/acquisition/joint_entropy_search.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ class qLowerBoundJointEntropySearch(qLowerBoundMultiObjectiveJointEntropySearch)
3131
at a candidate point `X` and the optimal input-output pair.
3232
3333
See [Tu2022]_ for a discussion on the estimation procedure.
34+
35+
NOTES:
36+
(i) The estimated acquisition value could be negative.
37+
38+
(ii) The lower bound batch acquisition function might not be monotone in the
39+
sense that adding more elements to the batch does not necessarily increase the
40+
acquisition value. Specifically, the acquisition value can become smaller when
41+
more inputs are added.
3442
"""
3543

3644
def __init__(

botorch/acquisition/multi_objective/joint_entropy_search.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,14 @@ class qLowerBoundMultiObjectiveJointEntropySearch(
264264
at a candidate point `X` and the Pareto optimal input-output pairs.
265265
266266
See [Tu2022]_ for a discussion on the estimation procedure.
267+
268+
NOTES:
269+
(i) The estimated acquisition value could be negative.
270+
271+
(ii) The lower bound batch acquisition function might not be monotone in the
272+
sense that adding more elements to the batch does not necessarily increase the
273+
acquisition value. Specifically, the acquisition value can become smaller when
274+
more inputs are added.
267275
"""
268276

269277
def __init__(

botorch/acquisition/multi_objective/max_value_entropy_search.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,14 @@ class qLowerBoundMultiObjectiveMaxValueEntropySearch(
200200
at a candidate point `X` and the Pareto optimal outputs.
201201
202202
See [Tu2022]_ for a discussion on the estimation procedure.
203+
204+
NOTES:
205+
(i) The estimated acquisition value could be negative.
206+
207+
(ii) The lower bound batch acquisition function might not be monotone in the
208+
sense that adding more elements to the batch does not necessarily increase the
209+
acquisition value. Specifically, the acquisition value can become smaller when
210+
more inputs are added.
203211
"""
204212

205213
def __init__(

botorch/acquisition/multi_objective/predictive_entropy_search.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ class qMultiObjectivePredictiveEntropySearch(AcquisitionFunction):
9393
iterations are required. Running too many EP iterations could lead to
9494
invertibility problems such as in problem (b). Setting a larger threshold
9595
or reducing the number of EP iterations could alleviate this.
96+
97+
(iii) The estimated acquisition value could be negative.
9698
"""
9799

98100
def __init__(

botorch/acquisition/predictive_entropy_search.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ class qPredictiveEntropySearch(qMultiObjectivePredictiveEntropySearch):
3131
This acquisition function approximates the mutual information between the
3232
observation at a candidate point `X` and the optimal set of inputs using
3333
expectation propagation (EP).
34+
35+
NOTES:
36+
(i) The expectation propagation procedure can potentially fail due to the unstable
37+
EP updates. This is however unlikely to happen in the single-objective setting
38+
because we have much fewer EP factors. The jitter added in the training phase
39+
(`ep_jitter`) and testing phase (`test_jitter`) can be increased to prevent
40+
these failures from happening. More details in the description of
41+
`qMultiObjectivePredictiveEntropySearch`.
42+
43+
(ii) The estimated acquisition value could be negative.
3444
"""
3545

3646
def __init__(
@@ -47,14 +57,6 @@ def __init__(
4757
) -> None:
4858
r"""Predictive entropy search acquisition function.
4959
50-
NOTE:
51-
The expectation propagation procedure can potentially fail due to the unstable
52-
EP updates. This is however unlikely to happen in the single-objective setting
53-
because we have much fewer EP factors. The jitter added in the training phase
54-
(`ep_jitter`) and testing phase (`test_jitter`) can be increased to prevent
55-
these failures from happening. More details in the description of
56-
`qMultiObjectivePredictiveEntropySearch`.
57-
5860
Args:
5961
model: A fitted single-outcome model.
6062
optimal_inputs: A `num_samples x d`-dim tensor containing the sampled

0 commit comments

Comments
 (0)