Update readme

Signed-off-by: Matt Williams <m@technovangelist.com>
This commit is contained in:
Matt Williams 2024-04-30 22:40:37 -07:00
parent 0ae03eed83
commit 8fef00aa94

View file

@ -2,12 +2,14 @@
[![Watch the video](https://img.youtube.com/vi/GxLoMquHynY/maxresdefault.jpg)](https://youtu.be/GxLoMquHynY) [![Watch the video](https://img.youtube.com/vi/GxLoMquHynY/maxresdefault.jpg)](https://youtu.be/GxLoMquHynY)
1. Get started by installing the requirements: `pip install -r requirements.txt` 1. Install the magic tools:
2. Make sure you have the models listed in config.ini. so for nomic-embed-text, run `ollama pull nomic-embed-text`. Update the config to show whatever models you want to use. - **Debian/Ubuntu**`: `sudo apt-get install libmagic1`
3. Then run ChromaDB in a separate terminal: `chroma run --host localhost --port 8000 --path ../vectordb-stores/chromadb` - **Windows**: You'll need DLLs for libmagic. @julian-r maintains a pypi package with the DLLs, you can fetch it with: `pip install python-magic-bin`
4. Edit the list of docs in `sourcedocs.txt` - **Mac**: `brew install libmagic`
5. Import the docs: `python3 import.py` 2. Get started by installing the requirements: `pip install -r requirements.txt`
6. Perform a search: `python3 search.py <yoursearch>` 3. Make sure you have the models listed in config.ini. so for nomic-embed-text, run `ollama pull nomic-embed-text`. Update the config to show whatever models you want to use.
4. Then run ChromaDB in a separate terminal: `chroma run --host localhost --port 8000 --path ../vectordb-stores/chromadb`
5. Edit the list of docs in `sourcedocs.txt`
6. Import the docs: `python3 import.py`
7. Perform a search: `python3 search.py <yoursearch>`
Some folks on Windows seem to have issues with installing this. I guess the install package names are different there. Try `pip install python-magic-bin` to get the magic stuff working.