TwoPhaseMetaRecommender¶

class baybe.recommenders.meta.sequential.TwoPhaseMetaRecommender[source]¶

Bases: MetaRecommender

A two-phased meta recommender that switches at a certain specified point.

The recommender is switched when a new (batch) recommendation is requested and the training data set size (i.e., the total number of collected measurements including those gathered before the meta recommender was active) is equal to or greater than the number specified via the switch_after parameter.

Note

Throughout each phase, the meta recommender reuses the same recommender object, that is, no new instances are created. Therefore, special attention is required when using the meta recommender with stateful recommenders.

Public methods

`__init__`([initial_recommender, recommender, ...])	Method generated by attrs for class TwoPhaseMetaRecommender.
`from_dict`(dictionary)	Create an object from its dictionary representation.
`from_json`(string)	Create an object from its JSON representation.
`get_current_recommender`()	Deprecated! Use `select_recommender()` or `get_non_meta_recommender()` instead.
`get_next_recommender`()	Deprecated! Use `select_recommender()` or `get_non_meta_recommender()` instead.
`get_non_meta_recommender`([batch_size, ...])	Follow the meta recommender chain to the selected non-meta recommender.
`recommend`(batch_size, searchspace[, ...])	See `baybe.recommenders.base.RecommenderProtocol.recommend()`.
`select_recommender`([batch_size, ...])	Select a recommender for the given experimentation context.
`to_dict`()	Create an object's dictionary representation.
`to_json`()	Create an object's JSON representation.

Public attributes and properties

`initial_recommender`	The initial recommender used by the meta recommender.
`recommender`	The recommender used by the meta recommender after the switch.
`switch_after`	The number of experiments required for the recommender to switch.
`remain_switched`	Determines if the recommender should remain switched even if the number of experiments falls below the threshold value in subsequent calls.
`is_stateful`	Boolean indicating if the meta recommender is stateful.

__init__(initial_recommender: RecommenderProtocol = NOTHING, recommender: RecommenderProtocol = NOTHING, switch_after: int = 1, remain_switched: bool = False, _has_switched: bool = False)¶

Method generated by attrs for class TwoPhaseMetaRecommender.

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)
Returns:: The reconstructed object.

classmethod from_json(string: str)¶

Create an object from its JSON representation.

Parameters:: string (str) – The JSON representation of the object.
Return type:: TypeVar(_T)
Returns:: The reconstructed object.

get_current_recommender()¶

Deprecated! Use select_recommender() or get_non_meta_recommender() instead.

Return type:: PureRecommender

get_next_recommender()¶

Deprecated! Use select_recommender() or get_non_meta_recommender() instead.

Return type:: PureRecommender

Follow the meta recommender chain to the selected non-meta recommender.

Recursively calls MetaRecommender.select_recommender() until a non-meta recommender is encountered, which is then returned. Effectively, this extracts the recommender responsible for generating the recommendations for the specified context.

See baybe.recommenders.base.RecommenderProtocol.recommend() for details on the method arguments.

Return type:: RecommenderProtocol

recommend(batch_size: int, searchspace: SearchSpace, objective: Objective | None = None, measurements: DataFrame | None = None, pending_experiments: DataFrame | None = None)¶

See baybe.recommenders.base.RecommenderProtocol.recommend().

Return type:: DataFrame

Select a recommender for the given experimentation context.

See baybe.recommenders.base.RecommenderProtocol.recommend() for details on the method arguments.

Return type:: RecommenderProtocol

to_dict()¶

Create an object’s dictionary representation.

Return type:: dict

to_json()¶

Create an object’s JSON representation.

Return type:: str
Returns:: The JSON representation as a string.

initial_recommender: RecommenderProtocol¶: The initial recommender used by the meta recommender.

property is_stateful: bool¶: Boolean indicating if the meta recommender is stateful.

recommender: RecommenderProtocol¶: The recommender used by the meta recommender after the switch.

remain_switched: bool¶: Determines if the recommender should remain switched even if the number of experiments falls below the threshold value in subsequent calls.

switch_after: int¶: The number of experiments required for the recommender to switch.