validate_warmstart#

ray.tune.utils.util.validate_warmstart(parameter_names: List[str], points_to_evaluate: List[List | Dict], evaluated_rewards: List, validate_point_name_lengths: bool = True)[source]#

Generic validation of a Searcher’s warm start functionality. Raises exceptions in case of type and length mismatches between parameters.

If validate_point_name_lengths is False, the equality of lengths between points_to_evaluate and parameter_names will not be validated.

Parameters:

  • parameter_names (List[str]) – The names of the searcher’s parameters.

  • points_to_evaluate (List[List | Dict]) – The initial points to evaluate, each a list or a dict.

  • evaluated_rewards (List) – The rewards already observed for points_to_evaluate, one per point.

  • validate_point_name_lengths (bool) – Whether to check that each point has one value per parameter name.