Skip to content

DOC Add "see also" section to learning_curve docstring #31321

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

chemousesi
Copy link

@chemousesi chemousesi commented May 6, 2025

Reference Issues/PRs

Somewhat related to #31302

What does this implement/fix? Explain your changes.

This PR adds a cross-reference in the learning_curve docstring to LearningCurveDisplay.from_estimator

Any other comments?

done during the probabl unaite workshop

Copy link

github-actions bot commented May 6, 2025

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 62c70e7. Link to the linter CI: here

@ArturoAmorQ ArturoAmorQ changed the title added see also on learning curve method in model selection DOC Add "see also" section to learning_curve docstring May 6, 2025
Copy link
Member

@ArturoAmorQ ArturoAmorQ left a 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 @chemousesi! This should fix the failing CI, but I also suggest a wording tweak.

Comment on lines +1932 to +1937
See also:
--------
LearningCurveDisplay.from_estimator : Create a learning curve
display from an estimator

LearningCurveDisplay.from_model : Learn Curve visualization
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LearningCurveDisplay.from_model doesn't exit

Suggested change
See also:
--------
LearningCurveDisplay.from_estimator : Create a learning curve
display from an estimator
LearningCurveDisplay.from_model : Learn Curve visualization
See also
--------
LearningCurveDisplay.from_estimator : Plot a learning curve using an
estimator and data.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants