This project runs on Python 3.11.

To install requirements, run

pip install -r requirements.txt

Then install and start postgres:

brew install postgresql

brew services start postgresql

Create a database and a corresponding user. From the terminal, run,

createdb rv

psql rv

From within the PSQL shell that you just opened, run:

CREATE ROLE rv WITH LOGIN PASSWORD 'resids' CREATEDB CREATEROLE;

Do CTRL-D to leave the shell.

Create an empty file called local_settings.py in the server/ directory.

Then run:

alembic upgrade head

to update your local database.

Also, you'll need to install alembic:

pip install alembic

You'll also need to install TransformerLens:

pip install git+https://github.com/neelnanda-io/TransformerLens

To run the frontend, install npm, then, from the client/ directory, run:

npm install

npm start

To populate the backend with prompts/resids/PCA directions, run the following from the server/ directory:

python prompt_writer.py 0 20

python resid_writer.py

python direction_writer.py

If you want a larger number of prompts in the mix (which will ultimately give more accurate PCA directions), you can increase that 20 to an 100 or an 1000 or a 10000, but then it'll take longer to run.

To run the backend, you'll want to run

python app.py

If you are running both the backend and frontend simultaneously, and you've populated the database, then hopefully everything should work.