Skip to content

Commit aa8b113

Browse files
adrinjalalivirchan
andauthored
DOC add reference to higher level functions in estimator_checks_generator (scikit-learn#31480)
Co-authored-by: Virgil Chan <virchan.math@gmail.com>
1 parent 780b393 commit aa8b113

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

sklearn/utils/estimator_checks.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,13 @@ def estimator_checks_generator(
506506
):
507507
"""Iteratively yield all check callables for an estimator.
508508
509+
This function is used by
510+
:func:`~sklearn.utils.estimator_checks.parametrize_with_checks` and
511+
:func:`~sklearn.utils.estimator_checks.check_estimator` to yield all check callables
512+
for an estimator. In most cases, these functions should be used instead. When
513+
implementing a custom equivalent, please refer to their source code to
514+
understand how `estimator_checks_generator` is intended to be used.
515+
509516
.. versionadded:: 1.6
510517
511518
Parameters

0 commit comments

Comments
 (0)