optuna.distributions.IntUniformDistribution

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

整数の一様分布。

このオブジェクトは suggest_int() によって生成され、 一般に samplers に渡されます。

Note

範囲 \([\mathsf{low}, \mathsf{high}]\)\(\mathsf{step}\) で割り切れない場合、 \(\mathsf{high}\)\(k \times \mathsf{step} + \mathsf{low} < \mathsf{high}\) の最大値で置き換えられます。ここで \(k\) は整数です。

Parameters:
low

分布の範囲の下限。low は範囲に含まれます。 lowhigh 以下でなければなりません。

high

分布の範囲の上限。high は範囲に含まれます。 highlow 以上でなければなりません。

step

離散化ステップ。step は正の整数でなければなりません。

Warning

v3.0.0 で非推奨となりました。この機能は将来的に削除される予定です。 この機能の削除は現在 v6.0.0 で予定されていますが、このスケジュールは変更される可能性があります。 https://github.com/optuna/optuna/releases/tag/v3.0.0 を参照してください。

IntDistribution を使用してください。

メソッド

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

この分布の範囲が単一の値のみを含むかどうかをテストします。

Returns:

この分布の範囲が単一の値のみを含む場合は True、それ以外の場合は False

Return type:

bool

to_external_repr(param_value_in_internal_repr)

パラメータ値の内部表現を外部表現に変換します。

Parameters:

param_value_in_internal_repr (float) – パラメータ値の Optuna 内部表現。

Returns:

パラメータ値の Optuna 外部表現。

Return type:

int

to_internal_repr(param_value_in_external_repr)

パラメータ値の外部表現を内部表現に変換します。

Parameters:

param_value_in_external_repr (int) – パラメータ値の Optuna 外部表現。

Returns:

パラメータ値の Optuna 内部表現。

Return type:

float