lucretia/embeddingsearch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed errors in README

Browse Source
This commit is contained in:
EzFeDezy
2025-03-23 22:22:40 +01:00
parent 70759e7870
commit 5ed0ed9aed
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -1,10 +1,12 @@
# embeddingsearch # embeddingsearch
**This is still highly work-in-progress**
Embeddingsearch is a python library that uses Embedding Similarity Search (similiarly to [Magna](https://github.com/yousef-rafat/Magna/tree/main)) to semantically compare a given input to a database of pre-processed entries. Embeddingsearch is a python library that uses Embedding Similarity Search (similiarly to [Magna](https://github.com/yousef-rafat/Magna/tree/main)) to semantically compare a given input to a database of pre-processed entries.
When first implementing the idea, it was conceptualized to only import files into the database. When first implementing the idea, it was conceptualized to only import files into the database.
# How to set up # How to set up
1. Install ![ollama](https://ollama.com/download) 1. Install [ollama](https://ollama.com/download)
2. Pull a few models using ollama (e.g. `paraphrase-multilingual`, `bge-m3`, `mxbai-embed-large`, `nomic-embed-text`) 2. Pull a few models using ollama (e.g. `paraphrase-multilingual`, `bge-m3`, `mxbai-embed-large`, `nomic-embed-text`)
3. [Install the depencencies](#installing-the-dependencies) 3. [Install the depencencies](#installing-the-dependencies)
4. [Set up a local mysql database](#mysql-database-setup) 4. [Set up a local mysql database](#mysql-database-setup)
@@ -45,8 +47,7 @@ CREATE TABLE embedding (id int PRIMARY KEY auto_increment, id_datapoint int, mod
``` ```
# To-do # To-do
- Proper config file - Implement the api server (WSGI via gunicorn / falcon)
- Add support for other databases?
- Add database setup script? - Add database setup script?
- Remove tables related to caching (It's not done on the sql server side anymore.) - Remove tables related to caching (It's not done on the sql server side anymore.)