DOC Ensures that LabelPropagation passes numpydoc validation #20991
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
This change was added while working on LabelPropogation's numpydoc validation tests because the fit method for this class had a GL08 error (missing docstring), requiring me to look at BaseLabelPropogation's fit dcostring for reference.
…nto LabelPropagation-numpydoc
…nto LabelPropagation-numpydoc
jmloyola
reviewed
Oct 2, 2021
| n_iter_ : int | ||
| Number of iterations run. | ||
| LabelPropagation(...) |
There was a problem hiding this comment.
This line corresponds to the Examples section. It is the output of the fit method.
There was a problem hiding this comment.
@jmloyola thank you for catching that! I will update.
…diting section order
…nto LabelPropagation-numpydoc
|
Thanks @genvalen All good. |
glemaitre
added a commit
to glemaitre/scikit-learn
that referenced
this pull request
Oct 23, 2021
…learn#20991) Co-authored-by: Guillaume Lemaitre <[email protected]>
glemaitre
added a commit
that referenced
this pull request
Oct 25, 2021
Co-authored-by: Guillaume Lemaitre <[email protected]>
samronsin
pushed a commit
to samronsin/scikit-learn
that referenced
this pull request
Nov 30, 2021
…learn#20991) Co-authored-by: Guillaume Lemaitre <[email protected]>
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
Addresses #20308
What does this implement/fix? Explain your changes.
This PR ensures LabelPropogation is compatible with numpydoc:
LabelPropogationfrom DOCSTRING_IGNORE_LIST.Any other comments?
I also edited the summary of the docstring of
BaseLabelPropogation's fit method to improve readability.I used the glossary definition of
semisupervised learningfor guidance.Link to glossary: https://scikit-learn.org/stable/glossary.html