Skip to content

Commit 84e06db

Browse files
Balandatfacebook-github-bot
authored andcommitted
Point to example for constraints def in optimize_acqf docstring
Summary: In response to #1899 Differential Revision: D46900427 fbshipit-source-id: 5c903e9aa876095554ecc5167bdcd89ba9d082fb
1 parent e5bf538 commit 84e06db

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

botorch/optim/optimize.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,8 @@ def optimize_acqf(
446446
inequality_constraints: A list of tuples (indices, coefficients, rhs),
447447
with each tuple encoding an inequality constraint of the form
448448
`\sum_i (X[indices[i]] * coefficients[i]) >= rhs`. `indices` and
449-
`coefficients` should be torch tensors. When q=1, or when
449+
`coefficients` should be torch tensors. See the docstring of
450+
`make_scipy_linear_constraints` for an example. When q=1, or when
450451
applying the same constraint to each candidate in the batch,
451452
`indices` should be a 1-d tensor. For inter-point constraints,
452453
`indices` must be a 2-d Tensor, where in each row `indices[i] =
@@ -455,7 +456,8 @@ def optimize_acqf(
455456
the `l_i`-th feature of that element.
456457
equality_constraints: A list of tuples (indices, coefficients, rhs),
457458
with each tuple encoding an equality constraint of the form
458-
`\sum_i (X[indices[i]] * coefficients[i]) = rhs`
459+
`\sum_i (X[indices[i]] * coefficients[i]) = rhs`. See the docstring of
460+
`make_scipy_linear_constraints` for an example.
459461
nonlinear_inequality_constraints: A list of callables with that represent
460462
non-linear inequality constraints of the form `callable(x) >= 0`. Each
461463
callable is expected to take a `(num_restarts) x q x d`-dim tensor as an

0 commit comments

Comments
 (0)