Skip to content

DOC Ensures that check_is_fitted passes numpydoc validation #24454

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 2 commits into from
Sep 16, 2022
+4 −6
Merged

DOC Ensures that check_is_fitted passes numpydoc validation #24454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bd1274
DOC Ensures that check_is_fitted passes numpydoc validation
yuanx749 Sep 16, 2022
39a9d0f
Merge remote-tracking branch 'upstream/main' into npdoc-1
yuanx749 Sep 16, 2022
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
1 change: 0 additions & 1 deletion sklearn/tests/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@
"sklearn.utils.sparsefuncs.incr_mean_variance_axis",
"sklearn.utils.sparsefuncs.inplace_swap_row_csc",
"sklearn.utils.sparsefuncs.inplace_swap_row_csr",
"sklearn.utils.validation.check_is_fitted",
]
FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)

Expand Down
9 changes: 4 additions & 5 deletions sklearn/utils/validation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1294,7 +1294,7 @@ def check_is_fitted(estimator, attributes=None, *, msg=None, all_or_any=all):
Parameters
----------
estimator : estimator instance
estimator instance for which the check is performed.
Estimator instance for which the check is performed.

attributes : str, list or tuple of str, default=None
Attribute name(s) given as string or a list/tuple of strings
Expand All @@ -1317,12 +1317,11 @@ def check_is_fitted(estimator, attributes=None, *, msg=None, all_or_any=all):
all_or_any : callable, {all, any}, default=all
Specify whether all or any of the given attributes must exist.

Returns
-------
None

Raises
------
TypeError
If the estimator is a class or not an estimator instance

NotFittedError
If the attributes are not found.
"""
Expand Down