10000 DOC Link Visualization tools to their respective interpretation in the User Guide · Issue #31304 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Link Visualization tools to their respective interpretation in the User Guide #31304

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.

Sign up for GitHub

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

Jump to bottom
Closed
4 tasks done
ArturoAmorQ opened this issue May 5, 2025 · 5 comments · Fixed by #31309
Closed
4 tasks done

DOC Link Visualization tools to their respective interpretation in the User Guide #31304

ArturoAmorQ opened this issue May 5, 2025 · 5 comments · Fixed by #31309
Labels
Documentation

Comments

@ArturoAmorQ
Copy link
Member
ArturoAmorQ commented May 5, 2025 •
edited
Loading

Describe the issue linked to the documentation

As of today, some of our Display objects point towards the Visualizations section of the User Guide, some of them point toward the respective plotted function, some of them do both.

As sometimes users want to know how to interpret the plot and sometimes they want to understand the plot API, we've resorted to linking both, e.g. for the RocCurveDisplay we have:

    For general information regarding `scikit-learn` visualization tools, see
    the :ref:`Visualization Guide <visualizations>`.
    For guidance on interpreting these plots, refer to the :ref:`Model
    Evaluation Guide <roc_metrics>`.

Contributors willing to address this issue, please fix one of the following listed Display Objects per pull request.

Thanks for your help!

Suggest a potential alternative/fix

No response
@ArturoAmorQ ArturoAmorQ added Documentation Needs Triage Issue requires triage labels May 5, 2025
@ahmedmokeddem
Copy link
Contributor
ahmedmokeddem commented May 5, 2025 •
edited
Loading

Hey, I would like to work on the issue (specifcally metrics.ConfusionMatrixDisplay ) @ArturoAmorQ

@Azzedde
Copy link
Contributor
Azzedde commented May 5, 2025

Hey @ArturoAmorQ I would like to work specifically on inspection.PartialDependenceDisplay

@AchrafTasfaout
Copy link
Contributor

Hey @ArturoAmorQ I would like to work on the issue, specifically metrics.PrecisionRecallDisplay

@Meddhif13
Copy link
Contributor

Hey @ArturoAmorQ I would like to work on the issue, specifically metrics.DetCurveDisplay

@ahmedmokeddem ahmedmokeddem mentioned this issue May 5, 2025
Merged
Meddhif13 added a commit to Meddhif13/scikit-learn that referenced this issue May 5, 2025
@Meddhif13
DOC ADD: link DetCurveDisplay to Visualization and Model Evaluation g…
926f5d2 
…uides (scikit-learn#31304)
@Meddhif13 Meddhif13 mentioned this issue May 5, 2025
Merged
AchrafTasfaout added a commit to AchrafTasfaout/scikit-learn that referenced this issue May 5, 2025
@AchrafTasfaout
DOC ADD Link PrecisionRecallDisplay to both visualization and evaluat…
e494ffc 
…ion guides (scikit-learn#31304)
Azzedde added a commit to Azzedde/scikit-learn that referenced this issue May 5, 2025
@Azzedde
docs: updating docs in partial_dependence.py according to scikit-lear…
af4d019 
…n#31304
@AchrafTasfaout AchrafTasfaout mentioned this issue May 5, 2025
Merged
@Azzedde Azzedde mentioned this issue May 5, 2025
Merged
AchrafTasfaout added a commit to AchrafTasfaout/scikit-learn that referenced this issue May 5, 2025
@AchrafTasfaout
DOC ADD Link from_estimator to both visualization and evaluation guid…
2fc4794 
…es (scikit-learn#31304)
Meddhif13 added a commit to Meddhif13/scikit-learn that referenced this issue May 5, 2025
@Meddhif13
DOC ADD: link DetCurveDisplay to Visualization and Model Evaluation g…
f840ecb 
…uides_2 (scikit-learn#31304)
Meddhif13 added a commit to Meddhif13/scikit-learn that referenced this issue May 5, 2025
@Meddhif13
DOC ADD: link DetCurveDisplay to Visualization and Model Evaluation g…
255b066 
…uides_2 (scikit-learn#31304)
AchrafTasfaout added a commit to AchrafTasfaout/scikit-learn that referenced this issue May 5, 2025
@AchrafTasfaout
DOC ADD Link from_predictions to both visualization and evaluation gu…
ed339d0 
…ides (scikit-learn#31304)
mounirLbath added a commit to mounirLbath/scikit-learn that referenced this issue May 5, 2025
@mounirLbath
Refer to "Visualizations" in user guide from `PartialDependenceDispla…
bf90369 
…y` docstring (as part of scikit-learn#31304)
mounirLbath added a commit to mounirLbath/scikit-learn that referenced this issue May 5, 2025
@mounirLbath
Refer to Visualizations in user guide from PartialDependenceDisplay d…
527bf71 
…ocstring (as part of scikit-learn#31304)
@mounirLbath mounirLbath mentioned this issue May 5, 2025
Merged
@glemaitre glemaitre removed the Needs Triage Issue requires triage label May 7, 2025
@ArturoAmorQ
Copy link
Member Author

Thanks to all the contributors. Closing as completed 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC Update docstring in partial_dependence.py Azzedde/scikit-learn
6 participants
@glemaitre @Meddhif13 @ahmedmokeddem @AchrafTasfaout @Azzedde @ArturoAmorQ
0