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)

Gibt iterativ alle Check-Aufrufe für einen Schätzer zurück.

Diese Funktion wird von parametrize_with_checks und check_estimator verwendet, um alle Prüfaufrufe für einen Schätzer zu generieren. In den meisten Fällen sollten diese Funktionen stattdessen verwendet werden. Bei der Implementierung eines benutzerdefinierten Äquivalents lesen Sie bitte deren Quellcode, um zu verstehen, wie estimator_checks_generator verwendet werden soll.

Hinzugefügt in Version 1.6.

Parameter:

estimatorEstimator-Objekt

Schätzerinstanz, für die Prüfungen generiert werden sollen.

legacybool, Standard=True

Ob Legacy-Tests eingeschlossen werden sollen. Im Laufe der Zeit werden Tests aus dieser Kategorie entfernt und in ihre spezifische Kategorie verschoben.

expected_failed_checksdict[str, str], Standard=None

Wörterbuch der Form {check_name: Grund} für Prüfungen, von denen erwartet wird, dass sie fehlschlagen.

mark{"xfail", "skip"} oder None, Standard=None

Ob die Prüfungen, von denen erwartet wird, dass sie fehlschlagen, als xfail (pytest.mark.xfail) oder skip markiert werden sollen. Das Markieren eines Tests als "skip" erfolgt durch das Umschließen der Prüfung in einer Funktion, die eine SkipTest-Ausnahme auslöst.

xfail_strictbool, Standard=None

Ob Prüfungen im xfail-Strict-Modus ausgeführt werden sollen. Diese Option wird ignoriert, es sei denn, mark="xfail". Wenn True, führen Prüfungen, von denen erwartet wird, dass sie fehlschlagen, aber tatsächlich erfolgreich sind, zu einem Testfehler. Wenn False, werden unerwartet erfolgreiche Tests als xpass markiert. Wenn None, wird das Standardverhalten von pytest verwendet.

Hinzugefügt in Version 1.8.

Gibt zurück:

estimator_checks_generatorgenerator

Generator, der (estimator, check) Tupel liefert.