Samplers

class optuna.samplers.BaseSampler[source]

Base class for samplers.

Optuna combines two types of sampling strategies, which are called relative sampling and independent sampling.

The relative sampling determines values of multiple parameters simultaneously so that sampling algorithms can use relationship between parameters (e.g., correlation). Target parameters of the relative sampling are described in a relative search space, which is determined by infer_relative_search_space().

The independent sampling determines a value of a single parameter without considering any relationship between parameters. Target parameters of the independent sampling are the parameters not described in the relative search space.

infer_relative_search_space(study, trial)[source]

Infer the search space that will be used by relative sampling in the target trial.

This method is called right before sample_relative() method, and the search space returned by this method is pass to it. The parameters not contained in the search space will be sampled by using sample_independent() method.

Parameters:
  • study – Target study object.
  • trial – Target trial object.
Returns:

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

See also

Please refer to intersection_search_space() as an implementation of infer_relative_search_space().

sample_independent(study, trial, param_name, param_distribution)[source]

Sample a parameter for a given distribution.

This method is called only for the parameters not contained in the search space returned by sample_relative() method. This method is suitable for sampling algorithms that do not use relationship between parameters such as random sampling and TPE.

Parameters:
  • study – Target study object.
  • trial – Target trial object.
  • param_name – Name of the sampled parameter.
  • param_distribution – Distribution object that specifies a prior and/or scale of the sampling algorithm.
Returns:

A parameter value.

sample_relative(study, trial, search_space)[source]

Sample parameters in a given search space.

This method is called once at the beginning of each trial, i.e., right before the evaluation of the objective function. This method is suitable for sampling algorithms that use relationship between parameters such as Gaussian Process and CMA-ES.

Parameters:
Returns:

A dictionary containing the parameter names and the values.

class optuna.samplers.RandomSampler(seed=None)[source]

Sampler using random sampling.

Example

>>> study = optuna.create_study(sampler=RandomSampler())
>>> study.optimize(objective, direction='minimize')
Args:
seed: Seed for random number generator.
class optuna.samplers.TPESampler(consider_prior=True, prior_weight=1.0, consider_magic_clip=True, consider_endpoints=False, n_startup_trials=10, n_ei_candidates=24, gamma=<function default_gamma>, weights=<function default_weights>, seed=None)[source]
static hyperopt_parameters()[source]

Return the the default parameters of hyperopt (v0.1.2).

TPESampler can be instantiated with the parameters returned by this method.

Example

Create a TPESampler instance with the default parameters of hyperopt.

import optuna
from optuna.samplers import TPESampler

def objective(trial):
    x = trial.suggest_uniform('x', -10, 10)
    return x**2

sampler = TPESampler(**TPESampler.hyperopt_parameters())
study = optuna.create_study(sampler=sampler)
study.optimize(objective, n_trials=100)
Returns:A dictionary containing the default parameters of hyperopt.
optuna.samplers.intersection_search_space(study)[source]

Return the intersection search space of the 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).

Returns:A dictionary containing the parameter names and parameter’s distributions.
optuna.samplers.product_search_space(study)[source]

Return the product search space of the BaseStudy.

Deprecated since version 0.14.0: Please use intersection_search_space() instead.