Enable links to objects in docstrings (Sprint Issue #17417)#17488
Merged
thomasjpfan merged 6 commits intoscikit-learn:masterfrom Jun 6, 2020
Merged
Conversation
… links to file-level docstring
thomasjpfan
reviewed
Jun 6, 2020
Member
thomasjpfan
left a comment
There was a problem hiding this comment.
Thank you for the PR @poorna-kumar !
sklearn/ensemble/_weight_boosting.py
Outdated
| The module structure is the following: | ||
|
|
||
| - The ``BaseWeightBoosting`` base class implements a common ``fit`` method | ||
| - The :class:`~sklearn.ensemble.BaseWeightBoosting` base class implements a common ``fit`` method |
Member
There was a problem hiding this comment.
This should be reverted, since BaseWeightBoosting is not a public class and would not link.
sklearn/ensemble/_weight_boosting.py
Outdated
| See Also | ||
| -------- | ||
| AdaBoostRegressor | ||
| :class:`~sklearn.ensemble.AdaBoostRegressor` |
Member
There was a problem hiding this comment.
The estimators in "See Also" automatically link correctly.
sklearn/ensemble/_weight_boosting.py
Outdated
| -------- | ||
| AdaBoostClassifier, GradientBoostingRegressor, | ||
| sklearn.tree.DecisionTreeRegressor | ||
| :class:`~sklearn.ensemble.AdaBoostClassifier`, |
Member
There was a problem hiding this comment.
This can be reverted. This links correctly as well.
Member
|
Thanks for the PR! you have a linting failure. |
a29725a to
5b603a2
Compare
thomasjpfan
reviewed
Jun 6, 2020
sklearn/ensemble/_weight_boosting.py
Outdated
| only a single regression tree is induced. | ||
|
|
||
| sklearn.tree.DecisionTreeClassifier | ||
| DecisionTreeClassifier |
Member
There was a problem hiding this comment.
This still needs to be reverted because DecisionTreeClassifier is not a part of the sklearn.ensemble module.
5b603a2 to
e1a7576
Compare
thomasjpfan
approved these changes
Jun 6, 2020
Member
thomasjpfan
left a comment
There was a problem hiding this comment.
LGTM Thank you @poorna-kumar and @AnilKumarTeegala!
Member
|
#DataUmbrella sprint |
viclafargue
pushed a commit
to viclafargue/scikit-learn
that referenced
this pull request
Jun 26, 2020
…17417) (scikit-learn#17488) * add StackingClassifier docstring links to objects * add StackingRegressor docstring links to objects * add AdaboostRegressor docstring links to objects * add AdaboostClassifier docstring links to objects; also add docstring links to file-level docstring * fix flake8 violations * reviewer comments
jayzed82
pushed a commit
to jayzed82/scikit-learn
that referenced
this pull request
Oct 22, 2020
…17417) (scikit-learn#17488) * add StackingClassifier docstring links to objects * add StackingRegressor docstring links to objects * add AdaboostRegressor docstring links to objects * add AdaboostClassifier docstring links to objects; also add docstring links to file-level docstring * fix flake8 violations * reviewer comments
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Submitted as part of an sklearn open source sprint. Pair programming with @AnilKumarTeegala.
Reference Issues/PRs
Partially addresses #17417 (for a subset of classes).
What does this implement/fix? Explain your changes.
This PR adds docstring links to the following classes:
Any other comments?