googlecolab / colabtools

Python libraries for Google Colaboratory
Apache License 2.0
2.17k stars 707 forks source link

Running google colab notebooks as part of CI #3053

Open konstin opened 2 years ago

konstin commented 2 years ago

Is your feature request related to a problem? Please describe.

Our method ColabFold (publication) is a fast wrapper around AlphaFold with a focus on making protein structure prediction accessible through a google colab interface. The key part is that we want an interface that just works for non-programmers (i.e. biologists). The main problem is, how can we test that after a change the notebook still works in google colab? We already have a github actions CI setup for the python code, but we had problems in the past where e.g. updating python package broke the notebook or there was an update in a package or in google colab that broke our setup.

Therefore, is it possible to run a notebook either directly in google colab or in an effectively similar environment?

Describe the solution you'd like

Ideal would be an api through which we could in ci launch a notebook in google colab and check the output against our known good. What would also be extremely helpful would be a colab environment (docker or vm) with the same package version etc. that we could use in ci.

cperry-goog commented 2 years ago

There may be hacky ways to do this, but you can sort of do this with scheduled execution using a Colab Pro+ account. Will keep this open for the feature request, thanks.