Skip to content

Commit 0188831

Browse files
jakobzeitlerfacebook-github-bot
authored andcommitted
Replaced space with underscore for proper doc generation (meta-pytorch#1256)
Summary: Seems like spaces in argument names for function documentation remove everything but the last word which lead to confusion reading the docs as both equality and inequality constraints were simply listed as "constraints". <!-- Thank you for sending the PR! We appreciate you spending the time to make BoTorch better. Help us understand your motivation by explaining why you decided to make this change. You can learn more about contributing to BoTorch here: https://github.com/pytorch/botorch/blob/main/CONTRIBUTING.md --> ## Motivation Improve documentation ### Have you read the [Contributing Guidelines on pull requests](https://github.com/pytorch/botorch/blob/main/CONTRIBUTING.md#pull-requests)? (Write your answer here.) Pull Request resolved: meta-pytorch#1256 Test Plan: (Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!) ## Related PRs (If this PR adds or changes functionality, please take some time to update the docs at https://github.com/pytorch/botorch, and link to your PR here.) Reviewed By: saitcakmak Differential Revision: D37082593 Pulled By: Balandat fbshipit-source-id: 5b8d46c866dd572e7f0417b16385074655437f97
1 parent 10c8f60 commit 0188831

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

botorch/optim/optimize.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ def optimize_acqf(
7575
raw_samples: The number of samples for initialization. This is required
7676
if `batch_initial_conditions` is not specified.
7777
options: Options for candidate generation.
78-
inequality constraints: A list of tuples (indices, coefficients, rhs),
78+
inequality_constraints: A list of tuples (indices, coefficients, rhs),
7979
with each tuple encoding an inequality constraint of the form
8080
`\sum_i (X[indices[i]] * coefficients[i]) >= rhs`
81-
equality constraints: A list of tuples (indices, coefficients, rhs),
81+
equality_constraints: A list of tuples (indices, coefficients, rhs),
8282
with each tuple encoding an inequality constraint of the form
8383
`\sum_i (X[indices[i]] * coefficients[i]) = rhs`
8484
nonlinear_inequality_constraints: A list of callables with that represent

0 commit comments

Comments
 (0)