From c9dee69c79eebe24d89d30ec0c028cb5a86bc6c8 Mon Sep 17 00:00:00 2001 From: JaiDhyani Date: Mon, 26 Feb 2024 22:04:24 -0800 Subject: [PATCH 1/2] Add llama2c setup instructions --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 255a63d3..9b4ee046 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ Interpreting Small Language Models Across Time and Scale 3. install the project in editable state `pip install -e .` 4. run tests `pytest` +## llama2c Setup +1. `git submodule init` +2. `git submodule update` + # formatting We're using black & isort to format the code. To make sure your changes adhere to the rules: From fddff7e7baaf9874df8cb2a0e5fc47054f4dffd8 Mon Sep 17 00:00:00 2001 From: JaiDhyani Date: Mon, 26 Feb 2024 22:23:59 -0800 Subject: [PATCH 2/2] Updated submodules install instructions --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9b4ee046..105d7ca7 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,22 @@ Interpreting Small Language Models Across Time and Scale -# setup +# 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` +1. Clone this repo and submodules: `git clone https://github.com/delphi-suite/delphi.git --recurse-submodules` +2. make python 3.10 virtual env in `.venv` +3. install dependencies `pip install -r requirements.txt` +4. install the project in editable state `pip install -e .` +5. run tests `pytest` -## llama2c Setup -1. `git submodule init` -2. `git submodule update` +## Submodule Setup +If you cloned without `--recurse-submodules`, you can still install the submodules later with: +```bash +git submodule init +git submodule update +``` -# formatting +# Formatting We're using black & isort to format the code. To make sure your changes adhere to the rules: @@ -23,7 +27,7 @@ We're using black & isort to format the code. To make sure your changes adhere t When you save a file vscode should automatically format it. Otherwise, pre-commit will do that, but you will need to add the changes and commit again. -# pull requests +# Pull Requests 1. make a branch - if it relates to an existing issue