Back to Optuna

optuna.distributions

docs/source/reference/distributions.rst

4.8.01.1 KB
Original Source

.. module:: optuna.distributions

optuna.distributions

The :mod:~optuna.distributions module defines various classes representing probability distributions, mainly used to suggest initial hyperparameter values for an optimization trial. Distribution classes inherit from a library-internal :class:~optuna.distributions.BaseDistribution, and is initialized with specific parameters, such as the low and high endpoints for a :class:~optuna.distributions.IntDistribution.

Optuna users should not use distribution classes directly, but instead use utility functions provided by :class:~optuna.trial.Trial such as :meth:~optuna.trial.Trial.suggest_int.

.. autosummary:: :toctree: generated/ :nosignatures:

FloatDistribution IntDistribution CategoricalDistribution distribution_to_json json_to_distribution check_distribution_compatibility

The following classes are deprecated and will be removed in the future.

.. autosummary:: :toctree: generated/ :nosignatures:

UniformDistribution LogUniformDistribution DiscreteUniformDistribution IntUniformDistribution IntLogUniformDistribution