sklearn.utils.estimator_checks
.parametrize_with_checks¶
-
sklearn.utils.estimator_checks.
parametrize_with_checks
(estimators)[source]¶ Pytest specific decorator for parametrizing estimator checks.
The
id
of each check is set to be a pprint version of the estimator and the name of the check with its keyword arguments. This allows to usepytest -k
to specify which tests to run:pytest test_check_estimators.py -k check_estimators_fit_returns_self
- Parameters
- estimatorslist of estimators objects or classes
Estimators to generated checks for.
Deprecated since version 0.23: Passing a class is deprecated from version 0.23, and won’t be supported in 0.24. Pass an instance instead.
- Returns
- decorator
pytest.mark.parametrize
- decorator
Examples
>>> from sklearn.utils.estimator_checks import parametrize_with_checks >>> from sklearn.linear_model import LogisticRegression >>> from sklearn.tree import DecisionTreeRegressor
>>> @parametrize_with_checks([LogisticRegression(), ... DecisionTreeRegressor()]) ... def test_sklearn_compatible_estimator(estimator, check): ... check(estimator)