check_scalar

sklearn.utils.check_scalar(x, name, target_type, *, min_val=None, max_val=None, include_boundaries='both')

指定纯量参数类型和值。

参数:

x对象

The scalar parameter to validate.

namestr

要在错误消息中打印的参数的名称。

target_type类型或多元组

参数可接受的数据类型。

min_valfloat或int，默认=无

参数可以采用的最小有效值。如果无（默认），则意味着参数没有下限。

max_valfloat或int，默认=无

参数可以采用的最大有效值。如果为“无”（默认值），则表示参数没有上限。

include_boundaries{“left”，“right”，“both”，“noth”}，默认=“both”

是否定义的间隔 min_val 和 max_val 应该包括边界。可能的选择是：

• "left" ：只有 min_val 包含在有效间隔中。它相当于 [ min_val, max_val ) .

• "right" ：只有 max_val 包含在有效间隔中。它相当于 ( min_val, max_val ] .

• "both" : min_val 和 max_val 包含在有效间隔中。它相当于 [ min_val, max_val ] .

• "neither" ：都不是 min_val 也不 max_val 包含在有效间隔中。它相当于 ( min_val, max_val ) .

返回:

xnumbers.Number

已验证的编号。

提出:

TypeError

如果参数的类型与所需类型不匹配。

ValueError

如果参数的值违反了给定的界限。如果 min_val , max_val 和 include_boundaries 不一致。

示例

>>> from sklearn.utils.validation import check_scalar
>>> check_scalar(10, "x", int, min_val=1, max_val=20)
10