-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Add Tutorials in SpeechBrain repository #2430
base: develop
Are you sure you want to change the base?
Conversation
Great PR, perhaps we can add some basic instructions for how to run one of the notebooks in Google Colab, something like this? https://saturncloud.io/blog/how-can-i-run-notebooks-of-a-github-project-in-google-colab/ Maybe in like a readme in the tutorials folder |
According to what I see, it seems there are some critical aspect. Firstly, when users click on the tutorial while navigating in the repository, Google Colab doesn't start, preventing users from running the code. I suspect this issue might also occur on the website if the link doesn't lead directly to Google Colab. |
There's two things we can do that should mitigate this:
|
We can probably even auto populate and check the links in the readme using a commit hook |
What does this PR do?
This pull request adds tutorials inside the SpeechBrain repository. Indeed, our tutorials can be hard to find if a user is not aware of our website. Most people start their SpeechBrain journey through our GitHub page, and having a tutorials folder will undoubtedly help them get a better grasp of what SpeechBrain is.
Before submitting
PR review
Reviewer checklist