set_search_properties#

PopulationBasedTrainingReplay.set_search_properties(metric: str | None, mode: str | None, **spec) → bool#

Pass search properties to scheduler.

This method acts as an alternative to instantiating schedulers that react to metrics with their own metric and mode parameters.

Parameters:

metric (str | None) – Metric to optimize
mode (str | None) – One of [“min”, “max”]. Direction to optimize.
**spec – Any kwargs for forward compatibility. Info like Experiment.PUBLIC_KEYS is provided through here.

Returns:

True if the search properties were set successfully, False otherwise.

Return type: