ChainedTransformation¶
- class baybe.transformations.composite.ChainedTransformation[source]¶
Bases:
Transformation
A chained transformation composing several individual transformations.
Public methods
__init__
(transformations)Method generated by attrs for class ChainedTransformation.
abs
()Take the absolute value of the output of the transformation.
chain
(transformation, /)Chain another transformation with the existing one.
clamp
([min, max])Clamp the output of the transformation.
from_dict
(dictionary)Create an object from its dictionary representation.
from_json
(source, /)Create an object from its JSON representation.
get_codomain
([interval])Get the codomain of a certain interval (assuming transformation continuity).
get_image
([interval])Get the image of a certain interval (assuming transformation continuity).
negate
()Negate the output of the transformation.
Convert to BoTorch objective.
to_dict
()Create an object's dictionary representation.
to_json
([sink, overwrite])Create an object's JSON representation.
Public attributes and properties
The transformations to be composed (the first element gets applied first).
- __init__(transformations: Iterable[Transformation])¶
Method generated by attrs for class ChainedTransformation.
For details on the parameters, see Public attributes and properties.
- abs()¶
Take the absolute value of the output of the transformation.
- Return type:
- chain(transformation: Transformation, /)¶
Chain another transformation with the existing one.
- Return type:
- 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.
- get_codomain(interval: Interval | None = None, /)[source]¶
Get the codomain of a certain interval (assuming transformation continuity).
In accordance with the mathematical definition of a function’s codomain, we define the codomain of a given
Interval
under a certain (assumed continuous)Transformation
to be anInterval
guaranteed to contain all possible outcomes when theTransformation
is applied to all points in the inputInterval
. In cases where the image cannot exactly be computed, it is often still possible to compute a codomain. The codomain always contains the image, but might be larger.- Return type:
- get_image(interval: Interval | None = None, /)[source]¶
Get the image of a certain interval (assuming transformation continuity).
In accordance with the mathematical definition of a function’s image, we define the image of a given
Interval
under a certain (assumed continuous)Transformation
to be the smallestInterval
containing all possible outcomes when theTransformation
is applied to all points in the inputInterval
.- Return type:
- negate()¶
Negate the output of the transformation.
- Return type:
- to_botorch_objective()¶
Convert to BoTorch objective.
- Return type:
MCAcquisitionObjective
- 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.
-
transformations:
tuple
[Transformation
,...
]¶ The transformations to be composed (the first element gets applied first).