optuna.distributions.IntUniformDistribution

class optuna.distributions.IntUniformDistribution(low, high, step=1)

A uniform distribution on integers.

This object is instantiated by suggest_int(), and passed to samplers in general.

备注

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} < \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.

引发

ValueError – If low value is larger than high value, or step value is smaller or equal to 0.

参数

• low (int) –

• high (int) –

• step (int) –

返回类型

None

Methods

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()

Test whether the range of this distribution contains just a single value.

返回

True if the range of this distribution contains just a single value, otherwise False.

返回类型

bool

to_external_repr(param_value_in_internal_repr)

Convert internal representation of a parameter value into external representation.

参数

param_value_in_internal_repr (float) – Optuna’s internal representation of a parameter value.

返回

Optuna’s external representation of a parameter value.

返回类型

int

to_internal_repr(param_value_in_external_repr)

Convert external representation of a parameter value into internal representation.

参数

param_value_in_external_repr (int) – Optuna’s external representation of a parameter value.

返回

Optuna’s internal representation of a parameter value.

返回类型

float