Skip to content

DOC Remove examples for the old tutorials section #30460

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 2 commits into from
Dec 12, 2024

Conversation

lucyleeow
Copy link
Member

@lucyleeow lucyleeow commented Dec 11, 2024

Reference Issues/PRs

Inspired after #30407 (comment)

What does this implement/fix? Explain your changes.

Currently docs has the following warnings:

Warnings
/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_cv_diabetes.rst:27: WARNING: undefined label: 'cv_estimators_tut' [ref.ref]
/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_cv_diabetes.rst:27: WARNING: undefined label: 'model_selection_tut' [ref.ref]
/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_cv_diabetes.rst:27: WARNING: undefined label: 'stat_learn_tut_index' [ref.ref]

/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_digits_classification_exercise.rst:28: WARNING: undefined label: 'clf_tut' [ref.ref]
/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_digits_classification_exercise.rst:28: WARNING: undefined label: 'supervised_learning_tut' [ref.ref]
/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_digits_classification_exercise.rst:28: WARNING: undefined label: 'stat_learn_tut_index' [ref.ref]

/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_iris_exercise.rst:27: WARNING: undefined label: 'using_kernels_tut' [ref.ref]
/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_iris_exercise.rst:27: WARNING: undefined label: 'supervised_learning_tut' [ref.ref]
/home/lucy/Documents/dev/scikit-learn/doc/auto_examples/exercises/plot_iris_exercise.rst:27: WARNING: undefined label: 'stat_learn_tut_index' [ref.ref]

The tutorials section was removed #29104, the examples gallery examples/exercises still references the old tutorials section. These examples are not very verbose and I don't think they add much value so this PR deletes them

Any other comments?

Copy link

github-actions bot commented Dec 11, 2024

✔️ Linting Passed

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

Generated for commit: bc688bb. Link to the linter CI: here

Copy link
Member Author

@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

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

Maybe @lesteve or @glemaitre may be interested in looking at this?

Comment on lines -8 to -9
This exercise is used in the :ref:`cv_estimators_tut` part of the
:ref:`model_selection_tut` section of the :ref:`stat_learn_tut_index`.
Copy link
Member Author

Choose a reason for hiding this comment

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

This references the old doc/tutorial/statistical_inference/model_selection.rst (you can see it in #29104).
I think the user guide section https://scikit-learn.org/stable/modules/grid_search.html#model-specific-cross-validation pretty much gives similar information as the old tutorial. I would add a link to this example there, but I am a little confused about what this example is trying to say? That GridSearchCV cannot be trusted?!

Comment on lines -8 to -9

This exercise is used in the :ref:`clf_tut` part of the
Copy link
Member Author

Choose a reason for hiding this comment

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

This references the old doc/tutorial/statistical_inference/supervised_learning.rst:

For classification, as in the labeling
`iris <https://en.wikipedia.org/wiki/Iris_flower_data_set>`_ task, linear
regression is not the right approach as it will give too much weight to
data far from the decision frontier. A linear approach is to fit a sigmoid
function or **logistic** function:For classification, as in the labeling
`iris <https://en.wikipedia.org/wiki/Iris_flower_data_set>`_ task, linear
regression is not the right approach as it will give too much weight to
data far from the decision frontier. A linear approach is to fit a sigmoid
function or **logistic** function:

I am actually not clear what " linear regression is not the right approach as it will give too much weight to data far from the decision frontier" means? There is not much text here so I am not exactly sure what it is conveying.

@@ -4,10 +4,6 @@
================================

A tutorial exercise for using different SVM kernels.

This exercise is used in the :ref:`using_kernels_tut` part of the
Copy link
Member Author

Choose a reason for hiding this comment

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

This links to the old doc/tutorial/statistical_inference/supervised_learning.rst, which starts off with:

Classes are not always linearly separable in feature space. The solution is to
build a decision function that is not linear but may be polynomial instead.
This is done using the *kernel trick* that can be seen as
creating a decision energy by positioning *kernels* on observations:

which is nice and explicit, and I don't think the current user guide kernel section does this: https://scikit-learn.org/stable/modules/kernel_approximation.html#kernel-approximation . Would be a separate issue, but we could consider adding bits from this old tutorial page.

Not much text here, I think it is just to show how to use a kernel? I am not sure if there is anywhere in the current user guide that should link to this.

@lesteve
Copy link
Member

lesteve commented Dec 11, 2024

Honestly those were exercises for the old tutorials. Since old tutorials were removed I would say we can remove the examples/exercises completely.

@lucyleeow
Copy link
Member Author

Yeah I would agree with you. I've amended this PR to now delete the tutorial examples.

Let's see what others think now.

@lucyleeow lucyleeow changed the title DOC Remove reference labels to old tutorial section DOC Remove examples for the old tutorials section Dec 12, 2024
@lucyleeow lucyleeow added the Waiting for Second Reviewer First reviewer is done, need a second one! label Dec 12, 2024
Copy link
Member

@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

LGTM !

@jeremiedbb jeremiedbb merged commit 08bc7bb into scikit-learn:main Dec 12, 2024
36 checks passed
@lucyleeow lucyleeow deleted the doc_fix_label branch December 12, 2024 18:20
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Waiting for Second Reviewer First reviewer is done, need a second one!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants