estimator_checks_generator

sklearn.utils.estimator_checks.estimator_checks_generator(estimator, *, legacy:bool=True, expected_failed_checks:dict[str,str]|None=None, mark:Literal['xfail','skip',None]=None, xfail_strict:bool|None=None)[исходный код]

Последовательно выдаёт все вызываемые объекты проверок для оценщика.

Эта функция используется функциями parametrize_with_checks и check_estimator для выдачи всех вызываемых объектов проверок для оценщика. В большинстве случаев следует использовать именно эти функции. При реализации пользовательского аналога обратитесь к их исходному коду, чтобы понять, как предполагается использовать estimator_checks_generator.

Добавлено в версии 1.6.

Параметры:

estimatorобъект-оценщик

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

legacybool, по умолчанию=True

Включать ли устаревшие проверки. Со временем проверки этой категории удаляются и переносятся в соответствующие им категории.

expected_failed_checksdict[str, str], по умолчанию=None

Словарь вида {check_name: reason} для проверок, которые должны завершиться неудачей.

mark{“xfail”, “skip”} или None, по умолчанию=None

Следует ли помечать проверки, которые должны завершиться неудачей, как xfail(pytest.mark.xfail) или skip. Пометка теста как “skip” выполняется путём обёртывания проверки в функцию, которая вызывает исключение SkipTest.

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

Запускать ли проверки в строгом режиме xfail. Этот параметр игнорируется, если не задано mark="xfail". Если значение True, проверки, которые должны завершиться неудачей, но фактически проходят, приведут к сбою теста. Если значение False, неожиданно прошедшие тесты будут помечены как xpass. Если значение None, используется поведение pytest по умолчанию.

Добавлено в версии 1.8.

Возвращает:

estimator_checks_generatorгенератор

Генератор, выдающий кортежи (estimator, check).