DOC for n_nonzero_coefs_ attribute in OrthogonalMatchingPursuit #18756
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
adrinjalali
approved these changes
Nov 5, 2020
NicolasHug
approved these changes
Nov 5, 2020
sklearn/linear_model/_omp.py
Outdated
Comment on lines
592
to
594
| Desired number of non-zero entries in the solution. If n_nonzero_coefs | ||
| is None and tol is None this value is either set to 10% of n_features | ||
| or one, whichever is greater. |
There was a problem hiding this comment.
Small suggestion: the current phrasing suggests that this is describing a parameter, but this is an attribute.
Suggested change
| Desired number of non-zero entries in the solution. If n_nonzero_coefs | |
| is None and tol is None this value is either set to 10% of n_features | |
| or one, whichever is greater. | |
| The number of non-zero coefficients in the solution. If `n_nonzero_coefs` | |
| is None and `tol` is None this value is either set to 10% of `n_features` | |
| or 1, whichever is greater. |
|
@NicolasHug thank you for your feedback. I implemented your suggested changes. |
|
Thanks @marenwestermann |
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
References #14312
What does this implement/fix? Explain your changes.
Documents the attribute n_nonzero_coefs_ in class OrthogonalMatchingPursuit
Any other comments?