-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
DOC Update docstring in partial_dependence.py #31309
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
Conversation
Thanks for the PR @Azzedde, can you please solve the conflicts? |
@ArturoAmorQ the conflicts are solved now and all the checks passed 🫡 |
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 PR @Azzedde. Here a batch of comments. Can you also please change the current line 42 from :ref:Partial Dependence and ICE plots <partial_dependence>
to :ref:Inspection Guide <partial_dependence>
?
@ArturoAmorQ I did solve the comments you mentioned. Thanks for the review ! |
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 again for your work @Azzedde and congrats on your first merge!
Thanks a lot, |
Summary
This PR updates the documentation of the
PartialDependenceDisplay
class insklearn/inspection/_plot/partial_dependence.py
to mirror the style of other Display objects by linking both to the general Visualization API guide and to the interpretation section for partial dependence and ICE plots (issue #31304).Changes
:ref:\
Visualization Guide ``.:ref:\
Partial Dependence and ICE plots section <partial_dependence>``.Motivation
Some Display classes in scikit-learn inconsistently point only to their low-level plotting function or only to the Visualizations guide. To give users both “how do I use this API?” and “what does this plot mean?” contexts, we standardize on dual linking—just like
RocCurveDisplay
.Closes #31304.
How to test (if relevant)
Build the HTML docs (
make html
) and open the Inspection → Partial Dependence page.Confirm that the
PartialDependenceDisplay
class doc now shows two guide links at the top:Repeat for the
from_estimator
method doc.Ensure no rendering errors and that links resolve correctly.
Risks & considerations
Additional information
This is one of several PRs addressing #31304. See related issues/PRs for metric Display classes.