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时返回。