We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 780b393 commit aa8b113Copy full SHA for aa8b113
sklearn/utils/estimator_checks.py
@@ -506,6 +506,13 @@ def estimator_checks_generator(
506
):
507
"""Iteratively yield all check callables for an estimator.
508
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
+
516
.. versionadded:: 1.6
517
518
Parameters
0 commit comments