jbloomAus / SAELens

Training Sparse Autoencoders on Language Models
https://jbloomaus.github.io/SAELens/
MIT License
467 stars 125 forks source link

[Proposal] Either explicitly check notebook formatting in CI, or exclude notebooks from make format #287

Closed chanind closed 1 month ago

chanind commented 2 months ago

Proposal

Currently make format will format jupyter notebooks if the user has the black jupyter extension installed. We don't check this in CI though, so it can cause a huge amount of formatting changes for all notebooks when the users runs make format. We should either explicitly block .ipynb files from make format, or we should explicitly add the black jupyter extension as a dependency and check notebook formatting in CI.

My personal preference would be to add the black jupyter notebook plugin and explicitly check in CI to make our notebooks slightly more consistent, but also don't have a strong opinion.

Checklist

jbloomAus commented 1 month ago

Seems good. I'd just format them.

chanind commented 1 month ago

Done by #318