cleanlab / examples

Notebooks demonstrating example applications of the cleanlab library
https://github.com/cleanlab/cleanlab
GNU Affero General Public License v3.0
114 stars 21 forks source link

Add CI workflow #25

Closed huiwengoh closed 1 year ago

huiwengoh commented 2 years ago

Ref: https://github.com/cleanlab/examples/issues/12

huiwengoh commented 2 years ago

Rather than copy-pasting the nblint.py script from the cleanlab repo and modifying it, it would be nice to factor these out into a single place, so they stay in sync with each other / patches get applied to the common version / we can reuse code.

We could either make a GitHub action (little bit of extra boilerplate required, but then we can write stuff like uses: cleanlab/nblint in actions. Or we could just stick this in a common repo, like cleanlab-tools, and just fetch the file from the repo in each CI workflow.

Ah yes great point! Definitely agree that keeping everything in one place and in sync would be best practice.

I have no clue how to make custom GitHub actions, but am willing to invest some time learning if we think this is worthwhile, whereas I presume sticking the common code in a repo like cleanlab-tools would be a simpler task. I'm fine with either, do y'all have any opinions of which approach we should go with? @jwmueller @anishathalye

anishathalye commented 2 years ago

If we go with the GitHub action route: rather than having you learn it on your own, how about we pair program it together this weekend? (or before/after, over Zoom)

I think it's marginal extra effort to make it a GitHub action, btw.

huiwengoh commented 2 years ago

Yup that sounds good!

huiwengoh commented 1 year ago

Added CI for notebook linting, and colab badge + instructions to install requirements to every notebook!

Remaining TODOs: