Add model/dataset cache to GH actions (#26)

* Add GH actions 🤗 cache

* Add GH actions cache update instructions in README + README autoformatting

* Add pip caching to GH actions

---------

Co-authored-by: Jai <[email protected]>

.github/workflows/checks.yml

@@ -21,6 +21,13 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: "3.10"
+          cache: "pip"
+      - name: cache models and datasets
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/huggingface
+          key: ${{ runner.os }}-huggingface-cache-v1  # increment this key to invalidate the cache when new models/datasets are added
       - name: dependencies
         run: |
           python -m pip install --upgrade pip

README.md

@@ -1,13 +1,16 @@
 # Delphi
+
 Interpreting Small Language Models Across Time and Scale
 
 # setup
+
 1. make python 3.10 virtual env in `.venv`
 2. install dependencies `pip install -r requirements.txt`
 3. install the project in editable state `pip install -e .`
 4. run tests `pytest`
 
 # formatting
+
 We're using black & isort to format the code. To make sure your changes adhere to the rules:
 
 1. follow setup instructions above
@@ -19,21 +22,22 @@ When you save a file vscode should automatically format it. Otherwise, pre-commi
 # pull requests
 
 1. make a branch
-    - if it relates to an existing issue
-        - go to the issue page and click *Create a branch* under *Development*
-        - if the default name is not very long, keep it; otherwise, make it shorter, but keep the issue number in the front
-    - otherwise pick a short but descriptive name, a few hyphen-separated-words
+   - if it relates to an existing issue
+     - go to the issue page and click _Create a branch_ under _Development_
+     - if the default name is not very long, keep it; otherwise, make it shorter, but keep the issue number in the front
+   - otherwise pick a short but descriptive name, a few hyphen-separated-words
 2. make your changes
-    - include unit tests
-    - update README if needed
+   - include unit tests
+   - update README if needed
+   - if new huggingface datasets/models are added to testing, increment the cache number in `.github/workflows/checks.yml`
 3. make a pull request
-    - if it isn't ready for review yet, mark it as draft
-    - check if CI is passing
-    - if the change is big, try to keep the commit history clean using interactive rebase
-    - don't push more often than it's needed, we're running github actions on a free tier
-    - if there were any changes to the main branch, rebase on top of it
-    - explain the change
-        - provide short description; focus on things that were not mentioned in the relevant issue
-        - comment important sections of the code in *Files changed* tab
-    - when it's ready, add the relevant stakeholders as reviewers
-4. after the comments are resolved and PR is approved, merge it using *Squash and merge*
+   - if it isn't ready for review yet, mark it as draft
+   - check if CI is passing
+   - if the change is big, try to keep the commit history clean using interactive rebase
+   - don't push more often than it's needed, we're running github actions on a free tier
+   - if there were any changes to the main branch, rebase on top of it
+   - explain the change
+     - provide short description; focus on things that were not mentioned in the relevant issue
+     - comment important sections of the code in _Files changed_ tab
+   - when it's ready, add the relevant stakeholders as reviewers
+4. after the comments are resolved and PR is approved, merge it using _Squash and merge_