CompositeSurrogate¶

class baybe.surrogates.composite.CompositeSurrogate[source]¶

Bases: SerialMixin, SurrogateProtocol

A class for composing multi-target surrogates from single-target surrogates.

Public methods

`__init__`(surrogates)	Method generated by attrs for class CompositeSurrogate.
`fit`(searchspace, objective, measurements)	Fit the surrogate to training data in a given modelling context.
`from_dict`(dictionary)	Create an object from its dictionary representation.
`from_json`(source, /)	Create an object from its JSON representation.
`from_replication`(surrogate)	Replicate a given single-target surrogate logic for multiple targets.
`posterior`(candidates)	Compute the posterior for candidates in experimental representation.
`posterior_stats`(candidates[, stats])	See `baybe.surrogates.base.Surrogate.posterior_stats()`.
`to_botorch`()	Create the botorch-ready representation of the fitted model.
`to_dict`()	Create an object's dictionary representation.
`to_json`([sink, overwrite])	Create an object's JSON representation.

Public attributes and properties

surrogates

An index-based mapping from target names to single-target surrogates.

__init__(surrogates: _SurrogateGetter)¶

Method generated by attrs for class CompositeSurrogate.

For details on the parameters, see Public attributes and properties.

fit(searchspace: SearchSpace, objective: Objective, measurements: DataFrame)[source]¶

Fit the surrogate to training data in a given modelling context.

For details on the expected method arguments, see baybe.recommenders.base.RecommenderProtocol().

Return type:: None

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:

Returns:

The reconstructed object.

classmethod from_replication(surrogate: SurrogateProtocol)[source]¶

Replicate a given single-target surrogate logic for multiple targets.

Return type:: CompositeSurrogate

posterior(candidates: pd.DataFrame)[source]¶

Compute the posterior for candidates in experimental representation.

The (independent joint) posterior is represented as a collection of individual posterior models computed per target of the involved objective. For details, see baybe.surrogates.base.Surrogate.posterior().

Return type:: PosteriorList

posterior_stats(candidates: DataFrame, stats: Sequence[float | Literal['mean', 'std', 'var', 'mode']] = ('mean', 'std'))[source]¶

See baybe.surrogates.base.Surrogate.posterior_stats().

Return type:: DataFrame

to_botorch()[source]¶

Create the botorch-ready representation of the fitted model.

The botorch.models.model.Model created by this method needs to be configured such that it can be called with candidate points in computational representation, that is, input of the form as obtained via baybe.searchspace.core.SearchSpace.transform().

Return type:: ModelList

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.

surrogates: _SurrogateGetter¶: An index-based mapping from target names to single-target surrogates.