turboquant-db 0.1.0__tar.gz

turboquant_db-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check src/
+
+      - name: Test
+        run: pytest tests/ -x -q
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Check package
+        run: |
+          pip install twine
+          twine check dist/*

turboquant_db-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,44 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

turboquant_db-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.egg-info/
+.eggs/
+dist/
+build/
+.pytest_cache/
+.ruff_cache/
+*.pyc
+.venv/

turboquant_db-0.1.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+
+Initial release.

turboquant_db-0.1.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 msilverblatt
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

turboquant_db-0.1.0/PKG-INFO

@@ -0,0 +1,318 @@
+Metadata-Version: 2.4
+Name: turboquant-db
+Version: 0.1.0
+Summary: Lightweight embedded vector database built on TurboQuant
+Author: msilverblatt
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/msilverblatt/turbo-db
+Project-URL: Repository, https://github.com/msilverblatt/turbo-db
+Project-URL: Issues, https://github.com/msilverblatt/turbo-db/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: turboquant-py>=0.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Dynamic: license-file
+
+# turboquant-db
+
+Lightweight embedded vector database built on [turboquant-py](https://github.com/msilverblatt/turboquant-py). Drop-in replacement for ChromaDB with 16x vector compression.
+
+turboquant-db stores vectors using TurboQuant's near-optimal quantization (1-4 bits per coordinate) and metadata in SQLite. It provides a ChromaDB-compatible API with collections, metadata filtering, and concurrent read/write support — all in a few hundred lines of Python with no dependencies beyond turboquant-py and the standard library.
+
+## Installation
+
+```bash
+pip install turboquant-db
+```
+
+## Quick Start
+
+```python
+import numpy as np
+from turbodb import TurboDB
+
+db = TurboDB("./my_db")
+collection = db.create_collection("docs", dim=384)
+
+collection.add(
+    ids=["doc1", "doc2"],
+    vectors=np.random.randn(2, 384),
+    metadatas=[{"source": "wiki", "year": 2024}, {"source": "arxiv", "year": 2025}],
+)
+
+results = collection.query(vector=np.random.randn(384), k=5)
+for r in results:
+    print(f"{r.id}: {r.score:.3f} — {r.metadata}")
+```
+
+## API Reference
+
+### `TurboDB(path)`
+
+Open or create a database at the given directory path.
+
+```python
+db = TurboDB("./my_db")
+```
+
+**Methods:**
+
+| Method | Description |
+|---|---|
+| `create_collection(name, dim, metric, bit_width)` | Create a new collection |
+| `get_collection(name)` | Open an existing collection |
+| `get_or_create_collection(name, dim, metric, bit_width)` | Get or create a collection |
+| `delete_collection(name)` | Delete a collection and all its data |
+| `list_collections()` | List all collection names |
+
+---
+
+### `Collection`
+
+A named group of quantized vectors with metadata.
+
+```python
+collection = db.create_collection("docs", dim=384, metric="cosine", bit_width=2)
+```
+
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `name` | `str` | required | Collection name |
+| `dim` | `int` | required | Vector dimensionality |
+| `metric` | `str` | `"cosine"` | Distance metric: `"cosine"`, `"ip"`, or `"l2"` |
+| `bit_width` | `int` | `2` | Bits per coordinate (1-4). Lower = more compression, less accuracy |
+
+**Methods:**
+
+#### `add(ids, vectors, metadatas)`
+
+Add vectors with string IDs and metadata dicts. IDs must be unique.
+
+```python
+collection.add(
+    ids=["doc1", "doc2"],
+    vectors=np.random.randn(2, 384),
+    metadatas=[{"source": "wiki"}, {"source": "arxiv"}],
+)
+```
+
+#### `upsert(ids, vectors, metadatas)`
+
+Insert or replace vectors. If an ID already exists, its vector and metadata are replaced.
+
+```python
+collection.upsert(
+    ids=["doc1"],
+    vectors=new_vector,
+    metadatas=[{"source": "updated"}],
+)
+```
+
+#### `query(vector, k, where, format)`
+
+Search for the top-k most similar vectors, optionally filtering by metadata.
+
+```python
+results = collection.query(vector=query_vec, k=10)
+results[0].id        # "doc2"
+results[0].score     # 0.934
+results[0].metadata  # {"source": "arxiv"}
+```
+
+Returns a list of `QueryResult` objects sorted by descending score.
+
+#### `get(ids)`
+
+Retrieve metadata by IDs without performing a search.
+
+```python
+items = collection.get(ids=["doc1", "doc2"])
+# [{"id": "doc1", "position": 0, "metadata": {"source": "wiki"}}, ...]
+```
+
+#### `delete(ids, where)`
+
+Delete vectors by IDs, metadata filter, or both.
+
+```python
+collection.delete(ids=["doc1"])
+collection.delete(where={"source": {"$eq": "wiki"}})
+```
+
+#### `compact()`
+
+Rewrite storage to reclaim space from deleted vectors.
+
+```python
+collection.compact()
+```
+
+#### `count()` / `name` / `dim` / `metric`
+
+```python
+collection.count()   # number of live vectors
+collection.name      # "docs"
+collection.dim       # 384
+collection.metric    # "cosine"
+```
+
+---
+
+### `QueryResult`
+
+Frozen dataclass returned by `query()`.
+
+| Attribute | Type | Description |
+|---|---|---|
+| `id` | `str` | Vector ID |
+| `score` | `float` | Similarity score (higher = more similar for cosine/ip) |
+| `metadata` | `dict` | Associated metadata |
+
+---
+
+### ChromaDB compatibility
+
+Pass `format="chroma"` to get results in ChromaDB's column-oriented format:
+
+```python
+results = collection.query(vector=query_vec, k=10, format="chroma")
+results["ids"][0]        # ["doc2", "doc5", ...]
+results["distances"][0]  # [0.934, 0.891, ...]
+results["metadatas"][0]  # [{"source": "arxiv"}, ...]
+```
+
+This makes migration straightforward — change the import, update the constructor, and add `format="chroma"` to your query calls. Remove `format="chroma"` at your own pace.
+
+## Metadata Filtering
+
+Filter syntax matches ChromaDB and Pinecone conventions:
+
+```python
+# Comparison operators
+collection.query(vector=v, k=10, where={"year": {"$eq": 2025}})
+collection.query(vector=v, k=10, where={"year": {"$ne": 2024}})
+collection.query(vector=v, k=10, where={"year": {"$gt": 2023}})
+collection.query(vector=v, k=10, where={"year": {"$gte": 2024}})
+collection.query(vector=v, k=10, where={"year": {"$lt": 2026}})
+collection.query(vector=v, k=10, where={"year": {"$lte": 2025}})
+
+# Set operators
+collection.query(vector=v, k=10, where={"source": {"$in": ["wiki", "arxiv"]}})
+collection.query(vector=v, k=10, where={"source": {"$nin": ["blog"]}})
+
+# Logical combinators
+collection.query(vector=v, k=10, where={
+    "$and": [
+        {"year": {"$gte": 2024}},
+        {"source": {"$eq": "arxiv"}},
+    ]
+})
+
+collection.query(vector=v, k=10, where={
+    "$or": [
+        {"source": {"$eq": "wiki"}},
+        {"year": {"$gt": 2024}},
+    ]
+})
+```
+
+Multiple top-level fields are implicitly ANDed:
+
+```python
+# Equivalent to $and
+collection.query(vector=v, k=10, where={"year": {"$gte": 2024}, "source": {"$eq": "arxiv"}})
+```
+
+## Distance Metrics
+
+| Metric | Description | Score interpretation |
+|---|---|---|
+| `cosine` (default) | Cosine similarity | 1.0 = identical, 0.0 = orthogonal |
+| `ip` | Inner product | Higher = more similar |
+| `l2` | Squared L2 distance | Lower = more similar |
+
+All metrics use TurboQuant's inner-product quantizer under the hood. Cosine normalizes vectors on add; L2 is computed from stored norms and inner products.
+
+## Compression
+
+turbo-db compresses vectors using TurboQuant's Lloyd-Max quantization with random orthogonal rotation:
+
+| Bit-width | Compression ratio | Use case |
+|---|---|---|
+| 1 | 32x | Maximum compression, rough similarity |
+| 2 (default) | 16x | Good balance of quality and size |
+| 3 | 10.7x | Higher accuracy |
+| 4 | 8x | Near-lossless similarity search |
+
+At the default 2-bit setting, a collection of 1M 384-dimensional vectors uses ~9.6 MB for vector data, compared to ~1.5 GB uncompressed.
+
+## Storage
+
+Each database is a directory. Each collection is a subdirectory:
+
+```
+my_db/
+├── docs/
+│   ├── vectors/        # Quantized vectors (numpy arrays)
+│   ├── metadata.db     # SQLite: IDs, metadata, positions
+│   └── lock            # Write lock file
+├── embeddings/
+│   └── ...
+└── turbodb.json        # Database config
+```
+
+Metadata is stored in SQLite with WAL mode for concurrent read/write access. Vector data uses turboquant-py's bit-packed numpy format.
+
+## Concurrency
+
+- **Multiple readers + one writer**: SQLite WAL mode allows concurrent reads during writes
+- **Write serialization**: File locking ensures one write operation at a time per collection
+- **Crash safety**: Vectors are written before metadata is committed. On restart, orphaned vectors are automatically trimmed to match SQLite state
+
+## Migrating from ChromaDB
+
+```python
+# Before (ChromaDB)
+import chromadb
+client = chromadb.PersistentClient(path="./db")
+collection = client.create_collection("docs")
+collection.add(ids=["a"], embeddings=[[1, 2, 3]], metadatas=[{"k": "v"}])
+results = collection.query(query_embeddings=[[1, 2, 3]], n_results=5)
+
+# After (turboquant-db)
+from turbodb import TurboDB
+db = TurboDB("./db")
+collection = db.create_collection("docs", dim=3)
+collection.add(ids=["a"], vectors=[[1, 2, 3]], metadatas=[{"k": "v"}])
+results = collection.query(vector=[1, 2, 3], k=5)
+# Or with Chroma-compat format:
+results = collection.query(vector=[1, 2, 3], k=5, format="chroma")
+```
+
+Key differences:
+- `embeddings` → `vectors`
+- `query_embeddings` → `vector` (single vector, not nested list)
+- `n_results` → `k`
+- `dim` is required on `create_collection`
+- Results are `QueryResult` objects by default (use `format="chroma"` for column dicts)
+
+## References
+
+- **TurboQuant:** [arXiv:2504.19874](https://arxiv.org/abs/2504.19874)
+- **QJL:** [arXiv:2406.03482](https://arxiv.org/abs/2406.03482)
+- **turboquant-py:** [github.com/msilverblatt/turboquant-py](https://github.com/msilverblatt/turboquant-py)