Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
asg017 committed Feb 10, 2023
1 parent 6cf3263 commit ecc0254
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ begin;

delete from vss_articles
where rowid between 100 and 200;

insert into vss_articles(rowd, headline_embedding, description_embedding)
values (:rowid, :headline_embedding, :description_embedding)

Expand All @@ -81,14 +82,6 @@ insert into vss_ivf_articles(operation, headline_embedding, description_embeddin
headline_embedding,
description_embedding
from articles;

-- then insert the index data
insert into vss_ivf_articles(rowid, headline_embedding, description_embedding)
select
rowid,
headline_embedding,
description_embedding
from articles;
```

Beware! Indexes that require training can take a long time. With the [News Category Dataset](./examples/headlines/) (386 dimension over 210k vectors) that this example is based on, the default index would take 8 seconds to build. But with the custom `"IVF4096,Flat,IDMap2"` factory, it took 45 minutes to train and 4.5 minutes to insert data! This likely can be reduced with a smaller training set, but the faster queries can be helpful.
Expand All @@ -115,7 +108,7 @@ If you want to use `sqlite-vss` as a [Runtime-loadable extension](https://www.sq
`sqlite-vector` is a required dependency, so also make sure to [install that loadable extension](https://github.com/asg017/sqlite-vector#Installing) before loading `vss0`.

> **Note:**
> The `0` in the filename (`vss0.dylib`/ `vss0.so`/`vss0.dll`) denotes the major version of `sqlite-vss`. Currently `sqlite-vss` is pre v1, so expect breaking changes in future versions.
> The `0` in the filename (`vss0.dylib`/ `vss0.so`) denotes the major version of `sqlite-vss`. Currently `sqlite-vss` is pre v1, so expect breaking changes in future versions.
For example, if you are using the [SQLite CLI](https://www.sqlite.org/cli.html), you can load the library like so:

Expand Down

0 comments on commit ecc0254

Please sign in to comment.