apunkt/sqlite-vec
1
0
Fork 0
mirror of https://github.com/asg017/sqlite-vec.git synced 2026-04-25 08:46:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

deno fmt markdown

Browse source
This commit is contained in:
Alex Garcia 2024-06-12 00:13:56 -07:00
parent cfbecee889
commit 420ae0ad5e
1 changed files with 29 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -5,13 +5,17 @@
An extremely small, "fast enough" vector search SQLite extension that runs An extremely small, "fast enough" vector search SQLite extension that runs
anywhere! A successor to [sqlite-vss](https://github.com/asg017/sqlite-vss) 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._ <!-- deno-fmt-ignore-start -->
> [!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._
<!-- deno-fmt-ignore-end -->
- Store and query float, int8, and binary vectors in `vec0` virtual tables - Store and query float, int8, and binary vectors in `vec0` virtual tables
- Pre-filter vectors with `rowid IN (...)` subqueries - Pre-filter vectors with `rowid IN (...)` subqueries
- Written in pure C, no dependencies, - Written in pure C, no dependencies, runs anywhere SQLite runs
runs anywhere SQLite runs (Linux/MacOS/Windows, in the browser with WASM, (Linux/MacOS/Windows, in the browser with WASM, Raspberry Pis, etc.)
Raspberry Pis, etc.)
<p align="center"> <p align="center">
<img src="./.github/logos/mozilla.svg" width=400 /> <img src="./.github/logos/mozilla.svg" width=400 />
@ -67,13 +71,15 @@ limit 2;
## Roadmap ## Roadmap
Not currently implemented, but planned in the future (after initial `v0.1.0` version): Not currently implemented, but planned in the future (after initial `v0.1.0`
version):
- Approximate nearest neighbors search (DiskANN, IVF, maybe HNSW?) - Approximate nearest neighbors search (DiskANN, IVF, maybe HNSW?)
- Metadata filtering + custom internal partitioning - Metadata filtering + custom internal partitioning
- More vector types (float16, int16, sparse, etc.) and distance functions - More vector types (float16, int16, sparse, etc.) and distance functions
Additionally, there will be pre-compiled and pre-packaged packages of `sqlite-vec` for the following platforms: Additionally, there will be pre-compiled and pre-packaged packages of
`sqlite-vec` for the following platforms:
- `pip` for Python - `pip` for Python
- `npm` for Node.js / Deno / Bun - `npm` for Node.js / Deno / Bun
@ -86,7 +92,8 @@ Additionally, there will be pre-compiled and pre-packaged packages of `sqlite-ve
## Sponors ## Sponors
Development of `sqlite-vec` is supported by multiple generous sponsors! Mozilla is the main sponsor through the new Builders project. Development of `sqlite-vec` is supported by multiple generous sponsors! Mozilla
is the main sponsor through the new Builders project.
<p align="center"> <p align="center">
<img src="./.github/logos/mozilla.svg" width=400 /> <img src="./.github/logos/mozilla.svg" width=400 />
@ -94,14 +101,23 @@ Development of `sqlite-vec` is supported by multiple generous sponsors! Mozilla
`sqlite-vec` is also sponsored by the following companies: `sqlite-vec` is also sponsored by the following companies:
<a href="https://fly.io/"><img src="./.github/logos/flyio.svg" width=33%/></a> <a href="https://turso.tech/"><img src="./.github/logos/turso.svg" width=33%/> </a> <a href="https://sqlitecloud.io/"><img src="./.github/logos/sqlitecloud.svg" width=33%/></a> <a href="https://fly.io/"><img src="./.github/logos/flyio.svg" width=33%/></a>
<a href="https://turso.tech/"><img src="./.github/logos/turso.svg" width=33%/>
</a>
<a href="https://sqlitecloud.io/"><img src="./.github/logos/sqlitecloud.svg" width=33%/></a>
As well as multiple individual supporters on [Github sponsors](https://github.com/sponsors/asg017/)! 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 If your company interested in sponsoring `sqlite-vec` development, send me an
email to get more info: https://alexgarcia.xyz
## See Also ## See Also
- [**`sqlite-ecosystem`**](https://github.com/asg017/sqlite-ecosystem), Maybe more 3rd party SQLite extensions I've developed - [**`sqlite-ecosystem`**](https://github.com/asg017/sqlite-ecosystem), Maybe
- [**`sqlite-rembed`**](https://github.com/asg017/sqlite-rembed), Generate text embeddings from remote APIs like OpenAI/Nomic/Ollama, meant for testing and SQL scripts more 3rd party SQLite extensions I've developed
- [**`sqlite-lembed`**](https://github.com/asg017/sqlite-lembed), Generate text embeddings locally from embedding models in the `.gguf` format - [**`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