sklearn.utils.estimator_checks.check_estimator?

sklearn.utils.estimator_checks.check_estimator(Estimator, generate_only=False)

源碼

檢查估計器是否遵守scikit-learn約定。

該估計器將運行一個廣泛的測試套件用于輸入驗證，輸入形狀等，以確保該估計器符合scikit-learn約定，這些約定在滾動您自己的估計器時詳細說明了。 如果Estimator類從sklearn.base的相應mixin繼承，則將運行針對分類器，回歸器，聚類或轉換器的附加測試。

該測試可以應用于類或實例。 當前，類具有一些與構造有關的附加測試，而通過實例則允許測試多個選項。 但是，自0.23版起不再支持類，在0.24版中將被移除（類檢查仍將在實例上運行）。

設置generate_only = True將返回一個生成器，該生成器生成（估計器，檢查）的元組，在其中可以相互獨立地調用檢查（即check（估計器））。 這樣，所有檢查都可以獨立運行，并報告失敗的檢查。

scikit-learn提供了pytest特定的裝飾器parametrize_with_checks，使測試多個估計器更加容易。

參數 說明
estimator estimator object
估算器進行檢查。 估計器是一個類對象或實例。
從0.23版開始不推薦使用：從0.23版開始不推薦使用傳遞類，因此0.24版不支持該類,而是傳遞一個實例。
generate_only bool, optional (default=False)
果為False，則在調用check_estimator時評估檢查。 為True時，check_estimator返回生成（估計器，檢查）元組的生成器。 通過調用check（estimator）運行檢查。
是0.22版中的新功能。
返回值 說明
checks_generator generator
生成（估計器，檢查）元組的生成器。 當generate_only = True時返回。