Skip to content

Commit

Permalink
README update (#66)
Browse files Browse the repository at this point in the history
* initial test for sql embeeding store

* feat: Adding sqlite database support for local model

* minor correction

* update readme

---------

Co-authored-by: Charles Xu <charlesxuty@berkeley.edu>
  • Loading branch information
Char15Xu and Charles Xu authored Jul 22, 2024
1 parent 9986186 commit def647e
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion ai_course_bot/ai-chatbot-backend/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
## Setup Instructions
1. install requirements `pip install -r requirements.txt`
2. configure env key, see `.env.example`
3. run server `python main.py`
3. run server `python main.py`

### Configure SQLite Support
1. To enable SQLite support, please set `SQLDB = True` in `ai_course_bot/ai-chatbot-backend/app/core/actions/llama_seletor.py`

2. Download the appropriate `vector0.dylib` and `vss0.dylib` for your machine's hardware from https://github.com/asg017/sqlite-vss/releases.

3. Place `vector0.dylib` and `vss0.dylib` files into the `ai_course_bot/ai-chatbot-backend/app/embedding/dist/debug` directory.

0 comments on commit def647e

Please sign in to comment.