DOC improve docstring of BaseEstimator, ClassifierMixin, and RegressorMixin #28030
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
glemaitre
approved these changes
Jan 12, 2024
There was a problem hiding this comment.
Thanks @Higgs32584.
I made the following change:
- added a long summary (it was not requested but this is the opportunity to do so).
- change slightly the example to only use
BaseEstimator - add the
RegressorMixinat the same time.
|
I will check the rendering and if this is fine, I'll be merging. Thanks @Higgs32584 |
|
Thanks @Higgs32584 |
jeremiedbb
pushed a commit
to jeremiedbb/scikit-learn
that referenced
this pull request
Jan 17, 2024
…rMixin (scikit-learn#28030) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
jeremiedbb
pushed a commit
that referenced
this pull request
Jan 17, 2024
…rMixin (#28030) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
added a commit
to glemaitre/scikit-learn
that referenced
this pull request
Feb 10, 2024
…rMixin (scikit-learn#28030) 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
#27982
What does this implement/fix? Explain your changes.
This is an implementation of #27982 for adding examples under every public class. I added an example for 8000 sklearn.base.ClassifierMixin and sklearn.base.ClassifierMixin. The two examples are redundant. If you would like shorter examples let me know, but I believe an implementation with a longer one helps explain it a bit better.
Any other comments?