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.
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.
"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.
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
There was a problem hiding this comment.
Thank you for updating the PR, @VirenPassi! I have a few more comments.
sklearn/feature_selection/_rfe.py
Outdated
|
|
||
| For a detailed example of using RFECV to select features when training a | ||
| :class:`~sklearn.linear_model.LogisticRegression`, see | ||
| :ref:`sphx_glr_auto_examples_feature_selection_plot_rfe_with_cross_validation.py`. |
There was a problem hiding this comment.
Could you please add a blank line at the end?
There was a problem hiding this comment.
Thanks for the follow-up! I’ve added the blank line after the example link as suggested. Let me know if there’s anything else!
There was a problem hiding this comment.
LGTM! Thanks, @VirenPassi!
@adrinjalali, would you like to have a look and merge this?
…fe-with-cross-validation-30621
There was a problem hiding this comment.
I think in this case it makes more sense to have it in the examples section of the docstring. So I've moved it. Thanks for the PR @VirenPassi
) (scikit-learn#31476) Co-authored-by: adrinjalali <adrin.jalali@gmail.com>
) (scikit-learn#31476) Co-authored-by: adrinjalali <adrin.jalali@gmail.com>
) (scikit-learn#31476) Co-authored-by: adrinjalali <adrin.jalali@gmail.com>
) (scikit-learn#31476) Co-authored-by: adrinjalali <adrin.jalali@gmail.com>
) (scikit-learn#31476) Co-authored-by: adrinjalali <adrin.jalali@gmail.com>
Reference Issues/PRs
Towards #30621.
What does this implement/fix?
Added an inline reference link to the example
plot_rfe_with_cross_validation.pyin the docstring of the
RFECVclass (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.