__sklearn_is_fitted__作为开发者API#

__sklearn_is_fitted__方法是scikit-learn中用于检查估计器对象是否已拟合的约定。此方法通常在基于scikit-learn的基础类(如BaseEstimator或其子类)构建的自定义估计器类中实现。

开发者应在除fit之外的所有方法的开头使用check_is_fitted。如果需要自定义或加速检查,可以像下面所示实现__sklearn_is_fitted__方法。

在此示例中,自定义估计器展示了__sklearn_is_fitted__方法和check_is_fitted实用程序函数作为开发者API的用法。__sklearn_is_fitted__方法通过验证_is_fitted属性的存在来检查拟合状态。

一个实现简单分类器的自定义估计器示例#

此代码片段定义了一个名为CustomEstimator的自定义估计器类,它扩展了scikit-learn的BaseEstimatorClassifierMixin类,并展示了__sklearn_is_fitted__方法和check_is_fitted实用程序函数的用法。

# 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

相关示例

归纳聚类

归纳聚类

带有自定义核的SVM

带有自定义核的SVM

scikit-learn 1.6 发行亮点

scikit-learn 1.6 发行亮点

元数据路由

元数据路由

由Sphinx-Gallery生成的图库