Constraint¶
- class baybe.constraints.base.Constraint[source]¶
Bases:
ABC
,SerialMixin
Abstract base class for all constraints.
Public methods
__init__
(parameters)Method generated by attrs for class Constraint.
from_dict
(dictionary)Create an object from its dictionary representation.
from_json
(source, /)Create an object from its JSON representation.
summary
()Return a custom summarization of the constraint.
to_dict
()Create an object's dictionary representation.
to_json
([sink, overwrite])Create an object's JSON representation.
Public attributes and properties
The list of parameters used for the constraint.
Class variable encoding whether the constraint could be considered during data augmentation.
Boolean indicating if this is a constraint over continuous parameters.
Boolean indicating if this is a constraint over discrete parameters.
Class variable encoding whether the constraint is valid only for numerical parameters.
Class variable encoding whether the condition is evaluated during creation.
Class variable encoding whether the condition is evaluated during modeling.
- __init__(parameters: list[str])¶
Method generated by attrs for class Constraint.
For details on the parameters, see Public attributes and properties.
- classmethod from_json(source: str | Path | SupportsRead[str], /)¶
Create an object from its JSON representation.
- Parameters:
source (str | Path | SupportsRead[str]) –
The JSON source. Can be:
A string containing JSON content.
A file path or
Path
object pointing to a JSON file.A file-like object with a
read()
method.
- Raises:
ValueError – If
source
is not one of the allowed types.- Return type:
_T
- Returns:
The reconstructed object.
- to_dict()¶
Create an object’s dictionary representation.
- Return type:
- Returns:
The dictionary representation of the object.
- to_json(sink: str | Path | SupportsWrite[str] | None = None, /, *, overwrite: bool = False, **kwargs: Any)¶
Create an object’s JSON representation.
- Parameters:
sink (str | Path | SupportsWrite[str] | None) –
The JSON sink. Can be:
None
(only returns the JSON string).A file path or
Path
object pointing to a location where to write the JSON content.A file-like object with a
write()
method.
overwrite (bool) – Boolean flag indicating if to overwrite the file if it already exists. Only relevant if
sink
is a file path orPath
object.**kwargs (Any) – Additional keyword arguments to pass to
json.dumps()
.
- Raises:
FileExistsError – If
sink
points to an already existing file butoverwrite
isFalse
.- 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
]¶ Class variable encoding whether the condition is evaluated during creation.
-
eval_during_modeling:
ClassVar
[bool
]¶ Class variable encoding whether the condition is evaluated during modeling.
- property is_continuous: bool¶
Boolean indicating if this is a constraint over continuous parameters.