DiscretePermutationInvarianceConstraint¶
- class baybe.constraints.discrete.DiscretePermutationInvarianceConstraint[source]¶
Bases:
DiscreteConstraint
Constraint class for declaring that a set of parameters is permutation invariant.
More precisely, this means that,
(val_from_param1, val_from_param2)
is equivalent to(val_from_param2, val_from_param1)
. Since it does not make sense to have this constraint with duplicated labels, this implementation also internally applies thebaybe.constraints.discrete.DiscreteNoLabelDuplicatesConstraint
.Note: This constraint is evaluated during creation. In the future it might also be evaluated during modeling to make use of the invariance.
Public methods
__init__
(parameters[, dependencies])Method generated by attrs for class DiscretePermutationInvarianceConstraint.
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
Dependencies connected with the invariant parameters.
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], dependencies: DiscreteDependenciesConstraint | None = None)¶
Method generated by attrs for class DiscretePermutationInvarianceConstraint.
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.
-
dependencies:
Optional
[DiscreteDependenciesConstraint
]¶ Dependencies connected with the invariant parameters.
- 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.