Skip to content

DOC Cross-link check_estimator and parametrize_with_checks #21269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2021
Merged

DOC Cross-link check_estimator and parametrize_with_checks #21269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions sklearn/utils/estimator_checks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,10 @@ def parametrize_with_checks(estimators):
-------
decorator : `pytest.mark.parametrize`

See Also
--------
check_estimator : Check if estimator adheres to scikit-learn conventions.

Examples
--------
>>> from sklearn.utils.estimator_checks import parametrize_with_checks
Expand Down Expand Up @@ -547,6 +551,11 @@ def check_estimator(Estimator, generate_only=False):
checks_generator : generator
Generator that yields (estimator, check) tuples. Returned when
`generate_only=True`.

See Also
--------
parametrize_with_checks : Pytest specific decorator for parametrizing estimator
checks.
"""
if isinstance(Estimator, type):
msg = (
Expand Down