Target

class baybe.targets.base.Target

Bases: ABC, SerialMixin

Abstract base class for all target variables.

Stores information about the range, transformations, etc.

Public methods

__init__(name, *[, metadata])	Method generated by attrs for class Target.
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 target.
to_dict()	Create an object's dictionary representation.
to_json([sink, overwrite])	Create an object's JSON representation.
to_objective()	Create a single-task objective from the target.
transform(series, /)	Transform target measurements to computational representation.

Public attributes and properties

name	The name of the target.
metadata	Optional metadata containing description, unit, and other information.
description	The description of the target.
unit	The unit of measurement for the target.

__init__(name: str, *, metadata=NOTHING)

Method generated by attrs for class Target.

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, bound= SerialMixin)

Returns:

The reconstructed object.

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.

abstract summary()

Return a custom summarization of the target.

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

to_objective()

Create a single-task objective from the target.

Return type:

SingleTargetObjective

abstract transform(series: Series, /)

Transform target measurements to computational representation.

Parameters:

series (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.

metadata: MeasurableMetadata

Optional metadata containing description, unit, and other information.

name: str

The name of the target.

property unit: str | None

The unit of measurement for the target.