Skip to content

docs(indexing): add rabitq performance guide#292

Closed
BubbleCal wants to merge 1 commit into
mainfrom
codex/rabitq-improvements-blog
Closed

docs(indexing): add rabitq performance guide#292
BubbleCal wants to merge 1 commit into
mainfrom
codex/rabitq-improvements-blog

Conversation

@BubbleCal

Copy link
Copy Markdown
Contributor

Feature

What is the new feature?

  • Adds a new RaBitQ indexing guide that explains the recent IVF_RQ improvements for users: p99 latency, QPS/core, recall, serving memory, multi-bit reranking, SIMD, fast rotation, and approx_mode tradeoffs.
  • Adds SVG benchmark charts for p99 latency, QPS per core, recall, serving memory, and approx_mode modes.
  • Adds a tested Python IvfRq(num_bits=5) snippet and links the new guide from indexing navigation, indexing overview, and quantization docs.

Why do we need this feature?

  • Users evaluating IVF_RQ need a higher-level, marketing-friendly explanation of why multi-bit RaBitQ can deliver higher recall and lower tail latency without relying on raw-vector refine.
  • The page clarifies the memory tradeoff versus IVF_PQ: PQ can stay small without refine, but high recall commonly needs raw vectors in the hot serving path, while multi-bit IVF_RQ can rerank with compact quantized codes.
  • It also explains how approx_mode lets users adjust recall/performance per query instead of rebuilding indexes.

How does it work?

  • Creates docs/indexing/rabitq.mdx with benchmark tables, SVG charts, implementation explanation, query-time mode guidance, and a short IVF_RQ setup snippet.
  • Updates docs/docs.json so the page appears under Indexing.
  • Updates existing indexing and quantization docs so their RaBitQ descriptions mention multi-bit support and link to the new guide.
  • Adds a test_rabitq_create_index snippet source in tests/py/test_indexing.py and regenerates docs/snippets/indexing.mdx.

Validation

  • jq empty docs/docs.json
  • git diff --check
  • uv run pytest tests/py/test_indexing.py -k rabitq_create_index
  • uv run pytest tests/py/test_indexing.py
  • Local link/asset existence check for the new page, navigation entry, and SVGs

Mintlify validation note: mint broken-links could not be run because mint, node, npm, and npx are not installed in this environment.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview Jul 1, 2026, 8:29 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant