Symmetry

class baybe.symmetries.base.Symmetry

Bases: SerialMixin, ABC

Abstract base class for symmetries.

A Symmetry is a concept that can be used to configure the modeling process in the presence of invariances.

Public methods

__init__()	Method generated by attrs for class Symmetry.
augment_measurements(measurements, searchspace)	Augment the given measurements according to the symmetry.
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 symmetry.
to_dict()	Create an object's dictionary representation.
to_json([sink, overwrite])	Create an object's JSON representation.
validate_searchspace_context(searchspace)	Validate that the symmetry is compatible with the given searchspace.

Public attributes and properties

parameter_names

The names of the parameters affected by the symmetry.

__init__()

Method generated by attrs for class Symmetry.

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

augment_measurements(measurements: pd.DataFrame, searchspace: SearchSpace)

Augment the given measurements according to the symmetry.

Parameters:

• measurements (pd.DataFrame) – The dataframe containing the measurements to be augmented.

• searchspace (SearchSpace) – The searchspace providing parameter context for augmentation.

Return type:

pd.DataFrame

Returns:

The augmented dataframe including the original measurements.

classmethod from_dict(dictionary: dict)

Create an object from its dictionary representation.

Parameters:

dictionary (dict) – The dictionary representation.

Return type:

TypeVar(_T, bound= SerialMixin)

Returns:

The reconstructed object.

classmethod from_json(source: str | Path | SupportsRead[str], /)

Create an object from its JSON representation.

Parameters:

source (Union[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:

TypeVar(_T, bound= SerialMixin)

Returns:

The reconstructed object.

summary()

Return a custom summarization of the symmetry.

Return type:

dict

to_dict()

Create an object’s dictionary representation.

Return type:

dict

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 (Union[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 or Path object.

• **kwargs (Any) – Additional keyword arguments to pass to json.dumps().

Raises:

FileExistsError – If sink points to an already existing file but overwrite is False.

Return type:

str

Returns:

The JSON representation as a string.

validate_searchspace_context(searchspace: SearchSpace)

Validate that the symmetry is compatible with the given searchspace.

Parameters:

searchspace (SearchSpace) – The searchspace to validate against.

Raises:

IncompatibleSearchSpaceError – If the symmetry affects parameters not present in the searchspace.

Return type:

None

abstract property parameter_names: tuple[str, ...]

The names of the parameters affected by the symmetry.