ray.tune.search.basic_variant.BasicVariantGenerator.set_search_properties

BasicVariantGenerator.set_search_properties(metric: str | None, mode: str | None, config: Dict, **spec) → bool

Pass search properties to search algorithm.

This method acts as an alternative to instantiating search algorithms with their own specific search spaces. Instead they can accept a Tune config through this method.

The search algorithm will usually pass this method to their Searcher instance.

Parameters:

• metric – Metric to optimize

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

• config – Tune config dict.

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