ContinuousCardinalityConstraint

class baybe.constraints.continuous.ContinuousCardinalityConstraint

Bases: CardinalityConstraint, ContinuousNonlinearConstraint

Class for continuous cardinality constraints.

Public methods

__init__(parameters[, min_cardinality, ...])	Method generated by attrs for class ContinuousCardinalityConstraint.
from_dict(dictionary)	Create an object from its dictionary representation.
from_json(string)	Create an object from its JSON representation.
get_absolute_thresholds(bounds, /)	Get the absolute thresholds for a given interval.
inactive_parameter_combinations()	Get an iterator over all possible combinations of inactive parameters.
sample_inactive_parameters([batch_size])	Sample sets of inactive parameters according to the cardinality constraints.
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

relative_threshold	A relative threshold for determining if a value is considered zero.
eval_during_augmentation	Class variable encoding whether the constraint could be considered during data augmentation.
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.
max_cardinality	The maximum allowed cardinality.
min_cardinality	The minimum required cardinality.
n_inactive_parameter_combinations	The number of possible inactive parameter combinations.
numerical_only	Class variable encoding whether the constraint is valid only for numerical parameters.
parameters	The list of parameters used for the constraint.

__init__(parameters: list[str], min_cardinality: int = 0, max_cardinality: int = NOTHING, relative_threshold=0.001)

Method generated by attrs for class ContinuousCardinalityConstraint.

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

classmethod from_dict(dictionary: dict)

Create an object from its dictionary representation.

Parameters:

dictionary (dict) – The dictionary representation.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

classmethod from_json(string: str)

Create an object from its JSON representation.

Parameters:

string (str) – The JSON representation of the object.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

get_absolute_thresholds(bounds: Interval, /)

Get the absolute thresholds for a given interval.

Turns the relative threshold of the constraint into absolute thresholds for the considered interval. That is, for a given interval (a, b) with a <= 0 and b >= 0, the method returns the interval (r*a, r*b), where r is the relative threshold defined by the constraint.

Parameters:

bounds (Interval) – The specified interval.

Return type:

Interval

Returns:

The absolute thresholds represented as an interval.

Raises:

ValueError – When the specified interval does not contain zero.

inactive_parameter_combinations()

Get an iterator over all possible combinations of inactive parameters.

Return type:

Iterator[frozenset[str]]

sample_inactive_parameters(batch_size: int = 1)

Sample sets of inactive parameters according to the cardinality constraints.

Parameters:

batch_size (int) – The number of parameter sets to be sampled.

Return type:

list[set[str]]

Returns:

A list of sampled inactive parameter sets, where each set holds the corresponding parameter names.

summary()

Return a custom summarization of the constraint.

Return type:

dict

to_dict()

Create an object’s dictionary representation.

Return type:

dict

to_json()

Create an object’s JSON representation.

Return type:

str

Returns:

The JSON representation as a string.

eval_during_augmentation: ClassVar[bool] = False

Class variable encoding whether the constraint could be considered during data augmentation.

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.

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.

max_cardinality: int

The maximum allowed cardinality.

min_cardinality: int

The minimum required cardinality.

property n_inactive_parameter_combinations: int

The number of possible inactive parameter combinations.

numerical_only: ClassVar[bool] = True

Class variable encoding whether the constraint is valid only for numerical parameters.

parameters: list[str]

The list of parameters used for the constraint.

relative_threshold: float

A relative threshold for determining if a value is considered zero.

The threshold is translated into an asymmetric open interval around zero via get_absolute_thresholds().

Note: The interval induced by the threshold is considered open because numerical routines that optimize parameter values on the complementary set (i.e. the value range considered “nonzero”) may push the numerical value exactly to the interval boundary, which should therefore also be considered “nonzero”.