Skip to content

DOC add scikit-learn MOOC and course materials on the FAQ page #30469

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

Conversation

virchan
Copy link
Member

@virchan virchan commented Dec 11, 2024

Reference Issues/PRs

Fix #30445, and fix #29167.

What does this implement/fix? Explain your changes.

This PR adds links to the scikit-learn MOOC (Massive Open Online Course) and the course materials on the scikit-learn FAQ page.

Previous Versions

Version 4:

FAQ page:
Screenshot 2024-12-19 214809
User guide page (External Resources, Videos and Talks):
Screenshot 2024-12-19 214839 Screenshot 2024-12-19 231914

Version 3:

FAQ page:
Screenshot 2024-12-12 210339
User guide page:
Screenshot 2024-12-12 210427

Version 2:

Screenshot 2024-12-11 145434

Version 1:

Screenshot 2024-12-11 133356

Any other comments?

This is part of the Documentation Improvement Project.

CC: @reshamas and @lucyleeow in advance.

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: a84ebdf. Link to the linter CI: here

Copy link
Member

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

This looks great.

I wonder if we should add this section to "External Resources, Videos and Talks" instead, and add a link to it in the FAQ here?

@betatim
Copy link
Member

betatim commented Dec 12, 2024

I wonder if we should add this section to "External Resources, Videos and Talks" instead, and add a link to it in the FAQ here?

👍 for featuring this in both the FAQ and the external resources page.

One question about the current FAQ entry: what is the difference between the two links/why not just link to https://inria.github.io/scikit-learn-mooc/ ? The second github.io link seems to have all the content and doesn't require sign up

@virchan
Copy link
Member Author

virchan commented Dec 12, 2024

One question about the current FAQ entry: what is the difference between the two links/why not just link to https://inria.github.io/scikit-learn-mooc/ ? The second github.io link seems to have all the content and doesn't require sign up

The first link directs users to the course platform, while the second link provides access to the lecture notes. I included the first one for the sake of completeness and to ensure a logical flow.

After giving it more thought and reviewing the lecture notes, I believe we could replace the first link with the YouTube playlist. This keeps the focus on the course content and better aligns with our objective of pointing users to the actual resources.

I'll update the PR later today and look forward to your feedback!

Copy link
Member Author

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

Ready for review.

Copy link
Member

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

I would have a preference towards adding a new section in "External Resources, Videos and Talks" for the MOOC, and having the information you added in the faq.

In the faq, I would just keep the first sentence and then add a link to the MOOC section in "External Resources, Videos and Talks". It means there's only one place to update links etc.

That's my personal preference, but happy to see what others think.

But

@reshamas
Copy link
Member

We can make this a new issue or add it to this one. The presentations.rst page has very old resources. The last video listed is from 2013, over 10 years ago.

There are updated videos on the playlists here:
https://www.youtube.com/@scikit-learn/playlists

@reshamas
Copy link
Member

@vjcitn If there are tutorials for Bioconductor, they can be added here under "External tutorials"
https://github.com/scikit-learn/scikit-learn/blob/main/doc/presentations.rst#external-tutorials

Copy link
Member Author

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

Ready for review.

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 contribution @virchan! Here is a batch of comments.

Comment on lines 61 to 65
- The `scikit-learn YouTube channel <https://www.youtube.com/@scikit-learn>`_
features a playlist of videos showcasing talks by maintainers
and community members:

`<https://www.youtube.com/@scikit-learn/playlists>`_
Copy link
Member Author

Choose a reason for hiding this comment

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

@reshamas, does this address #30653? If not, I’m happy to continue making adjustments.

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.

Otherwise LGTM

Co-authored-by: Arturo Amor <86408019+ArturoAmorQ@users.noreply.github.com>
Copy link
Member

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

Thank you, this looks great, just 2 nits

Copy link
Member

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

2 more nits!

`Part 1 of 2 <https://www.youtube.com/watch?v=uX4ZirOiWkw>`_,
`Part 2 of 2 <https://www.youtube.com/watch?v=kTLyp10FD60>`_.

Notebooks available on
`github <https://github.com/jakevdp/sklearn_scipy2013>`_.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've removed the link to the Whiteboard series. If there's a better alternative, I'd be happy to update it further.

@lesteve
Copy link
Member

lesteve commented Jan 23, 2025

I pushed some small tweaks, with this I think this should be good enough to merge.

For later:

  • I think we should remove the old videos (latest one is from 2013 I don't think they are that relevant)
  • we should have a better resource for getting started, follow a 40 hour MOOC is not necessarily the best thing to point at. Part of me think the old tutorials that were removed were good enough but oh well ... we also have doc/getting_started.rst which may need to be looked at

@lesteve
Copy link
Member

lesteve commented Jan 23, 2025

OK let's merge this, thanks @virchan for the PR and everyone else for the inputs and reviews!

@lesteve lesteve merged commit 1be6ca9 into scikit-learn:main Jan 23, 2025
31 checks passed
@virchan
Copy link
Member Author

virchan commented Jan 23, 2025

Thank you everyone for your time! 🫡

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.

DOC Beginners Tutorial DOC add FAQ link to scikit-learn course
6 participants