check_scalar#

sklearn.utils.check_scalar(x, имя, target_type, *, min_val=None, max_val=None, include_boundaries='both')[источник]#

Проверка типа и значения скалярных параметров.

Параметры:
xobject

Скалярный параметр для проверки.

имяstr

Имя параметра для вывода в сообщениях об ошибках.

target_typeтип или кортеж

Допустимые типы данных для параметра.

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
На этой странице