-
-
Notifications
You must be signed in to change notification settings - Fork 25.9k
DOC:Add inline example link to RFECV class docstring (#30621) #31476
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
base: main
Are you sure you want to change the base?
DOC:Add inline example link to RFECV class docstring (#30621) #31476
Conversation
Hi maintainers, just wanted to kindly follow up on this PR. All checks have passed and this adds a relevant example link for RFECV, per Issue #30621. Ready for review when you have a moment. Thanks! |
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.
Thank you for the PR, @VirenPassi! I have a few comments.
In the PR description, please update the text to "Towards #30621" to avoid automatically closing the meta-issue when the PR is merged.
Additionally,
sklearn/feature_selection/_rfe.py
Outdated
|
||
See the example using RFE with cross-validation: | ||
:ref:`sphx_glr_auto_examples_feature_selection_plot_rfe_with_cross_validation.py`. | ||
|
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.
"For a detailed example of using RFECV to select features when training a :class:~sklearn.linear_model.LogisticRegression
, see <example_link>."
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.
Thanks for the feedback! I've updated the PR description to use "Towards #30621" and replaced the docstring line with the suggested sentence. The changes have been pushed. Let me know if there's anything else you'd like me to adjust — thank you!
5c8f81b
to
a684ef7
Compare
Reference Issues/PRs
Towards #30621.
What does this implement/fix?
Added an inline reference link to the example
plot_rfe_with_cross_validation.py
in the docstring of the
RFECV
class (sklearn/feature_selection/_rfe.py
).This enhances documentation by allowing users to access the example directly from the class docs.
These changes are documentation-only and do not affect code functionality.