RecommenderProtocol

class baybe.recommenders.base.RecommenderProtocol

Bases: Protocol

Type protocol specifying the interface recommenders need to implement.

Public methods

__init__(*args, **kwargs)
recommend(searchspace, batch_size, train_x, ...)	Recommend a batch of points from the given search space.

__init__(*args, **kwargs)

recommend(searchspace: SearchSpace, batch_size: int, train_x: DataFrame | None, train_y: DataFrame | None)

Recommend a batch of points from the given search space.

Parameters:

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

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

• train_x (Optional[DataFrame]) – Optional training inputs for training a model.

• train_y (Optional[DataFrame]) – Optional training labels for training a model.

Return type:

DataFrame

Returns:

A dataframe containing the recommendations as individual rows.