__sklearn_is_fitted__ als Entwickler-API#

Die Methode __sklearn_is_fitted__ ist eine Konvention in scikit-learn, die verwendet wird, um zu überprüfen, ob ein Schätzerobjekt angepasst wurde oder nicht. Diese Methode wird typischerweise in benutzerdefinierten Schätzerklassen implementiert, die auf scikit-learns Basisklassen wie BaseEstimator oder deren Unterklassen aufbauen.

Entwickler sollten check_is_fitted zu Beginn aller Methoden außer fit verwenden. Wenn sie die Prüfung anpassen oder beschleunigen müssen, können sie die Methode __sklearn_is_fitted__ wie unten gezeigt implementieren.

In diesem Beispiel zeigt der benutzerdefinierte Schätzer die Verwendung der Methode __sklearn_is_fitted__ und der Hilfsfunktion check_is_fitted als Entwickler-APIs. Die Methode __sklearn_is_fitted__ überprüft den Anpassungsstatus, indem sie die Anwesenheit des Attributs _is_fitted verifiziert.

Ein Beispiel für einen benutzerdefinierten Schätzer, der einen einfachen Klassifikator implementiert#

Dieser Codeausschnitt definiert eine benutzerdefinierte Schätzerklasse namens CustomEstimator, die sowohl von der Klasse BaseEstimator als auch von der Klasse ClassifierMixin aus scikit-learn erbt und die Verwendung der Methode __sklearn_is_fitted__ und der Hilfsfunktion check_is_fitted demonstriert.

# Authors: The scikit-learn developers
# SPDX-License-Identifier: BSD-3-Clause

from sklearn.base import BaseEstimator, ClassifierMixin
from sklearn.utils.validation import check_is_fitted


class CustomEstimator(BaseEstimator, ClassifierMixin):
    def __init__(self, parameter=1):
        self.parameter = parameter

    def fit(self, X, y):
        """
        Fit the estimator to the training data.
        """
        self.classes_ = sorted(set(y))
        # Custom attribute to track if the estimator is fitted
        self._is_fitted = True
        return self

    def predict(self, X):
        """
        Perform Predictions

        If the estimator is not fitted, then raise NotFittedError
        """
        check_is_fitted(self)
        # Perform prediction logic
        predictions = [self.classes_[0]] * len(X)
        return predictions

    def score(self, X, y):
        """
        Calculate Score

        If the estimator is not fitted, then raise NotFittedError
        """
        check_is_fitted(self)
        # Perform scoring logic
        return 0.5

    def __sklearn_is_fitted__(self):
        """
        Check fitted status and return a Boolean value.
        """
        return hasattr(self, "_is_fitted") and self._is_fitted

Verwandte Beispiele

Induktives Clustering

Induktives Clustering

SVM mit benutzerdefiniertem Kernel

SVM mit benutzerdefiniertem Kernel

Metadaten-Routing

Metadaten-Routing

Release Highlights für scikit-learn 1.6

Release Highlights für scikit-learn 1.6

Galerie generiert von Sphinx-Gallery