Skip to content

DOC add link to sklearn_is_fitted example in check_is_fitted #26926

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 3 commits into from
Sep 29, 2023
Merged

DOC add link to sklearn_is_fitted example in check_is_fitted #26926

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c60de4
DOC add link to sklearn_is_fitted example in check_is_fitted
adrinjalali Jul 28, 2023
5ba0596
Merge branch 'main' into doc/sklearn_is_fitted
ArturoAmorQ Sep 29, 2023
a121198
Update sklearn/utils/validation.py
ArturoAmorQ Sep 29, 2023
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
6 changes: 4 additions & 2 deletions sklearn/utils/validation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1410,8 +1410,10 @@ def check_is_fitted(estimator, attributes=None, *, msg=None, all_or_any=all):
raises a NotFittedError with the given message.

If an estimator does not set any attributes with a trailing underscore, it
can define a ``__sklearn_is_fitted__`` method returning a boolean to specify if the
estimator is fitted or not.
can define a ``__sklearn_is_fitted__`` method returning a boolean to
specify if the estimator is fitted or not. See
:ref:`sphx_glr_auto_examples_developing_estimators_sklearn_is_fitted.py`
for an example on how to use the API.

Parameters
----------
Expand Down