optuna.distributions.DiscreteUniformDistribution

class optuna.distributions.DiscreteUniformDistribution(low, high, q)[source]

线性域中的离散均匀分布。

此对象通过带 step 参数的 suggest_float() 实例化,通常传递给 samplers

注意

如果范围 \([\mathsf{low}, \mathsf{high}]\) 不能被 \(q\) 整除,则 \(\mathsf{high}\) 将被替换为所有满足 \(k q + \mathsf{low} < \mathsf{high}\)\(k q + \mathsf{low}\) 的最大值,其中 \(k\) 是整数。

参数:
  • low (float) – 分布范围的下端点。low 包含在范围内。low 必须小于或等于 high

  • high (float) – 分布范围的上端点。high 包含在范围内。high 必须大于或等于 low

  • q (float) – 离散化步长。q 必须大于 0。

low

分布范围的下端点。low 包含在范围内。

high

分布范围的上端点。high 包含在范围内。

警告

自 v3.0.0 版本起已弃用。此特性将在未来移除。目前计划在 v6.0.0 中移除此特性,但此计划可能会更改。请参阅 https://github.com/optuna/optuna/releases/tag/v3.0.0

请改用 FloatDistribution

方法

single()

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

to_external_repr(param_value_in_internal_repr)

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

to_internal_repr(param_value_in_external_repr)

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

属性

q

离散化步长。

property q: float

离散化步长。

DiscreteUniformDistributionFloatDistribution 的子类型。此属性是其 step 属性的代理。

single()

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

返回:

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

返回类型:

bool

to_external_repr(param_value_in_internal_repr)

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

参数:

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

返回:

参数值的 Optuna 外部表示。

返回类型:

Any

to_internal_repr(param_value_in_external_repr)

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

参数:

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

返回:

参数值的 Optuna 内部表示。

返回类型:

float