check_is_fitted

sklearn.utils.validation.check_is_fitted(estimator, attributes=None, *, msg=None, all_or_any=<built-in function all>)[source]

Выполняет проверку is_fitted для оценивателя.

Проверяет, обучен ли оцениватель, проверяя наличие обученных атрибутов (оканчивающихся символом подчёркивания); в противном случае вызывает исключение NotFittedError с указанным сообщением.

Если оцениватель не устанавливает атрибуты, оканчивающиеся символом подчёркивания, он может определить метод __sklearn_is_fitted__, возвращающий логическое значение, которое указывает, обучен ли оцениватель. Пример использования API см. в разделе __sklearn_is_fitted__ как API для разработчиков.

Если attributes не переданы, эта функция завершится успешно, если оцениватель не имеет состояния. Оцениватель может указать, что он не имеет состояния, установив тег requires_fit. Дополнительную информацию см. в разделе Теги оценивателя. Обратите внимание, что тег requires_fit игнорируется, если переданы attributes.

Параметры:

estimatorэкземпляр оценивателя

Экземпляр оценивателя, для которого выполняется проверка.

attributesstr, список или кортеж строк, по умолчанию=None

Имя атрибута или имена атрибутов в виде строки либо списка/кортежа строк, например: ["coef_", "estimator_", ...], "coef_"

Если None, estimator считается обученным, если существует атрибут, который оканчивается символом подчёркивания и не начинается с двух символов подчёркивания.

msgstr, по умолчанию=None

Сообщение об ошибке по умолчанию: «Этот экземпляр %(name)s ещё не обучен. Вызовите ‘fit’ с соответствующими аргументами, прежде чем использовать этот оцениватель».

В пользовательских сообщениях, если строка сообщения содержит «%(name)s», этот фрагмент заменяется именем оценивателя.

Например: «Оцениватель %(name)s должен быть обучен перед разреживанием».

all_or_anyвызываемый объект, {all, any}, по умолчанию=all

Указывает, должны ли существовать все или некоторые из заданных атрибутов.

Вызывает исключения:

TypeError

Если оцениватель является классом или не является экземпляром оценивателя.

NotFittedError

Если атрибуты не найдены.

Примеры

>>> from sklearn.linear_model import LogisticRegression
>>> from sklearn.utils.validation import check_is_fitted
>>> from sklearn.exceptions import NotFittedError
>>> lr = LogisticRegression()
>>> try:
...     check_is_fitted(lr)
... except NotFittedError as exc:
...     print(f"Model is not fitted yet.")
Model is not fitted yet.
>>> lr.fit([[1, 2], [1, 3]], [1, 0])
LogisticRegression()
>>> check_is_fitted(lr)

Примеры из галереи

Индуктивная кластеризация

__sklearn_is_fitted__ как API для разработчиков

Разработка оценивателей, совместимых с маршрутизацией метаданных