mirror of
https://github.com/asg017/sqlite-vec.git
synced 2026-04-25 00:36:56 +02:00
misc docs
This commit is contained in:
parent
b57a05e2e8
commit
4b140f7294
6 changed files with 113 additions and 24 deletions
|
|
@ -48,6 +48,7 @@ const guides = {
|
|||
collapsed: true,
|
||||
items: [
|
||||
{ text: "Performance", link: "/guides/performance" },
|
||||
|
||||
{
|
||||
text: "Vector operations",
|
||||
items: [
|
||||
|
|
@ -136,10 +137,16 @@ function sidebar(): DefaultTheme.SidebarItem[] {
|
|||
text: "Installation",
|
||||
link: "/installation",
|
||||
},
|
||||
{
|
||||
text: "Quick Start",
|
||||
link: "/quickstart",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Features",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{ text: "Vector formats", link: "/vector-formats" },
|
||||
{ text: "KNN queries", link: "/knn" },
|
||||
{ text: "vec0 virtual vables", link: "/vec0" },
|
||||
{ text: "Static blobs", link: "/numpy" },
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ binary quantized 8-dimensional vector can be stored in a single byte — one bit
|
|||
per element. For 1 million vectors, that would be just `1MB`, a 32x reduction!
|
||||
|
||||
Though keep in mind, you're bound to lose a lot quality when reducing 32 bits of
|
||||
information to 1 bit. [Over-sampling and re-scoring](#re-scoring) will help a
|
||||
information to 1 bit. [Oversampling and re-scoring](#re-scoring) will help a
|
||||
lot.
|
||||
|
||||
The main goal of BQ is to dramatically reduce the size of your vector index,
|
||||
resulting in faster searches and less resources. This is especially useful in
|
||||
resulting in faster searches with less resources. This is especially useful in
|
||||
`sqlite-vec`, which is (currently) brute-force only and meant to run on small
|
||||
devices. BQ is an easy low-cost method to make larger vector datasets easy to
|
||||
devices. BQ is an easy low-cost method to make larger vector datasets easier to
|
||||
manage.
|
||||
|
||||
## Binary Quantization `sqlite-vec`
|
||||
|
|
@ -41,7 +41,9 @@ element in a given vector, it will apply `0` to negative values and `1` to
|
|||
positive values, and pack them into a `BLOB`.
|
||||
|
||||
```sqlite
|
||||
select vec_quantize_binary('[-0.73, -0.80, 0.12, -0.73, 0.79, -0.11, 0.23, 0.97]');
|
||||
select vec_quantize_binary(
|
||||
'[-0.73, -0.80, 0.12, -0.73, 0.79, -0.11, 0.23, 0.97]'
|
||||
);
|
||||
-- X'd4`
|
||||
```
|
||||
|
||||
|
|
@ -51,6 +53,9 @@ The single byte `0xd4` in hexadecimal is `11010100` in binary.
|
|||
|
||||
## Demo
|
||||
|
||||
Here's an end-to-end example of using binary quantization with `vec0` virtual
|
||||
tables in `sqlite-vec`.
|
||||
|
||||
```sqlite
|
||||
create virtual table vec_movies using vec0(
|
||||
synopsis_embedding bit[768]
|
||||
|
|
|
|||
|
|
@ -1,7 +1,21 @@
|
|||
# Using `sqlite-vec` in Go
|
||||
|
||||
There are two ways you can embed `sqlite-vec` into Go applications: a CGO option
|
||||
for libraries like
|
||||
[`github.com/mattn/go-sqlite3`](https://github.com/mattn/go-sqlite3), or a
|
||||
WASM-based option with
|
||||
[`github.com/ncruces/go-sqlite3`](https://github.com/ncruces/go-sqlite3).
|
||||
|
||||
## Option 1: CGO
|
||||
|
||||
```bash
|
||||
go get -u github.com/asg017/sqlite-vec/bindings/go/cgo
|
||||
```
|
||||
|
||||
## Option 2: WASM based with `ncruces/go-sqlite3`
|
||||
|
||||
```
|
||||
go
|
||||
```
|
||||
|
||||
## Working with vectors in Go
|
||||
|
|
|
|||
|
|
@ -1,7 +1,33 @@
|
|||
# Using `sqlite-vec` in Rust
|
||||
|
||||
You can embed `sqlite-vec` into your Rust projects using the official
|
||||
[`sqlite-vec` crate](https://crates.io/crates/sqlite-vec).
|
||||
|
||||
```bash
|
||||
cargo add sqlite-vec
|
||||
```
|
||||
|
||||
The crate embeds the `sqlite-vec` C source code, and uses the
|
||||
[`cc` crate](https://crates.io/crates/sqlite-vec) to compile and statically link
|
||||
`sqlite-vec` at build-time.
|
||||
|
||||
The `sqlite-vec` crate exposes a single function `sqlite3_vec_init`, which is
|
||||
the C entrypoint for the SQLite extension. You can "register" with your Rust
|
||||
SQLite library's `sqlite3_auto_extension()` function. Here's an example with
|
||||
`rusqlite`:
|
||||
|
||||
```rs
|
||||
use sqlite_vec::sqlite3_vec_init;
|
||||
use rusqlite::{ffi::sqlite3_auto_extension};
|
||||
|
||||
fn main() {
|
||||
unsafe {
|
||||
sqlite3_auto_extension(Some(std::mem::transmute(sqlite3_vec_init as *const ())));
|
||||
}
|
||||
// future database connection will now automatically include sqlite-vec functions!
|
||||
}
|
||||
```
|
||||
|
||||
A full [`sqlite-vec` Rust demo](#TODO) is also available.
|
||||
|
||||
## Working with vectors in Rust
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue