optuna.samplers.IntersectionSearchSpace
- class optuna.samplers.IntersectionSearchSpace(include_pruned=False)[source]
A class to calculate the intersection search space of a
Study.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(), aValueErroris raised.- Parameters
include_pruned (bool) – Whether pruned trials should be included in the search space.
Methods
calculate(study[, ordered_dict])Returns the intersection search space of the
Study.- calculate(study, ordered_dict=False)[source]
Returns the intersection search space of the
Study.- Parameters
study (Study) – A study with completed trials. The same study must be passed for one instance of this class through its lifetime.
ordered_dict (bool) – A boolean flag determining the return type. If
False, the returned object will be adict. IfTrue, the returned object will be ancollections.OrderedDictsorted by keys, i.e. parameter names.
- Returns
A dictionary containing the parameter names and parameter’s distributions.
- Return type