Update main README.md #217
Description
The main README.md is a little out of date, and not a super useful reference.
Some things to change/add (probably non-exaustive):
- We now run with Python 3.12
- CI/CD details (ruff, merging to main)
- High level overview of the repository structure / architecture. Link to service README's.
- Remove the environment configuration section (we don't use prod anymore). Instead, explain at a high level how you can configue services using
docker/.env(ideally, have a README fordockerthat can just be directly linked to.) - The installing conda part is pretty redundant. For just deploying NDIF locally, you don't really need anything but Makefile, docker and docker-compose. For running requests, you only really need nnsight.
- Link to our paper.
- Link to our websites (ndif.us, nnsight.net). Maybe also link to our discord