[MRG] Improve OneHotEncoder documentation (Fixes #12261) #12314
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eamanu
reviewed
Oct 6, 2018
sklearn/preprocessing/_encoders.py
Outdated
| @@ -145,10 +145,11 @@ class OneHotEncoder(_BaseEncoder): | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| categories : 'auto' or a list of lists/arrays of values. | |||
| categories : 'auto' (default) or a list of lists/arrays of values. | |||
There was a problem hiding this comment.
Reading and following other docstrings, I would write:
categories: 'auto' or a list of list/array of values, default='auto'
There was a problem hiding this comment.
I think we like to have default=auto at the end of the line, unless that makes the line too long.
sklearn/preprocessing/_encoders.py
Outdated
| Categories (unique values) per feature: | ||
|
|
||
| - 'auto' : Determine categories automatically from the training data. | ||
| - 'auto' (default): Determine categories automatically from the |
There was a problem hiding this comment.
I think if you tell above that the 'auto' is default, I don't believe that here is necessary.
daec686 to
035adde
Compare
eamanu
approved these changes
Oct 14, 2018
jnothman
pushed a commit
to jnothman/scikit-learn
that referenced
this pull request
Oct 15, 2018
anuragkapale
pushed a commit
to anuragkapale/scikit-learn
that referenced
this pull request
Oct 23, 2018
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
This reverts commit 516d81b.
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
This reverts commit 516d81b.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Fixes #12261
What does this implement/fix? Explain your changes.
Improve OneHotEncoder documentation by making default setting clear
Any other comments?
NA