8000 DOC Minor fixes for parameter documentation in ridge by alexitkes · Pull Request #14453 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Minor fixes for parameter documentation in ridge #14453

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

Jump to bottom
Merged
merged 15 commits into from
Oct 8, 2019
Merged

DOC Minor fixes for parameter documentation in ridge #14453

merged 15 commits into from
Oct 8, 2019

Conversation

alexitkes
Copy link
Contributor

Address #14452

  • Document default values for alpha and tol parameters for Ridge class
  • Document default values for alpha, fit_intercept and tol parameters for RidgeClassifier class
  • Document default values for alphas parameter for RidgeCV class
  • Document default values for alphas and fit_intercept parameters for RidgeClassifierCV class

rth
rth reviewed 8000 Jul 24, 2019
View reviewed changes
Copy link
Member
@rth rth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alexitkes ! A few comments are below,

@alexitkes alexitkes changed the title Minor fixes for parameter documentation in ridge [MRG] Minor fixes for parameter documentation in ridge Jul 24, 2019
@jnothman
Copy link
Member

Should it be using default=?

@alexitkes
Copy link
Contributor Author

@jnothman I can do it if needed, but I see most parameters in Ridge classes are documented in form default None though some are documented as default=True or default: False. The standardization of parameter docstrings seems being discussed #14404 . Is the default= form already surely preferable?

@amueller
Copy link
Member

@alexitkes yes I'm pretty sure it is.

@alexitkes
Copy link
Contributor Author

@amueller @jnothman Ok, done it.

@adrinjalali
Copy link
Member

I'd probably wait and follow whatever is the conclusion in #12356

@alexitkes
Document default values for linear module parameters.
3e55d6e
@alexitkes
Update ridge.py
59496d9 
boolean -> bool
@alexitkes
Update ridge.py
404b7bb 
Remove unnecessary notes about iterable being converted to Numpy array
@alexitkes
Update ridge.py
fbb41b0 
Document the float/array parameters that are set to None by default.
@alexitkes
Update ridge.py
e6a05fa 
Make too long lines shorter.
@alexitkes
Update ridge.py
c098900 
`default None` -> `default=None`
@alexitkes
Update ridge.py
c9cdb91 
Replace `optional, default=...` docstrings with just `default=...`.
@alexitkes
Update ridge.py
fcbe53b 
boolean -> bool
@alexitkes alexitkes force-pushed the alexitkes/linear-model-param-default-values branch from fa2272f to fcbe53b Compare October 7, 2019 15:45
@jnothman jnothman requested a review from rth October 8, 2019 05:10
rth
rth reviewed Oct 8, 2019
View reviewed changes
Copy link
Member
@rth rth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor comments, thanks @alexitkes !

alexitkes and others added 7 commits October 8, 2019 16:47
@alexitkes @rth
Update sklearn/linear_model/ridge.py
ebafca0 
Specify array shape as (n_samples,) instead of [n_samples]

Co-Authored-By: Roman Yurchak <rth.yurchak@gmail.com>
@alexitkes @rth
Update sklearn/linear_model/ridge.py
05dd754 
Update parameter type description

Co-Authored-By: Roman Yurchak <rth.yurchak@gmail.com>
@alexitkes @rth
Update sklearn/linear_model/ridge.py
898a5b2 
Update parameter type description

Co-Authored-By: Roman Yurchak <rth.yurchak@gmail.com>
@alexitkes @rth
Update sklearn/linear_model/ridge.py
74eca4e 
Update array shape description in parameter documentation

Co-Authored-By: Roman Yurchak <rth.yurchak@gmail.com>
@alexitkes @rth
Update sklearn/linear_model/ridge.py
018acc9 
Update array shape description

Co-Authored-By: Roman Yurchak <rth.yurchak@gmail.com>
@alexitkes @rth
Update sklearn/linear_model/ridge.py
f18a01e 
Update parameter type documentation

Co-Authored-By: Roman Yurchak <rth.yurchak@gmail.com>
@rth
Lint
a51da44
@rth rth changed the title [MRG] Minor fixes for parameter documentation in ridge DOC Minor fixes for parameter documentation in ridge Oct 8, 2019
@rth rth merged commit 45ac1ef into scikit-learn:master Oct 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rth rth rth approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@alexitkes @jnothman @amueller @adrinjalali @rth
0