Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Ensures that KNNImputer passes numpydoc validation #21272

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 6 commits into from
Oct 21, 2021
Merged

DOC Ensures that KNNImputer passes numpydoc validation #21272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52477f4
`KNNImputer` removed from `DOCSTRING_IGNORE_LIST` in test_docstrings.py
baam25simo Oct 7, 2021
96cb29d
In `KNNImputer.__init__`: "See Also" section added.
baam25simo Oct 7, 2021
2a85216
In `KNNImputer.fit`: `y` and `return`description parameters added.
baam25simo Oct 7, 2021
4e6d156
Trying to fix linting
baam25simo Oct 7, 2021
a259250
Update _knn.py
baam25simo Oct 7, 2021
c20c517
Merge remote-tracking branch 'origin/main' into pr/baam25simo/21272
glemaitre Oct 21, 2021
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 maint_tools/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

# List of modules ignored when checking for numpydoc validation.
DOCSTRING_IGNORE_LIST = [
"KNNImputer",
"LabelSpreading",
"LocallyLinearEmbedding",
"MultiTaskElasticNetCV",
Expand Down
11 changes: 11 additions & 0 deletions sklearn/impute/_knn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,13 @@ class KNNImputer(_BaseImputer):

.. versionadded:: 1.0

See Also
--------
SimpleImputer : Imputation transformer for completing missing values
with simple strategies.
IterativeImputer : Multivariate imputer that estimates each feature
from all the others.

References
----------
* Olga Troyanskaya, Michael Cantor, Gavin Sherlock, Pat Brown, Trevor
Expand Down Expand Up @@ -179,9 +186,13 @@ def fit(self, X, y=None):
Input data, where `n_samples` is the number of samples and
`n_features` is the number of features.

y : Ignored
Not used, present here for API consistency by convention.

Returns
-------
self : object
The fitted `KNNImputer` class instance.
"""
# Check data integrity and calling arguments
if not is_scalar_nan(self.missing_values):
Expand Down