-
-
Notifications
You must be signed in to change notification settings - Fork 25.1k
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
[MRG] DOC Add dropdown to Module 6.1 Pipelines and composite estimators #27022
Conversation
Thanks for the PR @raph333! I think I would also hide the subsections "Construction" "Accessing steps" and "Nested parameters" in 6.1.1.1 as they are user specific for beginners. And now that you are working on this Module, can you also please change the section |
Thank you for the review @ArturoAmorQ ! |
doc/modules/compose.rst
Outdated
----- | ||
.. note:: | ||
|
||
Calling ``fit`` on the pipeline is the same as calling ``fit`` on | ||
each estimator in turn, ``transform`` the input and pass it on to the next step. | ||
The pipeline has all the methods that the last estimator in the pipeline has, | ||
i.e. if the last estimator is a classifier, the :class:`Pipeline` can be used | ||
as a classifier. If the last estimator is a transformer, again, so is the | ||
pipeline. | ||
Calling ``fit`` on the pipeline is the same as calling ``fit`` on | ||
each estimator in turn, ``transform`` the input and pass it on to the next step. | ||
The pipeline has all the methods that the last estimator in the pipeline has, | ||
i.e. if the last estimator is a classifier, the :class:`Pipeline` can be used | ||
as a classifier. If the last estimator is a transformer, again, so is the | ||
pipeline. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please move this note to the end of Section 6.1.1? Right after the paragraph
All estimators in a pipeline, except the last one ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please move this note to the end of Section 6.1.1? Right after the paragraph
All estimators in a pipeline, except the last one ...
Sure, that makes sense @ArturoAmorQ!
I moved the notes and updated the PR (see rendered docs here).
Cheers!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for your work @raph333, merging!
Thanks for the feedback & review! |
Reference Issues/PRs
Add dropdowns to submodule 6.1. Pipelines and composite estimators regarding #26617
What does this implement/fix? Explain your changes.
Seems like this section is only of interest to users who are already familiar with the basics pipelines and transformers. As such, it could be good to hide it with a dropdown to reduce the wall of text new users have to scroll through.
Any other comments?
Didn't see any other sections that would be obvious candidates for hiding in a dropdown. But happy to hear feedback and suggestions!