check_scalar

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

驗證純量參數的類型和值。

參數:

x物件

要驗證的純量參數。

namestr

要在錯誤訊息中印出的參數名稱。

target_typetype 或 tuple

參數可接受的資料類型。

min_valfloat 或 int，預設值為 None

參數可接受的最小值。如果為 None (預設值)，則表示參數沒有下限。

max_valfloat 或 int，預設值為 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