diff --git a/README.md b/README.md index 65b3fd2..56e66a9 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,17 @@ 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 -- Written in pure C, no dependencies, - runs anywhere SQLite runs (Linux/MacOS/Windows, in the browser with WASM, - Raspberry Pis, etc.) +- Written in pure C, no dependencies, runs anywhere SQLite runs + (Linux/MacOS/Windows, in the browser with WASM, Raspberry Pis, etc.)
@@ -67,13 +71,15 @@ limit 2;
## 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?)
- Metadata filtering + custom internal partitioning
- 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
- `npm` for Node.js / Deno / Bun
@@ -86,7 +92,8 @@ Additionally, there will be pre-compiled and pre-packaged packages of `sqlite-ve
## 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.
@@ -94,14 +101,23 @@ Development of `sqlite-vec` is supported by multiple generous sponsors! Mozilla
`sqlite-vec` is also sponsored by the following companies:
-
+
+
+
+
-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
-- [**`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
+- [**`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