BinaryTarget

class baybe.targets.binary.BinaryTarget

Bases: Target, SerialMixin

Class for binary targets.

Public methods

__init__(name, *[, metadata, success_value, ...])	Method generated by attrs for class BinaryTarget.
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

success_value	Experimental representation of the success value.
failure_value	Experimental representation of the failure value.
description	The description of the target.
metadata	Optional metadata containing description, unit, and other information.
name	The name of the target.
unit	The unit of measurement for the target.

__init__(name: str, *, metadata=NOTHING, success_value: bool | int | float | str = True, failure_value: bool | int | float | str = False)

Method generated by attrs for class BinaryTarget.

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()

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)

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.

property description: str | None

The description of the target.

failure_value: bool | int | float | str

Experimental representation of the failure value.

metadata: MeasurableMetadata

Optional metadata containing description, unit, and other information.

name: str

The name of the target.

success_value: bool | int | float | str

Experimental representation of the success value.

property unit: str | None

The unit of measurement for the target.