Open-Assistant icon indicating copy to clipboard operation
Open-Assistant copied to clipboard

add example notebook

Open andrewm4894 opened this issue 2 years ago • 0 comments

this adds

  • an example notebook as notebooks/example/
  • a readme in notebooks/example/README.md
  • a code cell at the top of notebooks/example/example.ipynb, to be uncommented and ran if running in colab, that will set up the colab notebook to just work and be able to use and files or dirs that live with the notebook, for example reading from a /data/ folder or installing from a requirements.txt.

Main idea here is to give an example that's as easy as just pressing the "Open In Colab", uncommenting top set up cell (if needed) and then ability to just run all cells. This is useful as you can just get a gpu instance (if needed) in colab so should make it easier for users to play with notebooks without too crazy configurations/env's locally that otherwise might block them.

I had a look at mybinder but it did not really work well (was not able to get it to open in a subfolder (thread suggests it should), was much slower than colab also since needed to create images etc).

So i think Colab + set up cell at top should probably be fine and does seem to work pretty well in terms of minimal time to just being able to press "run all" in a notebook and have it run.

Thoughts? I don't mind helping to make sure any notebooks that come in are "runnable in colab" as best we can.

andrewm4894 avatar Jan 08 '23 01:01 andrewm4894