optuna.distributions.IntUniformDistribution¶
- class optuna.distributions.IntUniformDistribution(low: int, high: int, step: int = 1)[source]¶
A uniform distribution on integers.
This object is instantiated by
suggest_int()
, and passed tosamplers
in general.Note
If the range \([\mathsf{low}, \mathsf{high}]\) is not divisible by \(\mathsf{step}\), \(\mathsf{high}\) will be replaced with the maximum of \(k \times \mathsf{step} + \mathsf{low} \lt \mathsf{high}\), where \(k\) is an integer.
- 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.
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.
- 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.