Target¶

class baybe.targets.base.Target[source]¶

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`(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, /)	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.

classmethod from_json(string: str)¶

Create an object from its JSON representation.

abstract summary()[source]¶

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()[source]¶

Create a single-task objective from the target.

abstract transform(series: Series, /)[source]¶

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.

metadata: MeasurableMetadata¶: Optional metadata containing description, unit, and other information.