ContinuousConstraint¶
- class baybe.constraints.base.ContinuousConstraint[source]¶
Bases:
Constraint
,ABC
Abstract base class for continuous constraints.
Continuous constraints use parameter lists and coefficients to define in-/equality constraints over a continuous parameter space.
Public methods
__init__
(parameters[, coefficients, rhs])Method generated by attrs for class ContinuousConstraint.
from_dict
(dictionary)Create an object from its dictionary representation.
from_json
(string)Create an object from its JSON representation.
summary
()Return a custom summarization of the constraint.
to_botorch
(parameters[, idx_offset])Cast the constraint in a format required by botorch.
to_dict
()Create an object's dictionary representation.
to_json
()Create an object's JSON representation.
Public attributes and properties
In-/equality coefficient for each entry in
parameters
.Right-hand side value of the in-/equality.
Class variable encoding whether the condition is evaluated during creation.
Class variable encoding whether the condition is evaluated during modeling.
Boolean indicating if this is a constraint over continuous parameters.
Boolean indicating if this is a constraint over discrete parameters.
The list of parameters used for the constraint.
- __init__(parameters: list[str], coefficients: list[float] = NOTHING, rhs: float = 0.0)¶
Method generated by attrs for class ContinuousConstraint.
For details on the parameters, see Public attributes and properties.
- to_botorch(parameters: list[NumericalContinuousParameter], idx_offset: int = 0)[source]¶
Cast the constraint in a format required by botorch.
Used in calling
optimize_acqf_*
functions, for details see https://botorch.org/api/optim.html#botorch.optim.optimize.optimize_acqf- Parameters:
parameters (list[NumericalContinuousParameter]) – The parameter objects of the continuous space.
idx_offset (int) – Offset to the provided parameter indices.
- Return type:
tuple[Tensor, Tensor, float]
- Returns:
The tuple required by botorch.
- to_json()¶
Create an object’s JSON representation.
- Return type:
- Returns:
The JSON representation as a string.
-
eval_during_creation:
ClassVar
[bool
] = False¶ Class variable encoding whether the condition is evaluated during creation.
-
eval_during_modeling:
ClassVar
[bool
] = True¶ Class variable encoding whether the condition is evaluated during modeling.