[WIP] DOC Document default values for bayes.py #14518
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
|
@qdeffense I might advise waiting a resolution regarding the standard that we would like to follow regarding the docstring formatting. We might not review this PR before having made a choice in #12356. You will need to be patient then :) |
|
Sorry to give confusing signals, I think I prefer the previous version but I think I have to take it up with the approvers of #12356 |
|
@amueller should I keep |
|
"of shape" is apparently the way to go now. |
|
please merge with master to fix the CI |
NicolasHug
approved these changes
Aug 13, 2019
sklearn/linear_model/bayes.py
Outdated
|
|
||
| threshold_lambda : float, optional | ||
| threshold_lambda : float, default=1.e+4 |
There was a problem hiding this comment.
Suggested change
| threshold_lambda : float, default=1.e+4 | |
| threshold_lambda : float, default=10000 |
Or 10,000 or 10 000, whichever you like the most
sklearn/linear_model/bayes.py
Outdated
|
|
||
| tol : float, optional | ||
| Stop the algorithm if w has converged. Default is 1.e-3. | ||
| tol : float, default=1.e-3 |
There was a problem hiding this comment.
No need for a dot: 1e-3 is enough. Same everywhere else
sklearn/linear_model/bayes.py
Outdated
| This parameter is ignored when ``fit_intercept`` is set to False. | ||
| If True, the regressors X will be normalized before regression by | ||
| subtracting the mean and dividing by the l2-norm. | ||
| If you wish to standardize, please use | ||
| :class:`sklearn.preprocessing.StandardScaler` before calling ``fit`` | ||
| on an estimator with ``normalize=False``. | ||
|
|
||
| copy_X : boolean, optional, default True. | ||
| copy_X : bool, default=True. |
There was a problem hiding this comment.
Suggested change
| copy_X : bool, default=True. | |
| copy_X : bool, default=True |
|
thanks! |
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
Partially addresses #14452 and #14404
What does this implement/fix? Explain your changes.
Document default values of bayes.py and standardize parameters and attributes