check_scalar#

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

验证标量参数的类型和值。

参数:
x对象

要验证的标量参数。

namestr

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

target_type类型或元组

参数可接受的数据类型。

min_val浮点数或整数，默认为None

参数可取的最小有效值。如果为None（默认），则表示参数没有下限。

max_val浮点数或整数，默认为None

参数可取的最大有效值。如果为None（默认），则表示参数没有上限。

include_boundaries{"left", "right", "both", "neither"}，默认为"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
本页内容