check_estimator#

check_estimator(estimator, raise_exceptions=False, tests_to_run=None, fixtures_to_run=None, verbose=True, tests_to_exclude=None, fixtures_to_exclude=None)[源代码][源代码]#

在一个单一的估计器上运行所有测试。

在估计器上运行的测试：

test_all_estimators 中的所有测试 来自估计器科学类型的模块的所有接口兼容性测试

例如，如果 estimator 是一个 forecaster，则 test_all_forecasters

参数:
估计器估计器类或估计器实例
raise_exceptionsbool, 可选, 默认=False

是否在结果字典中返回异常/失败，或者引发它们

  • 如果为假：返回 results 字典中的异常

  • 如果为真：在异常发生时引发异常

tests_to_runstr 或 str 列表，可选。默认 = 运行所有测试。

要运行的测试的名称（测试/函数名称字符串）。将运行的测试子集限制为这里给出的测试。

fixtures_to_runstr 或 str 列表，可选。默认 = 运行所有测试。

pytest 测试-固定装置组合代码，指定要运行的测试-固定装置组合。将测试和固定装置的子集运行到此处给出的列表中。如果同时提供了 tests_to_run 和 fixtures_to_run，则运行 并集，即，tests_to_run 中所有测试的测试-固定装置组合。

以及 fixtures_to_run 中的所有测试夹具组合。

详细str, 可选, 默认=True.

是否打印出运行测试的详细摘要。

tests_to_excludestr 或 str 列表，要排除的测试名称。默认 = None

在通过 tests_to_run 进行子集化后，移除不应运行的测试。

fixtures_to_excludestr 或 str 列表，要排除的固定装置。默认 = None

移除不应运行的测试夹具组合。这是在通过 fixtures_to_run 进行子集划分之后完成的。

返回:
结果self 中测试结果的字典

键是测试/固定装置字符串，与 pytest 中相同，例如，test[fixture] 条目是字符串 “PASSED” 如果测试通过，或者如果测试未通过则返回引发的异常，仅当所有测试通过时返回，或者 raise_exceptions=False

引发:
如果 raise_exceptions=True,
直接引发测试产生的任何异常

示例

>>> from sktime.transformations.series.exponent import ExponentTransformer
>>> from sktime.utils.estimator_checks import check_estimator

运行 ExponentTransformer 类的所有测试，这使用了 get_test_params 中的所有实例和兼容的场景

>>> results = check_estimator(ExponentTransformer)
All tests PASSED!

运行特定 ExponentTransformer 的所有测试，这使用传递的实例和兼容的场景

>>> results = check_estimator(ExponentTransformer(42))
All tests PASSED!

运行特定测试（所有固定装置）用于 ExponentTransformer

>>> results = check_estimator(ExponentTransformer, tests_to_run="test_clone")
All tests PASSED!

{‘test_clone[ExponentTransformer-0]’: ‘通过’, ‘test_clone[ExponentTransformer-1]’: ‘通过’}

运行 ExponentTransformer 的一个特定测试夹具组合

>>> check_estimator(
...    ExponentTransformer, fixtures_to_run="test_clone[ExponentTransformer-1]"
... )
All tests PASSED!
{'test_clone[ExponentTransformer-1]': 'PASSED'}
On this page