Skip to content

DOC Add doc link to SVC reference#28073

Merged
glemaitre merged 20 commits intoscikit-learn:mainfrom
Alexis-IMBERT:main
Jan 16, 2024
Merged

DOC Add doc link to SVC reference#28073
glemaitre merged 20 commits intoscikit-learn:mainfrom
Alexis-IMBERT:main

Conversation

@Alexis-IMBERT
Copy link
Copy Markdown
Contributor

@Alexis-IMBERT Alexis-IMBERT commented Jan 7, 2024

#26927

Reference Issues/PRs

Add links to examples from the docstrings and user guides

What does this implement/fix? Explain your changes.

I've added the link to the examples/exercises/plot_cv_digits.py example to the sklearn/svm/_classes.py file for the SVC class.

Any other comments?

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 7, 2024

✔️ Linting Passed

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

Generated for commit: 9a5cb8c. Link to the linter CI: here

@glemaitre
Copy link
Copy Markdown
Member

I think that we should actually remove this example. Indeed, it does not use a GridSearchCV and this is something that we should always show.

I assume that we could remove it and redirect this example into another similar example.

@glemaitre
Copy link
Copy Markdown
Member

For instance this (example)[https://scikit-learn.org/dev/auto_examples/model_selection/plot_nested_cross_validation_iris.html#sphx-glr-auto-examples-model-selection-plot-nested-cross-validation-iris-py) is really closed (and could also be transformed into a tutorial style notebook).

@Alexis-IMBERT
Copy link
Copy Markdown
Contributor Author

I think that we should actually remove this example. Indeed, it does not use a GridSearchCV and this is something that we should always show.

I assume that we could remove it and redirect this example into another similar example.

So I should delete this example ?

And refer to another example ? For you which one ?

@glemaitre
Copy link
Copy Markdown
Member

So I should delete this example ?

I would say yes.

And refer to another example ? For you which one ?

To plot_nested_cross_validation_iris.py. We would need to modify the doc/conf.py to redirect the example that we are deleting to this example (it should be around l. 300)

@glemaitre glemaitre changed the title Add doc link to SVC reference DOC Add doc link to SVC reference Jan 15, 2024
@glemaitre glemaitre self-requested a review January 15, 2024 10:19
Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

I push a commit that remove the outdated example. I add to make a bit of changes in one of the tutorial since we were importing some of the content.

I just ask a final rephrasing when linking the example.

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Copy link
Copy Markdown
Member

@glemaitre glemaitre 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 @Alexis-IMBERT

@glemaitre glemaitre merged commit b9a7a5e into scikit-learn:main Jan 16, 2024
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jan 17, 2024
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
jeremiedbb pushed a commit that referenced this pull request Jan 17, 2024
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Feb 10, 2024
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
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