diff --git a/.github/logos/flyio.small.ico b/.github/logos/flyio.small.ico new file mode 100644 index 0000000..68eadad Binary files /dev/null and b/.github/logos/flyio.small.ico differ diff --git a/.github/logos/flyio.svg b/.github/logos/flyio.svg new file mode 100644 index 0000000..cc3ff6e --- /dev/null +++ b/.github/logos/flyio.svg @@ -0,0 +1,15 @@ + diff --git a/.github/logos/mozilla.svg b/.github/logos/mozilla.svg new file mode 100644 index 0000000..fff3920 --- /dev/null +++ b/.github/logos/mozilla.svg @@ -0,0 +1,24 @@ + + + + + + + + + diff --git a/.github/logos/sqlitecloud.small.svg b/.github/logos/sqlitecloud.small.svg new file mode 100644 index 0000000..140d3d2 --- /dev/null +++ b/.github/logos/sqlitecloud.small.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/.github/logos/sqlitecloud.svg b/.github/logos/sqlitecloud.svg new file mode 100644 index 0000000..2b835ef --- /dev/null +++ b/.github/logos/sqlitecloud.svg @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.github/logos/turso.small.ico b/.github/logos/turso.small.ico new file mode 100644 index 0000000..a7fac9d Binary files /dev/null and b/.github/logos/turso.small.ico differ diff --git a/.github/logos/turso.svg b/.github/logos/turso.svg new file mode 100644 index 0000000..fc93433 --- /dev/null +++ b/.github/logos/turso.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/.gitignore b/.gitignore index ddfdce6..404b43b 100644 --- a/.gitignore +++ b/.gitignore @@ -12,7 +12,6 @@ dist/ *.pyc *.db-journal -*.svg alexandria/ openai/ diff --git a/README.md b/README.md index 75003aa..65b3fd2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # `sqlite-vec` +[![](https://dcbadge.vercel.app/api/server/VCtQ8cGhUs)](https://discord.gg/VCtQ8cGhUs) + An extremely small, "fast enough" vector search SQLite extension that runs anywhere! A successor to [sqlite-vss](https://github.com/asg017/sqlite-vss) -> [!IMPORTANT] -> *`sqlite-vec` is a work-in-progress and not ready for general usage! I plan to launch a "beta" version in the next month or so. Watch this repo for updates, and read [this blog post](https://alexgarcia.xyz/blog/2024/building-new-vector-search-sqlite/index.html) for more info.* +> [!IMPORTANT] > _`sqlite-vec` is a work-in-progress and not ready for general usage! I plan to launch a "beta" version in the next month or so. Watch this repo for updates, and read [this blog post](https://alexgarcia.xyz/blog/2024/building-new-vector-search-sqlite/index.html) for more info._ - Store and query float, int8, and binary vectors in `vec0` virtual tables - Pre-filter vectors with `rowid IN (...)` subqueries @@ -12,6 +13,22 @@ anywhere! A successor to [sqlite-vss](https://github.com/asg017/sqlite-vss) runs anywhere SQLite runs (Linux/MacOS/Windows, in the browser with WASM, Raspberry Pis, etc.) +

+ +

+ +

+ +sqlite-vec is a +Mozilla Builders project, +with additional sponsorship from + Fly.io , + Turso, and + SQLite Cloud. +See the Sponsors section for more details. + +

+ ## Sample usage ```sql @@ -50,9 +67,9 @@ limit 2; ## Roadmap -Not currently implemented, but planned in the future (after initial beta version): +Not currently implemented, but planned in the future (after initial `v0.1.0` version): -- Approximate nearest neighbors search (IVF and HNSW) +- Approximate nearest neighbors search (DiskANN, IVF, maybe HNSW?) - Metadata filtering + custom internal partitioning - More vector types (float16, int16, sparse, etc.) and distance functions @@ -67,7 +84,24 @@ Additionally, there will be pre-compiled and pre-packaged packages of `sqlite-ve - Datasette and sqlite-utils plugins - Pre-compiled loadable extensions on Github releases +## Sponors -## Support +Development of `sqlite-vec` is supported by multiple generous sponsors! Mozilla is the main sponsor through the new Builders project. -Is your company interested in sponsoring `sqlite-vec` development? Send me an email to get more info: https://alexgarcia.xyz +

+ +

+ +`sqlite-vec` is also sponsored by the following companies: + + + +As well as multiple individual supporters on [Github sponsors](https://github.com/sponsors/asg017/)! + +If your company interested in sponsoring `sqlite-vec` development, send me an email to get more info: https://alexgarcia.xyz + +## See Also + +- [**`sqlite-ecosystem`**](https://github.com/asg017/sqlite-ecosystem), Maybe more 3rd party SQLite extensions I've developed +- [**`sqlite-rembed`**](https://github.com/asg017/sqlite-rembed), Generate text embeddings from remote APIs like OpenAI/Nomic/Ollama, meant for testing and SQL scripts +- [**`sqlite-lembed`**](https://github.com/asg017/sqlite-lembed), Generate text embeddings locally from embedding models in the `.gguf` format