import decimal
from typing import Any
from typing import Dict
from typing import Optional
from typing import Sequence
import numpy as np
from optuna._experimental import experimental_class
from optuna.distributions import BaseDistribution
from optuna.distributions import CategoricalDistribution
from optuna.distributions import FloatDistribution
from optuna.distributions import IntDistribution
from optuna.samplers import BaseSampler
from optuna.study import Study
from optuna.trial import FrozenTrial
from optuna.trial import TrialState
[docs]@experimental_class("3.1.0")
class BruteForceSampler(BaseSampler):
"""Sampler using brute force.
This sampler performs exhaustive search on the defined search space.
Example:
.. testcode::
import optuna
def objective(trial):
c = trial.suggest_categorical("c", ["float", "int"])
if c == "float":
return trial.suggest_float("x", 1, 3, step=0.5)
elif c == "int":
a = trial.suggest_int("a", 1, 3)
b = trial.suggest_int("b", a, 3)
return a + b
study = optuna.create_study(sampler=optuna.samplers.BruteForceSampler())
study.optimize(objective)
Note:
The defined search space must be finite. Therefore, when using
:class:`~optuna.distributions.FloatDistribution` or
:func:`~optuna.trial.Trial.suggest_float`, ``step=None`` is not allowed.
Note:
This sampler assumes that it suggests all parameters and that the search space is fixed.
For example, the sampler may fail to try the entire search space in the following cases.
* Using with other samplers or :meth:`~optuna.study.Study.enqueue_trial`
* Changing suggestion ranges or adding parameters in the same :class:`~optuna.study.Study`
Args:
seed:
A seed to fix the order of trials as the search order randomly shuffled. Please note
that it is not recommended using this option in distributed optimization settings since
this option cannot ensure the order of trials and may increase the number of duplicate
suggestions during distributed optimization.
"""
def __init__(self, seed: Optional[int] = None) -> None:
self._rng = np.random.RandomState(seed)
[docs] def infer_relative_search_space(
self, study: Study, trial: FrozenTrial
) -> Dict[str, BaseDistribution]:
return {}
[docs] def sample_relative(
self, study: Study, trial: FrozenTrial, search_space: Dict[str, BaseDistribution]
) -> Dict[str, Any]:
return {}
[docs] def sample_independent(
self,
study: Study,
trial: FrozenTrial,
param_name: str,
param_distribution: BaseDistribution,
) -> Any:
candidates = _enumerate_candidates(param_distribution)
assert len(candidates) > 0
self._rng.shuffle(candidates)
for value in candidates[1:]:
params = trial.params.copy()
params[param_name] = value
study.enqueue_trial(params, skip_if_exists=True)
return candidates[0]
[docs] def after_trial(
self,
study: Study,
trial: FrozenTrial,
state: TrialState,
values: Optional[Sequence[float]],
) -> None:
if len(study.get_trials(deepcopy=False, states=(TrialState.WAITING,))) == 0:
study.stop()
def _enumerate_candidates(param_distribution: BaseDistribution) -> Sequence[Any]:
if isinstance(param_distribution, FloatDistribution):
if param_distribution.step is None:
raise ValueError(
"FloatDistribution.step must be given for BruteForceSampler"
" (otherwise, the search space will be infinite)."
)
low = decimal.Decimal(str(param_distribution.low))
high = decimal.Decimal(str(param_distribution.high))
step = decimal.Decimal(str(param_distribution.step))
ret = []
value = low
while value <= high:
ret.append(float(value))
value += step
return ret
elif isinstance(param_distribution, IntDistribution):
return list(
range(param_distribution.low, param_distribution.high + 1, param_distribution.step)
)
elif isinstance(param_distribution, CategoricalDistribution):
return list(param_distribution.choices)
else:
raise ValueError(f"Unknown distribution {param_distribution}.")