Commit 6147246
committed
docs: Update README for v0.3.5 - Vector Convenience Methods
Documentation Updates
=====================
- Add 'What's New in 0.3.5' section
- Document new vector operations on Database class
- Show simplified API compared to separate VectorIndex class
- Add code examples for create_index(), insert_vectors(), search()
- Document tokio-optional compatibility
API Examples
============
Before (0.3.4):
from toondb.vector import VectorIndex
index = VectorIndex(dimension=384)
After (0.3.5):
db = Database.open('./mydb')
db.create_index('embeddings', dimension=384)
Benefits
========
- Simpler API - all operations on Database class
- No need to manage separate VectorIndex instances
- Index metadata stored in database
- Backwards compatible with VectorIndex class1 parent f357a98 commit 6147246
1 file changed
Lines changed: 45 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
6 | 37 | | |
7 | 38 | | |
8 | 39 | | |
| |||
72 | 103 | | |
73 | 104 | | |
74 | 105 | | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
75 | 119 | | |
76 | 120 | | |
77 | 121 | | |
| |||
0 commit comments