DiscreteProductConstraint¶

class baybe.constraints.discrete.DiscreteProductConstraint[source]¶

Class for modelling product constraints.

Public methods

`__init__`(parameters, condition)	Method generated by attrs for class DiscreteProductConstraint.
`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

`condition`	The condition that is used for this constraint.
`eval_during_creation`	Class variable encoding whether the condition is evaluated during creation.
`eval_during_modeling`	Class variable encoding whether the condition is evaluated during modeling.
`is_continuous`	Boolean indicating if this is a constraint over continuous parameters.
`is_discrete`	Boolean indicating if this is a constraint over discrete parameters.
`parameters`	The list of parameters used for the constraint.

__init__(parameters: list[str], condition: ThresholdCondition)¶

Method generated by attrs for class DiscreteProductConstraint.

For details on the parameters, see Public attributes and properties.

classmethod from_dict(dictionary: dict)¶

Create an object from its dictionary representation.

classmethod from_json(string: str)¶

Create an object from its JSON representation.

get_invalid(data: DataFrame)[source]¶

Get the indices of dataframe entries that are invalid under the constraint.

Parameters:: data (DataFrame) – A dataframe where each row represents a particular parameter combination.
Return type:: Index
Returns:: The dataframe indices of rows where the constraint is violated.

summary()¶

Return a custom summarization of the constraint.

to_dict()¶

Create an object’s dictionary representation.

to_json()¶

Create an object’s JSON representation.

condition: ThresholdCondition¶: The condition that is used for 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.

property is_discrete: bool¶: Boolean indicating if this is a constraint over discrete parameters.