Skip to content

Commit

Permalink
Add docstring on constraints
Browse files Browse the repository at this point in the history
  • Loading branch information
theo-brown committed Jan 23, 2024
1 parent 70a19f9 commit 34a7b44
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion jetto_mobo/acquisition.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ def generate_trial_candidates(
acquisition_function : AcquisitionFunction
Acquisition function to use for generating trial candidates. We recommend using either ``jetto_mobo.acquisition.qNoisyExpectedImprovement`` for single-objective optimisation and ``jetto_mobo.acquisition.qNoisyExpectedHypervolumeImprovement`` for multi-objective optimisation.
n_constraints : int, optional, default = 0
Number of constraints. If nonzero, the last ``n_constraints`` outputs of the model will be treated as constraints.
Number of constraints. If nonzero, the last ``n_constraints`` outputs of the model will be treated as constraints. Constraint functions are of the form ``g(x) <= 0`` (i.e. negative if the constraint is satisfied).
device : Union[str, torch.device, None], default = None
Torch device to use for optimising the acquisition function. If None, optimisation will be performed using the device the model is on.
dtype : Optional[torch.dtype], default = None
Expand Down

0 comments on commit 34a7b44

Please sign in to comment.