DOC - Ensure SGDRegressor passes numpydoc validation #21097
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
…egressor Docstring
… SGDRegressor Docstring
…essor.fit Docstring
…egressor.fit Docstring
…ressor.partial_fit Docstring
…egressor.partial_fit Docstring
…ssor.predict Docstring
|
Thanks @EricEllwanger |
glemaitre
added a commit
to glemaitre/scikit-learn
that referenced
this pull request
Oct 23, 2021
Co-authored-by: frellwan <frellwan@hotmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
added a commit
that referenced
this pull request
Oct 25, 2021
Co-authored-by: frellwan <frellwan@hotmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
samronsin
pushed a commit
to samronsin/scikit-learn
that referenced
this pull request
Nov 30, 2021
Co-authored-by: frellwan <frellwan@hotmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
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 #20308
What does this implement/fix? Explain your changes.
Changes to sklearn/linear_model/_stochastic_gradient.py:
Reordered Docstring section for SGDRegressor
Add descriptions for 'See Also' section for SGDRegressor
Added period to Docstring summary for SGDRegressor
Changed parameter learning_type to str in SGDRegressor
Added period to parmaetrs X and Y in BaseSGDRegressor.fit Docstring
Add description to Returns section in BaseSGDRegressor.fit Docstring
Added period to parmaetrs X and Y in BaseSGDRegressor.partial_fit Docstring
Add description to Returns section in BaseSGDRegressor.partial_fit Docstring
Added period to Docstring summary for BaseSGDRegressor.predict
Added description for parameter X for BaseSGDRegressor.predict Docstring
Removed SGDRegressor from DOCSTRING_IGNORE_LIST
Any other comments?