Install autoformatting tools and add formatting checks to CI (Transfo…

…rmerLensOrg#270)

* Install formatting tools

* Add linting to CI

* Autoformat all files

.github/workflows/checks.yml

@@ -57,6 +57,8 @@ jobs:
         run: |
           poetry lock --check
           poetry install --with dev
+      - name: Check format
+        run: make check-format
       - name: Unit test
         run: make unit-test
       - name: Acceptance test

docs/source/conf.py

@@ -6,32 +6,33 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'TransformerLens'
-copyright = '2023, Neel Nanda'
-author = 'Neel Nanda'
-release = '0.0.0'
+project = "TransformerLens"
+copyright = "2023, Neel Nanda"
+author = "Neel Nanda"
+release = "0.0.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.autodoc',
-              'sphinxcontrib.napoleon',
-              'myst_parser',
-              "sphinx.ext.githubpages"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinxcontrib.napoleon",
+    "myst_parser",
+    "sphinx.ext.githubpages",
+]
 
 source_suffix = {
     ".rst": "restructuredtext",
     ".md": "markdown",
 }
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "furo"
 html_title = "TransformerLens Documentation"
-html_static_path = ['_static']
+html_static_path = ["_static"]

easy_transformer/__init__.py

@@ -1,3 +1,4 @@
 import logging
+
 logging.warning("DEPRECATED: Library has been renamed, import transformer_lens instead")
-from transformer_lens import *
+from transformer_lens import *

makefile

@@ -1,3 +1,13 @@
+format:
+	poetry run python -m pycln --all . --exclude "__init__.py"
+	poetry run python -m isort format .
+	poetry run python -m black .
+
+check-format:
+	poetry run python -m pycln --check --all . --exclude "__init__.py"
+	poetry run python -m isort --check-only .
+	poetry run python -m black --check .
+
 test:
 	make unit-test
 	make acceptance-test

pyproject.toml

@@ -36,6 +36,9 @@ mypy = ">=0.991"
 jupyter = ">=1.0.0"
 circuitsvis = ">=1.38.1"
 plotly = ">=5.12.0"
+isort = "5.8.0"
+black = "^23.3.0"
+pycln = "^2.1.3"
 
 [tool.poetry.group.jupyter.dependencies]
 jupyterlab = ">=3.5.0"
@@ -52,4 +55,8 @@ filterwarnings = [
     # Ignore numpy.distutils deprecation warning caused by pandas
     # More info: https://numpy.org/doc/stable/reference/distutils.html#module-numpy.distutils
     "ignore:distutils Version classes are deprecated:DeprecationWarning"
-]
+]
+
+[tool.isort]
+profile = "black"
+extend_skip = ["__init__.py"]

setup.py

@@ -20,7 +20,7 @@
         "fancy_einsum",
         "rich",
         "accelerate",
-        "typing-extensions"
+        "typing-extensions",
     ],
     extras_require={"dev": ["pytest", "mypy", "pytest-cov"]},
 )