-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcache_optimizer.py
More file actions
692 lines (580 loc) · 25 KB
/
cache_optimizer.py
File metadata and controls
692 lines (580 loc) · 25 KB
1
2
3
4
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
"""
TurboQuant Cache Optimizer — Compress Redis, Elasticsearch, Ehcache, and Any K-V Cache
========================================================================================
Drop-in adapters that transparently compress/decompress vectors using TurboQuant.
Supported backends:
- Redis: Store compressed vectors as binary strings
- Elasticsearch: Compressed vector search with score correction
- Generic: Wraps any dict-like cache (Ehcache-style via Py4J, memcached, etc.)
- Database: SQLite/Postgres/MySQL compressed BLOB storage
Usage:
from turboquant.core import TurboQuantEncoder, TurboQuantConfig
from turboquant.cache_optimizer import RedisTurboCache
encoder = TurboQuantEncoder(dim=768)
cache = RedisTurboCache(encoder, redis_client)
cache.put("doc:1", embedding_vector)
vec = cache.get("doc:1")
results = cache.search(query_vector, k=10)
"""
import json
import time
import hashlib
from typing import Any, Dict, List, Optional, Tuple, Protocol
from dataclasses import dataclass
import numpy as np
from core import TurboQuantEncoder, TurboQuantConfig, CompressedVector
# ============================================================================
# Base Cache Protocol
# ============================================================================
class CacheBackend(Protocol):
"""Protocol for any cache backend."""
def get(self, key: str) -> Optional[bytes]: ...
def set(self, key: str, value: bytes, ttl: Optional[int] = None) -> None: ...
def delete(self, key: str) -> None: ...
def keys(self, pattern: str = "*") -> List[str]: ...
# ============================================================================
# Redis Adapter
# ============================================================================
class RedisTurboCache:
"""
Redis adapter with TurboQuant compression.
Stores vectors as compressed binary strings. Achieves ~4-6x memory reduction
on vector data while maintaining near-perfect recall for similarity search.
Features:
- Transparent encode/decode on get/put
- Batch operations for pipeline efficiency
- Built-in similarity search (brute-force over compressed vectors)
- TTL support
- Key prefixing for namespace isolation
"""
def __init__(self, encoder: TurboQuantEncoder, redis_client: Any,
prefix: str = "tq:", ttl: Optional[int] = None):
self.encoder = encoder
self.redis = redis_client
self.prefix = prefix
self.default_ttl = ttl
def _key(self, key: str) -> str:
return f"{self.prefix}{key}"
def put(self, key: str, vector: np.ndarray, ttl: Optional[int] = None) -> dict:
"""Store a compressed vector in Redis."""
compressed = self.encoder.encode(vector)
data = compressed.to_bytes()
rkey = self._key(key)
exp = ttl or self.default_ttl
if exp:
self.redis.setex(rkey, exp, data)
else:
self.redis.set(rkey, data)
return {
"key": key,
"original_bytes": len(vector) * 4,
"compressed_bytes": len(data),
"ratio": f"{(len(vector) * 4) / len(data):.1f}x",
}
def get(self, key: str) -> Optional[np.ndarray]:
"""Retrieve and decompress a vector from Redis."""
data = self.redis.get(self._key(key))
if data is None:
return None
compressed = CompressedVector.from_bytes(data)
return self.encoder.decode(compressed)
def get_compressed(self, key: str) -> Optional[CompressedVector]:
"""Get the compressed vector (for similarity without decompression)."""
data = self.redis.get(self._key(key))
if data is None:
return None
return CompressedVector.from_bytes(data)
def put_batch(self, items: Dict[str, np.ndarray], ttl: Optional[int] = None) -> dict:
"""Batch store compressed vectors using Redis pipeline."""
pipe = self.redis.pipeline()
exp = ttl or self.default_ttl
total_original = 0
total_compressed = 0
for key, vector in items.items():
compressed = self.encoder.encode(vector)
data = compressed.to_bytes()
rkey = self._key(key)
if exp:
pipe.setex(rkey, exp, data)
else:
pipe.set(rkey, data)
total_original += len(vector) * 4
total_compressed += len(data)
pipe.execute()
return {
"count": len(items),
"original_bytes": total_original,
"compressed_bytes": total_compressed,
"ratio": f"{total_original / max(total_compressed, 1):.1f}x",
}
def get_batch(self, keys: List[str]) -> Dict[str, Optional[np.ndarray]]:
"""Batch retrieve and decompress vectors."""
pipe = self.redis.pipeline()
for key in keys:
pipe.get(self._key(key))
results = pipe.execute()
output = {}
for key, data in zip(keys, results):
if data is not None:
compressed = CompressedVector.from_bytes(data)
output[key] = self.encoder.decode(compressed)
else:
output[key] = None
return output
def search(self, query: np.ndarray, k: int = 10,
key_pattern: str = "*") -> List[Tuple[str, float]]:
"""
Brute-force similarity search over compressed vectors.
For large-scale search, use Elasticsearch adapter instead.
This is suitable for < 100K vectors.
"""
query_compressed = self.encoder.encode(query)
results = []
# Scan all keys matching pattern
cursor = 0
while True:
cursor, keys = self.redis.scan(cursor, match=self._key(key_pattern))
pipe = self.redis.pipeline()
for key in keys:
pipe.get(key)
values = pipe.execute()
for key, data in zip(keys, values):
if data is not None:
candidate = CompressedVector.from_bytes(data)
score = self.encoder.similarity(query_compressed, candidate)
clean_key = key.decode() if isinstance(key, bytes) else key
clean_key = clean_key[len(self.prefix):]
results.append((clean_key, score))
if cursor == 0:
break
results.sort(key=lambda x: x[1], reverse=True)
return results[:k]
def memory_stats(self) -> dict:
"""Get memory usage statistics for compressed vectors."""
info = self.redis.info("memory")
keys = list(self.redis.scan_iter(match=self._key("*")))
total_compressed = 0
for key in keys:
data = self.redis.get(key)
if data:
total_compressed += len(data)
return {
"vector_count": len(keys),
"total_compressed_bytes": total_compressed,
"avg_bytes_per_vector": total_compressed // max(len(keys), 1),
"redis_used_memory": info.get("used_memory_human", "unknown"),
}
def delete(self, key: str) -> bool:
return bool(self.redis.delete(self._key(key)))
def flush(self) -> int:
"""Delete all TurboQuant keys."""
keys = list(self.redis.scan_iter(match=self._key("*")))
if keys:
return self.redis.delete(*keys)
return 0
# ============================================================================
# Elasticsearch Adapter
# ============================================================================
class ElasticsearchTurboCache:
"""
Elasticsearch adapter with TurboQuant compression.
Stores compressed vectors alongside dense_vector fields for hybrid search.
Uses compressed similarity for re-ranking and memory-efficient storage.
Strategies:
1. Store compressed vectors as binary fields + approximate kNN
2. Use TurboQuant similarity as a script_score for re-ranking
3. Bulk index with compression for memory reduction
"""
def __init__(self, encoder: TurboQuantEncoder, es_client: Any,
index_name: str = "turboquant_vectors"):
self.encoder = encoder
self.es = es_client
self.index_name = index_name
def create_index(self, dims: Optional[int] = None) -> dict:
"""Create an optimized index for compressed vector storage."""
dims = dims or self.encoder.dim
mapping = {
"mappings": {
"properties": {
"vector_compressed": {
"type": "binary", # Stores TurboQuant compressed bytes
},
"vector_dense": {
"type": "dense_vector",
"dims": dims,
"index": True,
"similarity": "cosine",
},
"metadata": {
"type": "object",
"enabled": True,
},
"compression_ratio": {
"type": "float",
},
}
},
"settings": {
"number_of_shards": 1,
"number_of_replicas": 0,
"refresh_interval": "30s",
}
}
if self.es.indices.exists(index=self.index_name):
self.es.indices.delete(index=self.index_name)
return self.es.indices.create(index=self.index_name, body=mapping)
def index_vector(self, doc_id: str, vector: np.ndarray,
metadata: Optional[dict] = None,
store_dense: bool = False) -> dict:
"""
Index a vector with TurboQuant compression.
Args:
store_dense: If True, also stores the full dense_vector for ES kNN.
Set False for maximum compression (use compressed search).
"""
import base64
compressed = self.encoder.encode(vector)
compressed_b64 = base64.b64encode(compressed.to_bytes()).decode()
doc = {
"vector_compressed": compressed_b64,
"compression_ratio": compressed.compression_ratio(),
"metadata": metadata or {},
}
if store_dense:
doc["vector_dense"] = vector.tolist()
return self.es.index(index=self.index_name, id=doc_id, body=doc)
def bulk_index(self, vectors: Dict[str, np.ndarray],
metadata: Optional[Dict[str, dict]] = None,
store_dense: bool = False,
chunk_size: int = 500) -> dict:
"""Bulk index vectors with compression."""
import base64
actions = []
total_original = 0
total_compressed = 0
for doc_id, vector in vectors.items():
compressed = self.encoder.encode(vector)
compressed_bytes = compressed.to_bytes()
compressed_b64 = base64.b64encode(compressed_bytes).decode()
total_original += len(vector) * 4
total_compressed += len(compressed_bytes)
doc = {
"vector_compressed": compressed_b64,
"compression_ratio": compressed.compression_ratio(),
"metadata": (metadata or {}).get(doc_id, {}),
}
if store_dense:
doc["vector_dense"] = vector.tolist()
actions.append({"index": {"_index": self.index_name, "_id": doc_id}})
actions.append(doc)
if len(actions) >= chunk_size * 2:
self.es.bulk(body=actions, refresh=False)
actions = []
if actions:
self.es.bulk(body=actions, refresh=False)
self.es.indices.refresh(index=self.index_name)
return {
"indexed": len(vectors),
"original_bytes": total_original,
"compressed_bytes": total_compressed,
"ratio": f"{total_original / max(total_compressed, 1):.1f}x",
}
def search(self, query: np.ndarray, k: int = 10,
use_dense_knn: bool = False, rerank: bool = True) -> List[dict]:
"""
Search for similar vectors.
Modes:
1. use_dense_knn=True: Use ES native kNN, optionally rerank with TurboQuant
2. use_dense_knn=False: Fetch all compressed vectors, compute similarity client-side
"""
import base64
if use_dense_knn:
# Use ES native approximate kNN
body = {
"knn": {
"field": "vector_dense",
"query_vector": query.tolist(),
"k": k * 3 if rerank else k,
"num_candidates": max(k * 10, 100),
},
"_source": ["vector_compressed", "metadata", "compression_ratio"],
}
response = self.es.search(index=self.index_name, body=body)
hits = response["hits"]["hits"]
if rerank and hits:
query_compressed = self.encoder.encode(query)
reranked = []
for hit in hits:
compressed_b64 = hit["_source"]["vector_compressed"]
compressed = CompressedVector.from_bytes(
base64.b64decode(compressed_b64)
)
score = self.encoder.similarity(query_compressed, compressed)
reranked.append({
"id": hit["_id"],
"score": score,
"es_score": hit["_score"],
"metadata": hit["_source"].get("metadata", {}),
})
reranked.sort(key=lambda x: x["score"], reverse=True)
return reranked[:k]
else:
return [{
"id": hit["_id"],
"score": hit["_score"],
"metadata": hit["_source"].get("metadata", {}),
} for hit in hits[:k]]
else:
# Client-side compressed search (no dense_vector needed)
query_compressed = self.encoder.encode(query)
body = {
"query": {"match_all": {}},
"_source": ["vector_compressed", "metadata"],
"size": 10000, # Fetch all (for small indices)
}
response = self.es.search(index=self.index_name, body=body)
results = []
for hit in response["hits"]["hits"]:
compressed_b64 = hit["_source"]["vector_compressed"]
compressed = CompressedVector.from_bytes(
base64.b64decode(compressed_b64)
)
score = self.encoder.similarity(query_compressed, compressed)
results.append({
"id": hit["_id"],
"score": score,
"metadata": hit["_source"].get("metadata", {}),
})
results.sort(key=lambda x: x["score"], reverse=True)
return results[:k]
def get_vector(self, doc_id: str) -> Optional[np.ndarray]:
"""Retrieve and decompress a vector by document ID."""
import base64
try:
doc = self.es.get(index=self.index_name, id=doc_id)
compressed_b64 = doc["_source"]["vector_compressed"]
compressed = CompressedVector.from_bytes(base64.b64decode(compressed_b64))
return self.encoder.decode(compressed)
except Exception:
return None
def stats(self) -> dict:
"""Get index statistics."""
stats = self.es.indices.stats(index=self.index_name)
idx_stats = stats["indices"][self.index_name]["total"]
return {
"doc_count": idx_stats["docs"]["count"],
"store_size": idx_stats["store"]["size_in_bytes"],
"store_size_human": f"{idx_stats['store']['size_in_bytes'] / 1e6:.1f}MB",
}
# ============================================================================
# Generic Cache Adapter (Ehcache-style, memcached, dict, etc.)
# ============================================================================
class GenericTurboCache:
"""
Generic cache adapter with TurboQuant compression.
Works with any backend that supports get/set/delete with bytes values.
Compatible with: Python dict, memcached, Ehcache (via Py4J), shelve, etc.
For Ehcache (Java) integration, use Py4J gateway or subprocess bridge.
"""
def __init__(self, encoder: TurboQuantEncoder,
backend: Optional[Any] = None):
"""
Args:
backend: Any object with get(key)->bytes, set(key, bytes), delete(key).
If None, uses an in-memory dict.
"""
self.encoder = encoder
self.backend = backend or InMemoryBackend()
self._stats = {"puts": 0, "gets": 0, "hits": 0, "bytes_saved": 0}
def put(self, key: str, vector: np.ndarray) -> dict:
"""Store a compressed vector."""
compressed = self.encoder.encode(vector)
data = compressed.to_bytes()
self.backend.set(key, data)
original_bytes = len(vector) * 4
self._stats["puts"] += 1
self._stats["bytes_saved"] += original_bytes - len(data)
return {
"key": key,
"original_bytes": original_bytes,
"compressed_bytes": len(data),
"ratio": f"{original_bytes / len(data):.1f}x",
}
def get(self, key: str) -> Optional[np.ndarray]:
"""Retrieve and decompress a vector."""
self._stats["gets"] += 1
data = self.backend.get(key)
if data is None:
return None
self._stats["hits"] += 1
compressed = CompressedVector.from_bytes(data)
return self.encoder.decode(compressed)
def delete(self, key: str) -> None:
self.backend.delete(key)
def put_batch(self, items: Dict[str, np.ndarray]) -> dict:
"""Batch store vectors."""
total_original = 0
total_compressed = 0
for key, vec in items.items():
info = self.put(key, vec)
total_original += info["original_bytes"]
total_compressed += info["compressed_bytes"]
return {
"count": len(items),
"original_bytes": total_original,
"compressed_bytes": total_compressed,
"ratio": f"{total_original / max(total_compressed, 1):.1f}x",
}
def get_batch(self, keys: List[str]) -> Dict[str, Optional[np.ndarray]]:
"""Batch retrieve vectors."""
return {key: self.get(key) for key in keys}
def search(self, query: np.ndarray, keys: List[str], k: int = 10) -> List[Tuple[str, float]]:
"""Search over specified keys for similar vectors."""
query_compressed = self.encoder.encode(query)
results = []
for key in keys:
data = self.backend.get(key)
if data is not None:
candidate = CompressedVector.from_bytes(data)
score = self.encoder.similarity(query_compressed, candidate)
results.append((key, score))
results.sort(key=lambda x: x[1], reverse=True)
return results[:k]
def stats(self) -> dict:
return {
**self._stats,
"hit_rate": f"{self._stats['hits'] / max(self._stats['gets'], 1):.1%}",
"total_bytes_saved": self._stats["bytes_saved"],
}
class InMemoryBackend:
"""Simple in-memory dict backend for GenericTurboCache."""
def __init__(self):
self._store: Dict[str, bytes] = {}
def get(self, key: str) -> Optional[bytes]:
return self._store.get(key)
def set(self, key: str, value: bytes, ttl: Optional[int] = None) -> None:
self._store[key] = value
def delete(self, key: str) -> None:
self._store.pop(key, None)
def keys(self, pattern: str = "*") -> List[str]:
return list(self._store.keys())
# ============================================================================
# Database Adapter (SQLite / PostgreSQL / MySQL)
# ============================================================================
class DatabaseTurboCache:
"""
Database adapter storing TurboQuant-compressed vectors as BLOBs.
Supports SQLite (built-in), PostgreSQL (psycopg2), MySQL (mysql-connector).
Creates a table with: id TEXT PK, vector_data BLOB, metadata JSON, created_at.
"""
def __init__(self, encoder: TurboQuantEncoder,
db_url: str = "sqlite:///turboquant_vectors.db",
table_name: str = "vectors"):
self.encoder = encoder
self.table_name = table_name
self.db_url = db_url
self._conn = None
self._init_db()
def _init_db(self):
"""Initialize database connection and create table if needed."""
if self.db_url.startswith("sqlite"):
import sqlite3
db_path = self.db_url.replace("sqlite:///", "")
self._conn = sqlite3.connect(db_path)
self._db_type = "sqlite"
elif self.db_url.startswith("postgresql"):
import psycopg2
self._conn = psycopg2.connect(self.db_url)
self._db_type = "postgresql"
elif self.db_url.startswith("mysql"):
import mysql.connector
# Parse mysql://user:pass@host/db
self._conn = mysql.connector.connect(
host=self.db_url.split("@")[1].split("/")[0],
database=self.db_url.split("/")[-1],
)
self._db_type = "mysql"
else:
raise ValueError(f"Unsupported database URL: {self.db_url}")
cursor = self._conn.cursor()
blob_type = "BLOB" if self._db_type in ("sqlite", "mysql") else "BYTEA"
cursor.execute(f"""
CREATE TABLE IF NOT EXISTS {self.table_name} (
id TEXT PRIMARY KEY,
vector_data {blob_type} NOT NULL,
original_dim INTEGER,
compression_ratio REAL,
metadata TEXT,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
)
""")
self._conn.commit()
def put(self, key: str, vector: np.ndarray, metadata: Optional[dict] = None) -> dict:
"""Store a compressed vector."""
compressed = self.encoder.encode(vector)
data = compressed.to_bytes()
meta_json = json.dumps(metadata) if metadata else None
cursor = self._conn.cursor()
if self._db_type == "sqlite":
cursor.execute(
f"INSERT OR REPLACE INTO {self.table_name} "
f"(id, vector_data, original_dim, compression_ratio, metadata) "
f"VALUES (?, ?, ?, ?, ?)",
(key, data, self.encoder.dim, compressed.compression_ratio(), meta_json)
)
else:
cursor.execute(
f"INSERT INTO {self.table_name} "
f"(id, vector_data, original_dim, compression_ratio, metadata) "
f"VALUES (%s, %s, %s, %s, %s) "
f"ON CONFLICT (id) DO UPDATE SET vector_data = EXCLUDED.vector_data",
(key, data, self.encoder.dim, compressed.compression_ratio(), meta_json)
)
self._conn.commit()
return {
"key": key,
"original_bytes": len(vector) * 4,
"compressed_bytes": len(data),
"ratio": f"{(len(vector) * 4) / len(data):.1f}x",
}
def get(self, key: str) -> Optional[np.ndarray]:
"""Retrieve and decompress a vector."""
cursor = self._conn.cursor()
placeholder = "?" if self._db_type == "sqlite" else "%s"
cursor.execute(
f"SELECT vector_data FROM {self.table_name} WHERE id = {placeholder}",
(key,)
)
row = cursor.fetchone()
if row is None:
return None
compressed = CompressedVector.from_bytes(bytes(row[0]))
return self.encoder.decode(compressed)
def search(self, query: np.ndarray, k: int = 10) -> List[Tuple[str, float]]:
"""Search all stored vectors for similarity."""
query_compressed = self.encoder.encode(query)
cursor = self._conn.cursor()
cursor.execute(f"SELECT id, vector_data FROM {self.table_name}")
results = []
for row in cursor.fetchall():
doc_id = row[0]
compressed = CompressedVector.from_bytes(bytes(row[1]))
score = self.encoder.similarity(query_compressed, compressed)
results.append((doc_id, score))
results.sort(key=lambda x: x[1], reverse=True)
return results[:k]
def stats(self) -> dict:
"""Get storage statistics."""
cursor = self._conn.cursor()
cursor.execute(f"SELECT COUNT(*), AVG(compression_ratio) FROM {self.table_name}")
count, avg_ratio = cursor.fetchone()
cursor.execute(f"SELECT SUM(LENGTH(vector_data)) FROM {self.table_name}")
total_bytes = cursor.fetchone()[0] or 0
return {
"vector_count": count,
"avg_compression_ratio": f"{avg_ratio:.1f}x" if avg_ratio else "N/A",
"total_compressed_bytes": total_bytes,
}
def close(self):
if self._conn:
self._conn.close()