fromscratch-pyvecdb 0.3.0__tar.gz

fromscratch_pyvecdb-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+    uses: robcox2910/robcox2910.github.io/.github/workflows/python-ci.yml@v1

fromscratch_pyvecdb-0.3.0/.github/workflows/docs.yml

@@ -0,0 +1,16 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch: {}
+
+jobs:
+  docs:
+    uses: robcox2910/robcox2910.github.io/.github/workflows/docs.yml@v1
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    with:
+      coverage-report: false

fromscratch_pyvecdb-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.14
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+      - name: Upload to GitHub Release
+        uses: softprops/action-gh-release@v3
+        with:
+          files: dist/*
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/fromscratch-pyvecdb/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

fromscratch_pyvecdb-0.3.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.pyc
+.venv/
+*.egg-info/
+dist/
+build/
+.coverage
+htmlcov/
+.ruff_cache/
+_version.py
+.hypothesis/

fromscratch_pyvecdb-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+default_language_version:
+  python: python3.14
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # Pages paste real pytest output, trailing spaces included.
+      - id: trailing-whitespace
+        exclude: ^docs/property-testing\.md$
+      - id: end-of-file-fixer
+        exclude: ^docs/property-testing\.md$
+      - id: check-yaml
+        args: ['--unsafe']
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.408
+    hooks:
+      - id: pyright
+
+  - repo: local
+    hooks:
+      - id: pip-audit
+        name: pip-audit
+        language: system
+        pass_filenames: false
+        files: ^(pyproject\.toml|uv\.lock)$
+        entry: >-
+          bash -c 'f=$(mktemp) &&
+          uv export --frozen --no-emit-project --all-extras --no-hashes -o "$f" >/dev/null &&
+          uvx pip-audit==2.10.0 -r "$f" --disable-pip --no-deps;
+          status=$?; rm -f "$f"; exit $status'
+
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.13.8
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+        additional_dependencies: [typing_extensions]

fromscratch_pyvecdb-0.3.0/CLAUDE.md

@@ -0,0 +1,52 @@
+# Claude Code Instructions
+
+<!-- standard:start -->
+## Code Style
+
+- All public functions, methods, classes, and modules **must** have a docstring
+- Use imperative mood: "Return the result." not "Returns the result."
+- One-line docstrings for simple functions; multi-line with summary + details for complex ones
+- Follow the Google docstring convention (D211, D212 selected via ruff)
+
+## Linting
+
+- Ruff enforces a comprehensive rule set -- run `uv run ruff check .` before committing
+- Pyright runs in strict mode -- run `uv run pyright src tests` before committing
+- All violations must be fixed, not ignored. Exceptions are the repo-owned `ignore` and `per-file-ignores` lists in `pyproject.toml`, which belong to this repo; the series sync never edits them
+
+## Testing
+
+- TDD workflow: Red-Green-Refactor
+- Coverage is enforced by pytest-cov; the floor in `pyproject.toml` is repo-owned
+- Test classes and methods also require docstrings
+- Use named constants instead of magic values (PLR2004)
+- Run `uv run pytest` before committing
+- Property-based tests (Hypothesis) live in `tests/test_properties.py` and `tests/test_model.py`; the shared profiles are in the root `conftest.py` (owned by `series sync`). Run `uv run pytest --hypothesis-profile=thorough` before a release.
+
+## Commits
+
+- Use conventional commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `ci:`, `chore:`
+- All changes go via PR from a feature branch (main is protected); merge when CI is green
+
+## Dependencies
+
+- Package manager: uv
+- Run `uv sync --all-extras` after modifying dependencies
+- `uv.lock` is committed; CI and pre-commit audit it with pip-audit through `uvx`, so pip-audit is not a project dependency
+- Sibling projects, where used, are pinned release tags in `[tool.uv.sources]` (git + tag); never use `path` sources
+
+## Releasing
+
+- A release is a `vX.Y.Z` tag on main after the PR is merged
+- Docs-only and tooling-only changes do not get a release tag
+- Docs are built with `mkdocs build --strict` and deployed to GitHub Pages by the docs workflow
+<!-- standard:end -->
+
+## Project notes
+
+- Pyright in strict mode -- run `uv run pyright src tests` before committing
+- All violations must be fixed, not ignored (except D203/D213 incompatible pair)
+- Minimum 90% coverage enforced by pytest-cov
+- Use conventional commits (enforced by commitizen): `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `ci:`, `chore:`
+- All changes go via PR from a feature branch (main is protected)
+- Add production deps to `[project.dependencies]`

fromscratch_pyvecdb-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rob Cox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fromscratch_pyvecdb-0.3.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.5
+Name: fromscratch-pyvecdb
+Version: 0.3.0
+Summary: An educational vector database library built from scratch in Python
+Project-URL: Homepage, https://github.com/robcox2910/pyvecdb
+Project-URL: Repository, https://github.com/robcox2910/pyvecdb
+Project-URL: Issues, https://github.com/robcox2910/pyvecdb/issues
+Project-URL: Documentation, https://robcox2910.github.io/pyvecdb/
+Author: Rob Cox
+License: MIT
+License-File: LICENSE
+Keywords: database,education,search,similarity,vector
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Provides-Extra: dev
+Requires-Dist: commitizen>=4.4.0; extra == 'dev'
+Requires-Dist: hypothesis>=6.170; extra == 'dev'
+Requires-Dist: pip-audit>=2.10.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.0.1; extra == 'dev'
+Requires-Dist: pyright>=1.1.400; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.4; extra == 'dev'
+Requires-Dist: ruff>=0.9.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyvecdb
+
+An educational vector database library built from scratch in Python. Part of the **PyLearn** platform for kids aged 12+.
+
+## What is a Vector Database?
+
+A vector database stores **vectors** (lists of numbers) and finds **similar** ones. Think of it like a music app that turns songs into lists of numbers and finds other songs with similar numbers!
+
+## Features
+
+- **Vector Operations** -- add, subtract, scale, normalize, dot product, magnitude
+- **Vector Store** -- CRUD operations for vector records with dimensionality checks
+- **Distance Metrics** -- cosine similarity, Euclidean, Manhattan, dot product
+- **KNN Search** -- find the K most similar vectors to a query
+- **Metadata Filtering** -- filter results by metadata (eq, ne, gt, gte, lt, lte, in)
+- **Batch Operations** -- insert and search multiple vectors at once
+- **Persistence** -- save/load to JSON files
+- **Pure Python** -- no external dependencies
+
+## Quick Start
+
+```python
+from pyvecdb import VectorStore, knn_search
+
+# Create a store for 3-dimensional vectors
+store = VectorStore(dimensions=3)
+
+# Insert some songs as vectors (energy, happiness, danceability)
+store.insert("thunder", [0.9, 0.6, 0.7], metadata={"genre": "rock", "year": 2017})
+store.insert("lullaby", [0.1, 0.8, 0.2], metadata={"genre": "folk", "year": 2020})
+store.insert("party-rock", [0.95, 0.9, 0.99], metadata={"genre": "pop", "year": 2011})
+store.insert("ballad", [0.3, 0.4, 0.1], metadata={"genre": "rock", "year": 2019})
+
+# Find the 2 most similar songs to a high-energy query
+results = knn_search(store, query=[0.85, 0.7, 0.8], k=2)
+for record, score in results:
+    print(f"{record.record_id}: {score:.3f}")
+# party-rock: 0.998
+# thunder: 0.995
+
+# Filter by metadata -- only rock songs
+results = knn_search(
+    store,
+    query=[0.85, 0.7, 0.8],
+    k=2,
+    metadata_filter={"genre": "rock"},
+)
+```
+
+## Installation
+
+```bash
+git clone https://github.com/robcox2910/pyvecdb.git
+cd pyvecdb
+uv sync --all-extras
+```
+
+## Development
+
+```bash
+uv run ruff check src/ tests/      # Lint
+uv run ruff format src/ tests/      # Format
+uv run pyright src tests            # Type check
+uv run pytest                       # Test (90%+ coverage)
+```
+
+## Releasing
+
+Other projects in the series ([PyStack](https://github.com/robcox2910/pystack)) use a pinned release of this one,
+not whatever is on `main`. To publish a change for them:
+
+1. Merge the change to `main`.
+2. Tag it: `git tag -a vX.Y.Z -m vX.Y.Z && git push origin vX.Y.Z`.
+   A change to the public API bumps the minor version (`v0.1.0` → `v0.2.0`);
+   anything else bumps the patch (`v0.1.0` → `v0.1.1`).
+3. In each project that uses it, edit the tag in `[tool.uv.sources]`, run
+   `uv lock --upgrade-package <name>`, and open a pull request so CI checks
+   the pair together.
+
+<!-- series:start -->
+## Related Projects
+
+This project is one of a series that builds real systems "from scratch in Python" to teach how they work. See the [series home](https://robcox2910.github.io/) for the full story.
+
+| Project | What it teaches | Repository | Docs |
+| --- | --- | --- | --- |
+| PyOS | Operating systems | [py-os](https://github.com/robcox2910/py-os) | [Docs](https://robcox2910.github.io/py-os/) |
+| Pebble | Compilers and programming languages | [pebble-lang](https://github.com/robcox2910/pebble-lang) | [Docs](https://robcox2910.github.io/pebble-lang/) |
+| PyDB | Relational databases | [pydb](https://github.com/robcox2910/pydb) | [Docs](https://robcox2910.github.io/pydb/) |
+| PyKV | Key-value stores | [pykv](https://github.com/robcox2910/pykv) | [Docs](https://robcox2910.github.io/pykv/) |
+| PyDocDB | Document databases | [pydoc-db](https://github.com/robcox2910/pydoc-db) | [Docs](https://robcox2910.github.io/pydoc-db/) |
+| PyGraphDB | Graph databases | [pygraphdb](https://github.com/robcox2910/pygraphdb) | [Docs](https://robcox2910.github.io/pygraphdb/) |
+| PyTSDB | Time-series databases | [pytsdb](https://github.com/robcox2910/pytsdb) | [Docs](https://robcox2910.github.io/pytsdb/) |
+| **PyVecDB** | **Vector databases** | [pyvecdb](https://github.com/robcox2910/pyvecdb) | [Docs](https://robcox2910.github.io/pyvecdb/) |
+| PyColDB | Column-family databases | [pycoldb](https://github.com/robcox2910/pycoldb) | [Docs](https://robcox2910.github.io/pycoldb/) |
+| PyCrypt | Cryptography | [pycrypt](https://github.com/robcox2910/pycrypt) | [Docs](https://robcox2910.github.io/pycrypt/) |
+| PyNet | Computer networking | [pynet](https://github.com/robcox2910/pynet) | [Docs](https://robcox2910.github.io/pynet/) |
+| PyWeb | HTTP web servers | [pyweb](https://github.com/robcox2910/pyweb) | [Docs](https://robcox2910.github.io/pyweb/) |
+| PyGit | Version control | [pygit](https://github.com/robcox2910/pygit) | [Docs](https://robcox2910.github.io/pygit/) |
+| PySearch | Search engines | [pysearch](https://github.com/robcox2910/pysearch) | [Docs](https://robcox2910.github.io/pysearch/) |
+| PyMQ | Message queues | [pymq](https://github.com/robcox2910/pymq) | [Docs](https://robcox2910.github.io/pymq/) |
+| PyLLM | Language models (the brain) | [pyllm](https://github.com/robcox2910/pyllm) | [Docs](https://robcox2910.github.io/pyllm/) |
+| PyScheduler | Job scheduling | [pyscheduler](https://github.com/robcox2910/pyscheduler) | [Docs](https://robcox2910.github.io/pyscheduler/) |
+| PyStack | Full-stack integration | [pystack](https://github.com/robcox2910/pystack) | [Docs](https://robcox2910.github.io/pystack/) |
+<!-- series:end -->
+
+<!-- docs:start -->
+## Documentation
+
+Full docs (with kid-friendly explanations of every idea): https://robcox2910.github.io/pyvecdb/
+<!-- docs:end -->
+
+## License
+
+MIT

fromscratch_pyvecdb-0.3.0/README.md

@@ -0,0 +1,115 @@
+# pyvecdb
+
+An educational vector database library built from scratch in Python. Part of the **PyLearn** platform for kids aged 12+.
+
+## What is a Vector Database?
+
+A vector database stores **vectors** (lists of numbers) and finds **similar** ones. Think of it like a music app that turns songs into lists of numbers and finds other songs with similar numbers!
+
+## Features
+
+- **Vector Operations** -- add, subtract, scale, normalize, dot product, magnitude
+- **Vector Store** -- CRUD operations for vector records with dimensionality checks
+- **Distance Metrics** -- cosine similarity, Euclidean, Manhattan, dot product
+- **KNN Search** -- find the K most similar vectors to a query
+- **Metadata Filtering** -- filter results by metadata (eq, ne, gt, gte, lt, lte, in)
+- **Batch Operations** -- insert and search multiple vectors at once
+- **Persistence** -- save/load to JSON files
+- **Pure Python** -- no external dependencies
+
+## Quick Start
+
+```python
+from pyvecdb import VectorStore, knn_search
+
+# Create a store for 3-dimensional vectors
+store = VectorStore(dimensions=3)
+
+# Insert some songs as vectors (energy, happiness, danceability)
+store.insert("thunder", [0.9, 0.6, 0.7], metadata={"genre": "rock", "year": 2017})
+store.insert("lullaby", [0.1, 0.8, 0.2], metadata={"genre": "folk", "year": 2020})
+store.insert("party-rock", [0.95, 0.9, 0.99], metadata={"genre": "pop", "year": 2011})
+store.insert("ballad", [0.3, 0.4, 0.1], metadata={"genre": "rock", "year": 2019})
+
+# Find the 2 most similar songs to a high-energy query
+results = knn_search(store, query=[0.85, 0.7, 0.8], k=2)
+for record, score in results:
+    print(f"{record.record_id}: {score:.3f}")
+# party-rock: 0.998
+# thunder: 0.995
+
+# Filter by metadata -- only rock songs
+results = knn_search(
+    store,
+    query=[0.85, 0.7, 0.8],
+    k=2,
+    metadata_filter={"genre": "rock"},
+)
+```
+
+## Installation
+
+```bash
+git clone https://github.com/robcox2910/pyvecdb.git
+cd pyvecdb
+uv sync --all-extras
+```
+
+## Development
+
+```bash
+uv run ruff check src/ tests/      # Lint
+uv run ruff format src/ tests/      # Format
+uv run pyright src tests            # Type check
+uv run pytest                       # Test (90%+ coverage)
+```
+
+## Releasing
+
+Other projects in the series ([PyStack](https://github.com/robcox2910/pystack)) use a pinned release of this one,
+not whatever is on `main`. To publish a change for them:
+
+1. Merge the change to `main`.
+2. Tag it: `git tag -a vX.Y.Z -m vX.Y.Z && git push origin vX.Y.Z`.
+   A change to the public API bumps the minor version (`v0.1.0` → `v0.2.0`);
+   anything else bumps the patch (`v0.1.0` → `v0.1.1`).
+3. In each project that uses it, edit the tag in `[tool.uv.sources]`, run
+   `uv lock --upgrade-package <name>`, and open a pull request so CI checks
+   the pair together.
+
+<!-- series:start -->
+## Related Projects
+
+This project is one of a series that builds real systems "from scratch in Python" to teach how they work. See the [series home](https://robcox2910.github.io/) for the full story.
+
+| Project | What it teaches | Repository | Docs |
+| --- | --- | --- | --- |
+| PyOS | Operating systems | [py-os](https://github.com/robcox2910/py-os) | [Docs](https://robcox2910.github.io/py-os/) |
+| Pebble | Compilers and programming languages | [pebble-lang](https://github.com/robcox2910/pebble-lang) | [Docs](https://robcox2910.github.io/pebble-lang/) |
+| PyDB | Relational databases | [pydb](https://github.com/robcox2910/pydb) | [Docs](https://robcox2910.github.io/pydb/) |
+| PyKV | Key-value stores | [pykv](https://github.com/robcox2910/pykv) | [Docs](https://robcox2910.github.io/pykv/) |
+| PyDocDB | Document databases | [pydoc-db](https://github.com/robcox2910/pydoc-db) | [Docs](https://robcox2910.github.io/pydoc-db/) |
+| PyGraphDB | Graph databases | [pygraphdb](https://github.com/robcox2910/pygraphdb) | [Docs](https://robcox2910.github.io/pygraphdb/) |
+| PyTSDB | Time-series databases | [pytsdb](https://github.com/robcox2910/pytsdb) | [Docs](https://robcox2910.github.io/pytsdb/) |
+| **PyVecDB** | **Vector databases** | [pyvecdb](https://github.com/robcox2910/pyvecdb) | [Docs](https://robcox2910.github.io/pyvecdb/) |
+| PyColDB | Column-family databases | [pycoldb](https://github.com/robcox2910/pycoldb) | [Docs](https://robcox2910.github.io/pycoldb/) |
+| PyCrypt | Cryptography | [pycrypt](https://github.com/robcox2910/pycrypt) | [Docs](https://robcox2910.github.io/pycrypt/) |
+| PyNet | Computer networking | [pynet](https://github.com/robcox2910/pynet) | [Docs](https://robcox2910.github.io/pynet/) |
+| PyWeb | HTTP web servers | [pyweb](https://github.com/robcox2910/pyweb) | [Docs](https://robcox2910.github.io/pyweb/) |
+| PyGit | Version control | [pygit](https://github.com/robcox2910/pygit) | [Docs](https://robcox2910.github.io/pygit/) |
+| PySearch | Search engines | [pysearch](https://github.com/robcox2910/pysearch) | [Docs](https://robcox2910.github.io/pysearch/) |
+| PyMQ | Message queues | [pymq](https://github.com/robcox2910/pymq) | [Docs](https://robcox2910.github.io/pymq/) |
+| PyLLM | Language models (the brain) | [pyllm](https://github.com/robcox2910/pyllm) | [Docs](https://robcox2910.github.io/pyllm/) |
+| PyScheduler | Job scheduling | [pyscheduler](https://github.com/robcox2910/pyscheduler) | [Docs](https://robcox2910.github.io/pyscheduler/) |
+| PyStack | Full-stack integration | [pystack](https://github.com/robcox2910/pystack) | [Docs](https://robcox2910.github.io/pystack/) |
+<!-- series:end -->
+
+<!-- docs:start -->
+## Documentation
+
+Full docs (with kid-friendly explanations of every idea): https://robcox2910.github.io/pyvecdb/
+<!-- docs:end -->
+
+## License
+
+MIT

fromscratch_pyvecdb-0.3.0/conftest.py

@@ -0,0 +1,21 @@
+"""Shared Hypothesis profiles for the series.
+
+Two profiles are registered, and ``ci`` is loaded by default:
+
+- ``ci`` runs 100 examples with no deadline, a fixed seed and no example
+  database, so the same code gives the same result on every machine and a
+  green build can be trusted.
+- ``thorough`` runs 2000 examples with a random seed, to hunt for the rare
+  counterexample before a release.
+
+Run the long one with ``uv run pytest --hypothesis-profile=thorough``.
+
+This file is owned by ``series sync``. Edit it in the series home repo
+(robcox2910.github.io), not here, or the next sync will put it back.
+"""
+
+from hypothesis import settings
+
+settings.register_profile("ci", max_examples=100, deadline=None, derandomize=True, database=None)
+settings.register_profile("thorough", max_examples=2000, deadline=None, derandomize=False)
+settings.load_profile("ci")

fromscratch_pyvecdb-0.3.0/docs/concepts/distance.md

@@ -0,0 +1,66 @@
+# Distance: How Far Apart Are Two Spots?
+
+## The Big Idea
+
+If vectors are points on a map, **distance** tells you how far apart two points are. There are different ways to measure "how far" -- just like there are different ways to get across town!
+
+## Four Ways to Measure Distance
+
+### 1. Euclidean Distance (Straight Line)
+
+This is the "as the crow flies" distance -- a straight line between two points. It uses the Pythagorean theorem extended to any number of dimensions.
+
+```python
+from pyvecdb import euclidean_distance
+euclidean_distance([0.0, 0.0], [3.0, 4.0])  # 5.0
+```
+
+**When to use**: When you care about the actual magnitude of differences.
+
+### 2. Cosine Similarity (Direction Only)
+
+Cosine similarity ignores how long the vectors are and only checks if they point the same direction. It returns a number from -1 to 1:
+- **1.0** = pointing the same way (identical taste!)
+- **0.0** = perpendicular (completely unrelated)
+- **-1.0** = pointing opposite ways (opposite taste!)
+
+```python
+from pyvecdb import cosine_similarity
+cosine_similarity([1.0, 0.0], [1.0, 0.0])  # 1.0 (same!)
+cosine_similarity([1.0, 0.0], [0.0, 1.0])  # 0.0 (unrelated)
+```
+
+**When to use**: Most popular for AI embeddings. This is the default in pyvecdb!
+
+### 3. Manhattan Distance (City Blocks)
+
+Imagine walking through a city grid -- you can only go along streets, not diagonally through buildings. Manhattan distance counts the total blocks walked.
+
+```python
+from pyvecdb import manhattan_distance
+manhattan_distance([0.0, 0.0], [3.0, 4.0])  # 7.0 (3 + 4 blocks)
+```
+
+**When to use**: When dimensions are independent (like different categories).
+
+### 4. Dot Product (Agreement Score)
+
+The dot product multiplies matching components and adds them up. Bigger numbers mean more "agreement."
+
+```python
+from pyvecdb import dot_product
+dot_product([1.0, 2.0, 3.0], [4.0, 5.0, 6.0])  # 32.0
+```
+
+**When to use**: When vector length matters (not just direction).
+
+## Which One Should I Use?
+
+| Metric | Best For | Range |
+|--------|----------|-------|
+| Cosine | AI embeddings, text | -1 to 1 |
+| Euclidean | Physical distance | 0 to infinity |
+| Manhattan | Grid-like data | 0 to infinity |
+| Dot Product | When magnitude matters | -infinity to infinity |
+
+For most AI applications, **cosine similarity** is the go-to choice!