ray.tune.search.create_searcher#

ray.tune.search.create_searcher(search_alg, **kwargs)[source]#

Instantiate a search algorithm based on the given string.

This is useful for swapping between different search algorithms.

Parameters:

  • search_alg – The search algorithm to use.

  • metric – The training result objective value attribute. Stopping procedures will use this attribute.

  • mode – One of {min, max}. Determines whether objective is minimizing or maximizing the metric attribute.

  • **kwargs – Additional parameters. These keyword arguments will be passed to the initialization function of the chosen class.

Returns:

The search algorithm.

Return type:

ray.tune.search.Searcher

Example

>>> from ray import tune 
>>> search_alg = tune.create_searcher('ax')

PublicAPI (beta): This API is in beta and may change before becoming stable.