optuna.distributions.DiscreteUniformDistribution

class optuna.distributions.DiscreteUniformDistribution(low, high, q)[源代码]

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

此对象由 suggest_float() 使用 step 参数实例化,通常传递给 samplers

注意

如果范围 \([\mathsf{low}, \mathsf{high}]\) 不能被 \(q\) 整除,则 \(\mathsf{high}\) 将被替换为 \(k q + \mathsf{low} < \mathsf{high}\) 的最大值,其中 \(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