BayesianRecommender

class baybe.recommenders.pure.bayesian.base.BayesianRecommender[source]

Bases: PureRecommender, ABC

An abstract class for Bayesian Recommenders.

Public methods

__init__([surrogate_model, ...])

Method generated by attrs for class BayesianRecommender.

recommend(batch_size, searchspace[, ...])

Recommend a batch of points from the given search space.

Public attributes and properties

surrogate_model

The used surrogate model.

acquisition_function

The used acquisition function class.

acquisition_function_cls

Deprecated! Raises an error when used.

allow_recommending_already_measured

Allow to make recommendations that were measured previously.

allow_repeated_recommendations

Allow to make recommendations that were already recommended earlier.

compatibility

Class variable reflecting the search space compatibility.

__init__(surrogate_model: Surrogate = NOTHING, acquisition_function: AcquisitionFunction | str = NOTHING, *, allow_repeated_recommendations: bool = False, allow_recommending_already_measured: bool = True, acquisition_function_cls: str | None = None)

Method generated by attrs for class BayesianRecommender.

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

recommend(batch_size: int, searchspace: SearchSpace, objective: Objective | None = None, measurements: DataFrame | None = None)[source]

Recommend a batch of points from the given search space.

Parameters:
  • batch_size (int) – The number of points to be recommended.

  • searchspace (SearchSpace) – The search space from which to recommend the points.

  • objective (Optional[Objective]) – An optional objective to be optimized.

  • measurements (Optional[DataFrame]) – Optional experimentation data that can be used for model training. The data is to be provided in “experimental representation”: It needs to contain one column for each parameter spanning the search space (column name matching the parameter name) and one column for each target tracked by the objective (column name matching the target name). Each row corresponds to one conducted experiment, where the parameter columns define the experimental setting and the target columns report the measured outcomes.

Return type:

DataFrame

Returns:

A dataframe containing the recommendations in experimental representation as individual rows.

acquisition_function: AcquisitionFunction

The used acquisition function class.

acquisition_function_cls: str | None

Deprecated! Raises an error when used.

allow_recommending_already_measured: bool

Allow to make recommendations that were measured previously. This only has an influence in discrete search spaces.

allow_repeated_recommendations: bool

Allow to make recommendations that were already recommended earlier. This only has an influence in discrete search spaces.

compatibility: ClassVar[SearchSpaceType]

Class variable reflecting the search space compatibility.

surrogate_model: Surrogate

The used surrogate model.