Skip to content

[MRG] Add default values to doc of RandomizedLasso #8340

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.

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

Closed
wants to merge 4 commits into from
Closed

[MRG] Add default values to doc of RandomizedLasso #8340

wants to merge 4 commits into from

Conversation

maflcko
Copy link

@maflcko maflcko commented Feb 12, 2017

References #7793

I used the default values from

def __init__(self, alpha='aic', scaling=.5, sample_fraction=.75,

@codecov
Copy link

codecov bot commented Feb 12, 2017

Codecov Report

Merging #8340 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #8340      +/-   ##
==========================================
+ Coverage   94.74%   94.75%   +<.01%     
==========================================
  Files         342      342              
  Lines       60735    60801      +66     
==========================================
+ Hits        57543    57609      +66     
  Misses       3192     3192
Impacted Files Coverage Δ
sklearn/linear_model/randomized_l1.py 94.7% <ø> (+0.17%)
sklearn/pipeline.py 99.26% <ø> (-0.36%)
sklearn/datasets/init.py 100% <ø> (ø)
sklearn/datasets/base.py 92.3% <ø> (+0.03%)
sklearn/tests/test_pipeline.py 99.61% <ø> (+0.04%)
sklearn/datasets/tests/test_base.py 97% <ø> (+0.19%)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c6b2002...9858e28. Read the comment docs.

@agramfort
Copy link
Member

can you give the link to the rendered docstrings on circle ci build?

@jnothman
Copy link
Member

@TomDLT
Copy link
Member

TomDLT commented Feb 13, 2017

You missed one or two in RandomizedLogisticRegression and lasso_stability_path

@agramfort
Copy link
Member

I read a

default=np.finfo(np.float).eps

with the double back ticks on the html. I am not sure sure it's expected

cf https://8706-843222-gh.circle-artifacts.com/0/home/ubuntu/scikit-learn/doc/_build/html/stable/modules/generated/sklearn.linear_model.RandomizedLasso.html

@maflcko
Copy link
Author

maflcko commented Feb 14, 2017

@jnothman
Copy link
Member

I don't get how this relates to #7793 which does not mention default values.

We sometimes indicate defaults, but rarely do so like this, which accords with numpy, etc.

@maflcko
Copy link
Author

maflcko commented Feb 15, 2017 via email

@jnothman
Copy link
Member

Makes sense, better to close this pull then.

I don't mind adding some defaults in when it's useful. An example of when it is particularly not useful is when the default is something like None which is semantically unspecified. In this case , optional often tells you as much as you need to know, or otherwise adding (default) to the relevant part of the description (not the type spec which you are currently modifying).

@maflcko
Copy link
Author

maflcko commented Feb 16, 2017

Closing for now.

@maflcko maflcko closed this Feb 16, 2017
@maflcko maflcko deleted the doc_linear_model_randomized_l1 branch February 16, 2017 01:33
@maflcko
Copy link
Author

maflcko commented Feb 16, 2017

Noting here that the default for normalize is currently wrong in the master branch, if someone feels like fixing that.

@jnothman
Copy link
Member

Closing for now.

As you wish.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants