NumericalTarget

class baybe.targets.numerical.NumericalTarget[source]

Bases: Target, SerialMixin

Class for numerical targets.

Public methods

__init__(name, mode[, bounds, transformation])

Method generated by attrs for class NumericalTarget.

from_dict(dictionary)

Create an object from its dictionary representation.

from_json(string)

Create an object from its JSON representation.

summary()

Return a custom summarization of the target.

to_dict()

Create an object's dictionary representation.

to_json()

Create an object's JSON representation.

to_objective()

Create a single-task objective from the target.

transform([series, data])

Transform target measurements to computational representation.

Public attributes and properties

mode

The target mode.

bounds

Optional target bounds.

transformation

An optional target transformation.

name

The name of the target.

__init__(name: str, mode, bounds: None | Iterable | Interval = None, transformation=NOTHING)

Method generated by attrs for class NumericalTarget.

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.

summary()[source]

Return a custom summarization of the target.

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.

to_objective()

Create a single-task objective from the target.

Return type:

SingleTargetObjective

transform(series: Series | None = None, /, *, data: DataFrame | None = None)[source]

Transform target measurements to computational representation.

Parameters:

series (Optional[Series]) – The target measurements in experimental representation to be transformed.

Return type:

Series

Returns:

A series containing the transformed measurements. The series name matches that of the input.

bounds: Interval

Optional target bounds.

mode: TargetMode

The target mode.

name: str

The name of the target.

transformation: TargetTransformation | None

An optional target transformation.