ray.tune.schedulers.TrialScheduler.set_search_properties#

TrialScheduler.set_search_properties(metric: str | None, mode: str | None, **spec) → bool[source]#

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 – Metric to optimize

  • mode – One of [“min”, “max”]. Direction to optimize.

  • **spec – Any kwargs for forward compatiblity. Info like Experiment.PUBLIC_KEYS is provided through here.