doc: Standarize default documentation for feature_selection #17465
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
|
Thanks for the PR! Make sure you check the linting failure: |
- Change `default` documentation of parameters to follow `default=<value>` template
c6cd65b to
3af9b04
Compare
NicolasHug
reviewed
Jun 6, 2020
There was a problem hiding this comment.
Thanks @kohakukun , mostly looks good
I made a few comments, some of them are also relevant for other parts in the PR so make sure to check them all ;)
| @@ -73,7 +73,7 @@ class SelectFromModel(MetaEstimatorMixin, SelectorMixin, BaseEstimator): | |||
| or a non-fitted estimator. The estimator must have either a | |||
| ``feature_importances_`` or ``coef_`` attribute after fitting. | |||
|
|
|||
| threshold : string, float, optional default None | |||
| threshold : string, float, default=None | |||
There was a problem hiding this comment.
Suggested change
| threshold : string, float, default=None | |
| threshold : string or float, default=None |
sklearn/feature_selection/_base.py
Outdated
| @@ -32,7 +32,7 @@ def get_support(self, indices=False): | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| indices : boolean (default False) | |||
| indices : boolean, default=False | |||
There was a problem hiding this comment.
Suggested change
| indices : boolean, default=False | |
| indices : bool, default=False |
| @@ -198,7 +198,7 @@ def fit(self, X, y=None, **fit_params): | |||
| X : array-like of shape (n_samples, n_features) | |||
| The training input samples. | |||
|
|
|||
| y : array-like, shape (n_samples,) | |||
| y : array-like, shape (n_samples,), default=None | |||
There was a problem hiding this comment.
Suggested change
| y : array-like, shape (n_samples,), default=None | |
| y : array-like of shape (n_samples,), default=None |
| @@ -586,11 +589,13 @@ class SelectFpr(_BaseFilter): | |||
| mutual_info_classif: | |||
| f_regression: F-value between label/feature for regression tasks. | |||
| mutual_info_regression: Mutual information between features and the target. | |||
| SelectPercentile: Select features based on percentile of the highest scores. | |||
| SelectPercentile: Select features based on percentile of the highest | |||
| scores. | |||
There was a problem hiding this comment.
I think you'll need to indend these to the right a little bit
viclafargue
pushed a commit
to viclafargue/scikit-learn
that referenced
this pull request
Jun 26, 2020
…arn#17465) * doc: Standarize default documentation for feature_selection - Change `default` documentation of parameters to follow `default=<value>` template * remove space at end-of-line * fix linting issues * address comments * missing file
jayzed82
pushed a commit
to jayzed82/scikit-learn
that referenced
this pull request
Oct 22, 2020
…arn#17465) * doc: Standarize default documentation for feature_selection - Change `default` documentation of parameters to follow `default=<value>` template * remove space at end-of-line * fix linting issues * address comments * missing file
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 small section of #15761
What does this implement/fix? Explain your changes.
defaultdocumentation of parameters to followdefault=<value>template
Any other comments?
#DataUmbrella