Skip to content

Commit 11d97fd

Browse files
chore(readme): proposal
1 parent 9294647 commit 11d97fd

File tree

1 file changed

+68
-75
lines changed

1 file changed

+68
-75
lines changed

README.md

Lines changed: 68 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,8 @@
1212
***Plug-and-play** – drop into existing SQLite workflows with minimal effort
1313
***Cross-platform** – works out of the box on all major OSes
1414

15-
---
16-
17-
## 🧠 What Is Vector Search?
18-
19-
Vector search is the process of finding the closest match(es) to a given vector (a point in high-dimensional space) based on a similarity or distance metric. It is essential for AI and machine learning applications where data is often encoded into vector embeddings.
20-
21-
### Common Use Cases
22-
23-
* **Semantic Search**: find documents, emails, or messages similar to a query
24-
* **Image Retrieval**: search for visually similar images
25-
* **Recommendation Systems**: match users with products, videos, or music
26-
* **Voice and Audio Search**: match voice queries or environmental sounds
27-
* **Anomaly Detection**: find outliers in real-time sensor data
28-
* **Robotics**: localize spatial features or behaviors using embedded observations
29-
30-
In the AI era, embeddings are everywhere – from language models like GPT to vision transformers. Storing and searching them efficiently is the foundation of intelligent applications.
31-
32-
---
3315

34-
## 🧩 Why Use SQLite-Vector?
16+
## Why Use SQLite-Vector?
3517

3618
| Feature | SQLite-Vector | Traditional Solutions |
3719
| -------------------------- | ------------- | ------------------------------------------ |
@@ -45,52 +27,32 @@ In the AI era, embeddings are everywhere – from language models like GPT to vi
4527

4628
Unlike other vector databases or extensions that require complex setup, SQLite-Vector **just works** with your existing database schema and tools.
4729

48-
---
49-
50-
### 🚀 Instant Vector Search – No Preindexing Required
51-
52-
Unlike other SQLite vector extensions that rely on complex indexing algorithms such as DiskANN, HNSW, or IVF, which often require **preprocessing steps that can take hours or even days**, `sqlite-vector` works out of the box with your existing data. There’s **no need to preindex your vectors**—you can start performing fast, approximate or exact vector searches **immediately**.
53-
54-
This means:
55-
56-
* 🕒 **No waiting time** before your app or service is usable
57-
* 🔄 **Zero-cost updates** – you can add, remove, or modify vectors on the fly without rebuilding any index
58-
***Works directly with BLOB columns** in ordinary SQLite tables – no special schema or virtual table required
59-
* 🌍 **Ideal for edge and mobile use cases**, where preprocessing large datasets is not practical or possible
60-
61-
By eliminating the need for heavyweight indexing, `sqlite-vector` offers a **simpler, faster, and more developer-friendly** approach to embedding vector search in your applications.
62-
63-
---
64-
65-
## 🛠 Supported Vector Types
6630

67-
You can store your vectors as `BLOB` columns in ordinary tables. Supported formats include:
68-
69-
* `float32` (4 bytes per element)
70-
* `float16` (2 bytes per element)
71-
* `bfloat16` (2 bytes per element)
72-
* `int8` (1 byte per element)
73-
* `uint8` (1 byte per element)
31+
## 📦 Installation
7432

75-
Simply insert a vector as a binary blob into your table. No special table types or schemas are required.
33+
### Pre-built Binaries
7634

77-
---
35+
Download the appropriate pre-built binary for your platform from the official [Releases](https://github.com/sqliteai/sqlite-vector/releases) page:
7836

79-
## 📐 Supported Distance Metrics
37+
- Linux: x86 and ARM
38+
- macOS: x86 and ARM
39+
- Windows: x86
40+
- Android
41+
- iOS
8042

81-
Optimized implementations available:
43+
### Loading the Extension
8244

83-
* **L2 Distance (Euclidean)**
84-
* **Squared L2**
85-
* **L1 Distance (Manhattan)**
86-
* **Cosine Distance**
87-
* **Dot Product**
45+
```sql
46+
-- In SQLite CLI
47+
.load ./vector
8848

89-
These are implemented in pure C and optimized for SIMD when available, ensuring maximum performance on modern CPUs and mobile devices.
49+
-- In SQL
50+
SELECT load_extension('./vector');
51+
```
9052

91-
---
53+
Or embed it directly into your application.
9254

93-
## 🔍 Example Usage
55+
## Example Usage
9456

9557
```sql
9658
-- Create a regular SQLite table
@@ -120,35 +82,66 @@ SELECT e.id, v.distance FROM images AS e
12082
ON e.id = v.rowid;
12183
```
12284

123-
---
85+
## 📋 Documentation
12486

125-
## 📦 Installation
87+
Extensive API documentation can be found in the [API page](https://github.com/sqliteai/sqlite-vector/blob/main/API.md)
12688

127-
### Pre-built Binaries
89+
## 🧩 Features
12890

129-
Download the appropriate pre-built binary for your platform from the official [Releases](https://github.com/sqliteai/sqlite-vector/releases) page:
91+
### Instant Vector Search – No Preindexing Required
13092

131-
- Linux: x86 and ARM
132-
- macOS: x86 and ARM
133-
- Windows: x86
134-
- Android
135-
- iOS
93+
Unlike other SQLite vector extensions that rely on complex indexing algorithms such as DiskANN, HNSW, or IVF, which often require **preprocessing steps that can take hours or even days**, `sqlite-vector` works out of the box with your existing data. There’s **no need to preindex your vectors**—you can start performing fast, approximate or exact vector searches **immediately**.
13694

137-
### Loading the Extension
95+
This means:
13896

139-
```sql
140-
-- In SQLite CLI
141-
.load ./vector
97+
* 🕒 **No waiting time** before your app or service is usable
98+
* 🔄 **Zero-cost updates** – you can add, remove, or modify vectors on the fly without rebuilding any index
99+
***Works directly with BLOB columns** in ordinary SQLite tables – no special schema or virtual table required
100+
* 🌍 **Ideal for edge and mobile use cases**, where preprocessing large datasets is not practical or possible
142101

143-
-- In SQL
144-
SELECT load_extension('./vector');
145-
```
102+
By eliminating the need for heavyweight indexing, `sqlite-vector` offers a **simpler, faster, and more developer-friendly** approach to embedding vector search in your applications.
146103

147-
Or embed it directly into your application.
104+
### Supported Vector Types
148105

149-
## 📋 Documentation
106+
You can store your vectors as `BLOB` columns in ordinary tables. Supported formats include:
150107

151-
Extensive API documentation can be found in the [API page](https://github.com/sqliteai/sqlite-vector/blob/main/API.md)
108+
* `float32` (4 bytes per element)
109+
* `float16` (2 bytes per element)
110+
* `bfloat16` (2 bytes per element)
111+
* `int8` (1 byte per element)
112+
* `uint8` (1 byte per element)
113+
114+
Simply insert a vector as a binary blob into your table. No special table types or schemas are required.
115+
116+
117+
### Supported Distance Metrics
118+
119+
Optimized implementations available:
120+
121+
* **L2 Distance (Euclidean)**
122+
* **Squared L2**
123+
* **L1 Distance (Manhattan)**
124+
* **Cosine Distance**
125+
* **Dot Product**
126+
127+
These are implemented in pure C and optimized for SIMD when available, ensuring maximum performance on modern CPUs and mobile devices.
128+
129+
---
130+
131+
# 🧠 What Is Vector Search?
132+
133+
Vector search is the process of finding the closest match(es) to a given vector (a point in high-dimensional space) based on a similarity or distance metric. It is essential for AI and machine learning applications where data is often encoded into vector embeddings.
134+
135+
### Common Use Cases
136+
137+
* **Semantic Search**: find documents, emails, or messages similar to a query
138+
* **Image Retrieval**: search for visually similar images
139+
* **Recommendation Systems**: match users with products, videos, or music
140+
* **Voice and Audio Search**: match voice queries or environmental sounds
141+
* **Anomaly Detection**: find outliers in real-time sensor data
142+
* **Robotics**: localize spatial features or behaviors using embedded observations
143+
144+
In the AI era, embeddings are everywhere – from language models like GPT to vision transformers. Storing and searching them efficiently is the foundation of intelligent applications.
152145

153146
## 🌍 Perfect for Edge AI
154147

0 commit comments

Comments
 (0)