optuna.samplers.IntersectionSearchSpace

class optuna.samplers.IntersectionSearchSpace[source]

A class to calculate the intersection search space of a BaseStudy.

Intersection search space contains the intersection of parameter distributions that have been suggested in the completed trials of the study so far. If there are multiple parameters that have the same name but different distributions, neither is included in the resulting search space (i.e., the parameters with dynamic value ranges are excluded).

Note that an instance of this class is supposed to be used for only one study. If different studies are passed to calculate(), a ValueError is raised.

Methods

calculate(study[, ordered_dict])

Returns the intersection search space of the BaseStudy.

calculate(study: optuna.study.BaseStudy, ordered_dict: bool = False) → Dict[str, optuna.distributions.BaseDistribution][source]

Returns the intersection search space of the BaseStudy.

Parameters
  • study – A study with completed trials.

  • ordered_dict – A boolean flag determining the return type. If False, the returned object will be a dict. If True, the returned object will be an collections.OrderedDict sorted by keys, i.e. parameter names.

Returns

A dictionary containing the parameter names and parameter’s distributions.