optuna.distributions.IntLogUniformDistribution¶
- class optuna.distributions.IntLogUniformDistribution(low: int, high: int, step: int = 1)[source]¶
A uniform distribution on integers in the log domain.
This object is instantiated by
suggest_int()
, and passed tosamplers
in general.- low¶
Lower endpoint of the range of the distribution.
low
is included in the range.
- high¶
Upper endpoint of the range of the distribution.
high
is included in the range.
- step¶
A step for spacing between values.
Warning
Deprecated in v2.0.0.
step
argument will be removed in the future. The removal of this feature is currently scheduled for v4.0.0, but this schedule is subject to change.Samplers and other components in Optuna relying on this distribution will ignore this value and assume that
step
is always 1. User-defined samplers may continue to use other values besides 1 during the deprecation.
Methods
__init__
(low, high[, step])single
()Test whether the range of this distribution contains just a single value.
to_external_repr
(param_value_in_internal_repr)Convert internal representation of a parameter value into external representation.
to_internal_repr
(param_value_in_external_repr)Convert external representation of a parameter value into internal representation.
Attributes
- single() bool [source]¶
Test whether the range of this distribution contains just a single value.
When this method returns
True
,samplers
always sample the same value from the distribution.
- to_external_repr(param_value_in_internal_repr: float) int [source]¶
Convert internal representation of a parameter value into external representation.
- Parameters
param_value_in_internal_repr – Optuna’s internal representation of a parameter value.
- Returns
Optuna’s external representation of a parameter value.
- to_internal_repr(param_value_in_external_repr: int) float [source]¶
Convert external representation of a parameter value into internal representation.
- Parameters
param_value_in_external_repr – Optuna’s external representation of a parameter value.
- Returns
Optuna’s internal representation of a parameter value.