Skip to content
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

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

Adel-Moumen
Copy link
Collaborator

@Adel-Moumen Adel-Moumen commented Feb 25, 2024

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
  • Did you read the contributor guideline?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Does your code adhere to project-specific code style and conventions?

PR review

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified
  • Confirm that the changes adhere to compatibility requirements (e.g., Python version, platform)
  • Review the self-review checklist to ensure the code is ready for review

@Adel-Moumen Adel-Moumen added the enhancement New feature or request label Feb 25, 2024
@Adel-Moumen Adel-Moumen self-assigned this Feb 25, 2024
@pplantinga
Copy link
Collaborator

pplantinga commented Feb 26, 2024

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

@mravanelli
Copy link
Collaborator

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.

@pplantinga
Copy link
Collaborator

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:

  1. In the website, we can add links directly to colab of our github notebooks. This would be of the format:
    https://colab.research.google.com/github/Adel-Moumen/speechbrain/blob/add_tutorials/tutorials/ASRfromScratch.ipynb
  2. For users navigating the repo, we could add links of the same format in the readme directly

@pplantinga
Copy link
Collaborator

We can probably even auto populate and check the links in the readme using a commit hook

@Adel-Moumen Adel-Moumen marked this pull request as draft April 18, 2024 20:43
@Adel-Moumen Adel-Moumen reopened this Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants