Skip to content
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

Types are appended to parameters in docstring #512

Closed
stsievert opened this issue May 27, 2019 · 1 comment · Fixed by #513
Closed

Types are appended to parameters in docstring #512

stsievert opened this issue May 27, 2019 · 1 comment · Fixed by #513

Comments

@stsievert
Copy link
Member

When I view the docs for IncrementalSearchCV, I see

Screen Shot 2019-05-27 at 4 32 20 PM

This is especially confusing with attributes that end in _:

Screen Shot 2019-05-27 at 4 31 31 PM

@stsievert
Copy link
Member Author

I'm unsure what's causing this: I think the docstrings follow the numpydoc standard:

n_initial_parameters : int, default=10
Number of parameter settings that are sampled.
This trades off runtime vs quality of the solution.
Alternatively, you can set this to ``"grid"`` to do a full grid search.
decay_rate : float, default 1.0
How quickly to decrease the number partial future fit calls.
Higher `decay_rate` will result in lower training times, at the cost
of worse models.

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 a pull request may close this issue.

1 participant