optuna.distributions.IntDistribution

class optuna.distributions.IntDistribution(low, high, log=False, step=1)[源]

整数上的分布。

此对象由 suggest_int() 实例化,通常传递给 samplers

注意

step 不为 None 时,如果范围 \([\mathsf{low}, \mathsf{high}]\) 不能被 \(\mathsf{step}\) 整除,则 \(\mathsf{high}\) 将被替换为 \(k \times \mathsf{step} + \mathsf{low} < \mathsf{high}\) 的最大值,其中 \(k\) 是一个整数。

参数:
low

分布范围的下限。 low 包含在范围内。 low 必须小于或等于 high。如果 logTrue,则 low 必须大于或等于 1。

high

分布范围的上限。 high 包含在范围内。 high 必须大于或等于 low

log

如果 logTrue,则此分布处于对数尺度。在这种情况下,添加到该分布的所有参数都必须是正值。当参数 step 不为 1 时,此参数必须为 False

step

离散化步长。 step 必须是正整数。当参数 logTrue 时,此参数必须为 1。

方法

single()

测试此分布的范围是否只包含一个值。

to_external_repr(param_value_in_internal_repr)

将参数值的内部表示转换为外部表示。

to_internal_repr(param_value_in_external_repr)

将参数值的外部表示转换为内部表示。

single()[源]

测试此分布的范围是否只包含一个值。

返回:

如果此分布的范围仅包含一个值,则返回 True,否则返回 False

返回类型:

bool

to_external_repr(param_value_in_internal_repr)[源]

将参数值的内部表示转换为外部表示。

参数:

param_value_in_internal_repr (float) – 参数值的 Optuna 内部表示。

返回:

参数值的 Optuna 外部表示。

返回类型:

int

to_internal_repr(param_value_in_external_repr)[源]

将参数值的外部表示转换为内部表示。

参数:

param_value_in_external_repr (int) – 参数值的 Optuna 外部表示。

返回:

参数值的 Optuna 内部表示。

返回类型:

float