Notebooks Directory

[groadabike]

@jonbarker68,
In Notebooks we have tutorials that are specific for CEC2. I also have some tutorials in the CAD1 recipe.

We need to organise this:

1. Have Google Colab tutorials in the readme of each challenge
2. Move all tutorials to the notebooks directory

I would remove the jupyter files and only have a README with Google Colab links
What do you think?

[jonbarker68]

@groadabike
I prefer to distribute the tutorials along with the repository on GitHub.

This has several advantages over storing them on colab

• All the source remains in one place,
• They are under version control -- so easy to maintain, eg. when we make breaking changes to the library
• They can be tested and formatted with the precommit hooks
• People may want to run them locally anyway, i.e. they'll have local copies when pip -e installing

Storing in GitHub does not prevent easy Colab integration. i.e. Notebooks stored in github can be opened in collab with eg.

https://colab.research.google.com/github/claritychallenge/clarity/blob/master/notebooks/01_Installing_clarity_tools_and_using_metadata.ipynb

For example, see here https://claritychallenge.org/tutorials

Actions

• I agree that these should be linked in the READMEs
• The Cadenza tutorial should also be on the Cadenza website - feel free to reuse the Docusaurus code that we wrote for the Clarity site ... inspired by the Speechbrain tutorials)
• The cadenza tutorials should be committed to the repo and the references in the READMEs can provide links to open them on Colab
• The repositories notebooks/ dir should be reorganised to reflect the repo, e.g.

notebooks/recipes/cad1
notebooks/recipes/cec2

Later we may also introduce non recipes based tutorials, e.g.
notebooks/tutorials/using_the_enhancers
notebooks/tutorials/using_the_evaluators

• One small downside: the links for opening on colab use the github path and so change when we reorganise the repo. This means website that use the link need updating if the repo directory structure is reorganised. But if we get that right now it shouldn't have to change again in the future

• (NB: I've decided that we should move the recipes dir under the clarity dir -- maintaining two parallel package directories at the top level is causing a lot of complication. e.g. we've missed the fact that the recipes code is not under pytest coverage ... currently dealing with this in PR Tests for recipes #270. Does notebooks/ also belong under clarity? It probably does if we want them to be installed when people run pip install -e)

[groadabike]

@jonbarker68 ,

Storing in GitHub does not prevent easy Colab integration. i.e. Notebooks stored in github can be opened in collab with eg.

https://colab.research.google.com/github/claritychallenge/clarity/blob/master/notebooks/01_Installing_clarity_tools_and_using_metadata.ipynb

Oh!, I didn't know about this, very cool. I like it better now. No need to save a copy of the notebooks in colab.

notebooks/recipes/cad1
notebooks/recipes/cec2

Later we may also introduce non recipes based tutorials, e.g.
notebooks/tutorials/using_the_enhancers
notebooks/tutorials/using_the_evaluators

Yeah, I like this distribution of the tutorials, then, in tutorial/README.md we can add links to all of the turorials, e.g., organised with a table.

Does notebooks/ also belong under clarity? It probably does if we want them to be installed when people run pip install -e)

Good question. what would be the advantage of installing them with pip install -e? Most people will clone the repo before installing it, right? If that is the case, they will download the tutorial.

---

btw, I am working on fixing some issues with task1. Should I wait for PR #270 to be merged before submitting mine?