Skip to content

DOC: Link Examples for SVR, NuSVR, and SVM User Guide #30201

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

Merged
merged 17 commits into from
Nov 15, 2024

Conversation

lunovian
Copy link
Contributor

@lunovian lunovian commented Nov 3, 2024

Reference Issues/PRs

Towards #26927

What does this implement/fix? Explain your changes.

This PR adds links to relevant examples in the docstrings for SVR and NuSVR and updates the Support Vector Machines user guide to enhance discoverability and provide practical usage guidance for these estimators. The following links were added:

  • SVR and NuSVR: Linked to plot_svm_regression.py example

Related Example Files:

  • plot_model_complexity_influence.py

Any other comments?

These additions improve documentation clarity, making it easier for users to find relevant examples directly from the API documentation. Let me know if any additional adjustments are required!

Copy link

github-actions bot commented Nov 3, 2024

✔️ Linting Passed

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

Generated for commit: 7ba44b9. Link to the linter CI: here

Copy link
Member

@virchan virchan left a 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 @lunovian! I have a few suggestions.

The example links need to be placed in the doc-strings for the relevant functions/estimators, and in the user guide where applicable. For reference, see PR #26877.

@lunovian lunovian changed the title DOC: Link examples for SGDClassifier, NuSVR, and GradientBoostingRegr… DOC: Link Examples for SVR, NuSVR, and SVM User Guide Nov 10, 2024
@lunovian
Copy link
Contributor Author

@virchan Could you please review and verify the recent push? I've linked the relevant examples for SVR, NuSVR, and updated the SVM user guide accordingly. Let me know if there are any further adjustments needed!

Copy link
Member

@virchan virchan left a comment

Choose a reason for hiding this comment

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

Thank you for updating the PR @lunovian! I have a few additional suggestions.

Copy link
Contributor Author

@lunovian lunovian left a comment

Choose a reason for hiding this comment

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

Remove redundant lines and symbols, rewrite words in sklearn/svm/_classes.py

@lunovian
Copy link
Contributor Author

Remove redundant lines and symbols, rewrite words in sklearn/svm/_classes.py

Somehow, the error appears in the Azure Pipeline, which I didn't touch or anything related to them. Is this just a bug, or it was my fault?

@lunovian lunovian requested a review from virchan November 11, 2024 17:43
Copy link
Member

@virchan virchan left a comment

Choose a reason for hiding this comment

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

So far, so good! I have a few more suggestions.

@lunovian lunovian requested a review from virchan November 12, 2024 15:43
Copy link
Member

@virchan virchan left a comment

Choose a reason for hiding this comment

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

LGTM!

C.c. @adrinjalali.

Copy link
Contributor

@OmarManzoor OmarManzoor left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @lunovian

@OmarManzoor OmarManzoor merged commit e02ee36 into scikit-learn:main Nov 15, 2024
31 checks passed
@lunovian
Copy link
Contributor Author

Thank you @virchan and @OmarManzoor for supporting me with this. As a newbie, I truly appreciate the opportunity to learn new things.

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.

3 participants