DiscreteSumConstraint¶
- class baybe.constraints.discrete.DiscreteSumConstraint[source]¶
Bases:
DiscreteConstraint
Class for modelling sum constraints.
Public methods
__init__
(parameters, condition)Method generated by attrs for class DiscreteSumConstraint.
from_dict
(dictionary)Create an object from its dictionary representation.
from_json
(string)Create an object from its JSON representation.
get_invalid
(data)Get the indices of dataframe entries that are invalid under the constraint.
summary
()Return a custom summarization of the constraint.
to_dict
()Create an object's dictionary representation.
to_json
()Create an object's JSON representation.
Public attributes and properties
The condition modeled by this constraint.
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], condition: ThresholdCondition)¶
Method generated by attrs for class DiscreteSumConstraint.
For details on the parameters, see Public attributes and properties.
- get_invalid(data: DataFrame)[source]¶
Get the indices of dataframe entries that are invalid under the constraint.
- to_json()¶
Create an object’s JSON representation.
- Return type:
- Returns:
The JSON representation as a string.
-
condition:
ThresholdCondition
¶ The condition modeled by this constraint.
- eval_during_creation: ClassVar[bool] = True¶
Class variable encoding whether the condition is evaluated during creation.
- eval_during_modeling: ClassVar[bool] = False¶
Class variable encoding whether the condition is evaluated during modeling.
- property is_continuous: bool¶
Boolean indicating if this is a constraint over continuous parameters.
- parameters: list[str]¶
The list of parameters used for the constraint.