Skip to content

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

Merged
OmarManzoor merged 17 commits intoscikit-learn:mainfrom
nxank4:add-links-to-docstrings
Nov 15, 2024
Merged

DOC: Link Examples for SVR, NuSVR, and SVM User Guide#30201
OmarManzoor merged 17 commits intoscikit-learn:mainfrom
nxank4:add-links-to-docstrings

Conversation

@nxank4
Copy link
Copy Markdown
Contributor

@nxank4 nxank4 commented Nov 3, 2024 •
edited by OmarManzoor
Loading

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!

@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 3, 2024 •
edited
Loading

✔️ Linting Passed

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

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

virchan
virchan reviewed Nov 5, 2024
View reviewed changes
Copy link
Copy Markdown
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.

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

nxank4 commented Nov 10, 2024

@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!

virchan
virchan suggested changes Nov 11, 2024
View reviewed changes
Copy link
Copy Markdown
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.

nxank4
nxank4 commented Nov 11, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor Author

@nxank4 nxank4 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

@nxank4
Copy link
Copy Markdown
Contributor Author

nxank4 commented Nov 11, 2024

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?

@nxank4 nxank4 requested a review from virchan November 11, 2024 17:43
virchan
virchan reviewed Nov 12, 2024
View reviewed changes
Copy link
Copy Markdown
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.

@nxank4 nxank4 requested a review from virchan November 12, 2024 15:43
virchan
virchan approved these changes Nov 12, 2024
View reviewed changes
Copy link
Copy Markdown
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.

OmarManzoor
OmarManzoor approved these changes Nov 15, 2024
View reviewed changes
Copy link
Copy Markdown
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
@nxank4
Copy link
Copy Markdown
Contributor Author

nxank4 commented Nov 15, 2024

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

@nxank4 nxank4 deleted the add-links-to-docstrings branch November 15, 2024 16:06
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Dec 4, 2024
@nxank4 @jeremiedbb
DOC: Link Examples for SVR, NuSVR, and SVM User Guide (scikit-learn#3…
48b6687 
…0201)
jeremiedbb pushed a commit that referenced this pull request Dec 6, 2024
@nxank4 @jeremiedbb
DOC: Link Examples for SVR, NuSVR, and SVM User Guide (#30201)
67597ce
@DeaMariaLeon DeaMariaLeon mentioned this pull request Feb 12, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@OmarManzoor OmarManzoor OmarManzoor approved these changes

+1 more reviewer

@virchan virchan virchan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@nxank4 @OmarManzoor @virchan