optuna.distributions.FloatDistribution

class optuna.distributions.FloatDistribution(low, high, log=False, step=None)[source]

浮動小数点数の分布を表すクラス。

suggest_float() によってインスタンス化され、 samplers モジュールで一般的に使用されます。

Note

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

Parameters:

low (float)
high (float)
log (bool)
step (None | float)

low: 分布の範囲の下限。low は範囲に含まれます。 low は high 以下でなければなりません。log が True の場合、 low は 0 より大きい値である必要があります。

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

log: log が True の場合、この分布は対数スケールで扱われます。この場合、分布にエンキューされるすべてのパラメータは正の値でなければなりません。パラメータ step が None でない場合、このパラメータは False でなければなりません。

step: 離散化のステップサイズ。step は 0 より大きい値でなければなりません。パラメータ log が True の場合、このパラメータは None でなければなりません。

メソッド

`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()[source]

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

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:: Any

to_internal_repr(param_value_in_external_repr)[source]

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

Parameters:: param_value_in_external_repr (float) – パラメータ値の Optuna 外部表現。
Returns:: パラメータ値の Optuna 内部表現。
Return type:: float