8000 DOC Cross-link check_estimator and parametrize_with_checks (#21269) · scikit-learn/scikit-learn@4ddd367 · GitHub
[go: up one dir, main page]

Skip to content

Commit 4ddd367

Browse files
authored
DOC Cross-link check_estimator and parametrize_with_checks (#21269)
1 parent 686ab3e commit 4ddd367

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

sklearn/utils/estimator_checks.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,10 @@ def parametrize_with_checks(estimators):
472472
-------
473473
decorator : `pytest.mark.parametrize`
474474
475+
See Also
476+
--------
477+
check_estimator : Check if estimator adheres to scikit-learn conventions.
478+
475479
Examples
476480
--------
477481
>>> from sklearn.utils.estimator_checks import parametrize_with_checks
@@ -547,6 +551,11 @@ def check_estimator(Estimator, generate_only=False):
547551
checks_generator : generator
548552
Generator that yields (estimator, check) tuples. Returned when
549553
`generate_only=True`.
554+
555+
See Also
556+
--------
557+
parametrize_with_checks : Pytest specific decorator for parametrizing estimator
558+
checks.
550559
"""
551560
if isinstance(Estimator, type):
552561
msg = (

0 commit comments

Comments
 (0)
0