Skip to main content

Reserved package name

Project description

The RaBitQ Library

New: We have recently open-sourced the GPU implementation of RaBitQ for high-dimensional vector search. See cuvs_rabitq.

The RaBitQ Library provides efficient and lightweight implementations of the RaBitQ quantization algorithm (1-bit version and multi-bit version) and its applications in high-dimensional vector search. It also provides a GPU implementation. The core algorithm RaBitQ is based on the research from VectorDB group at Nanyang Technological University, Singapore.

The library is developped by Yutong Gou, Jianyang Gao, Yuexuan Xu, Jifan Shi and Zhonghao Yang.

The library provides the following key features:

  • RaBitQ - a vector quantization algorithm as a drop-in replacement of binary and scalar quantization, offering an optimal theoretical error bound
  • RaBitQ for Vector Search - a reference implementation of RaBitQ's combination with popular vector search indexes

RaBitQLib supports estimating similarity metrics including Euclidean distance, inner product and cosine similarity.

RaBitQ

RaBitQ is a vector quantization algorithm as a drop-in replacement of binary and scalar quantization. The key advantages of RaBitQ include

  • High Accuracy with Tiny Space - RaBitQ achieves the state-of-the-art accuracy under diverse bit-width for the estimation of similarity metrics. It produces promising accuracy with even 1-bit per dimension.
  • Fast Distance Estimation - RaBitQ supports to estimate the similarity metrics with high efficiency based on bitwise operations or FastScan.
  • Theoretical Error Bound - RaBitQ provides an asymptotically optimal error bound for the estimation of distances and inner product. The error bound can be used for reliable ordering and reranking.

In this library, we provide simple interfaces to support advanced features of RaBitQ. The details are presented in the documentation.

RaBitQ for Vector Search

In the library, RaBitQ is combined with IVF, HNSW and QG to deliever different trade-offs among time, space and accuracy.

Using RaBitQ with IVF and HNSW targets a balance between memory consumption and query performance. Only the quantization codes produced by RaBitQ are stored and the raw data vectors are not accessed during querying. Thus, these methods consume less memory than the raw dataset. Using 4-bit, 5-bit and 7-bit quantization usually suffices to produce 90%, 95% and 99% recall respectively without reranking.

Using RaBitQ with QG targets the best query performance by using more memory. It creates multiple quantization codes for every vector to optimize the data access pattern. Thus, QG usually consumes 2x memory of the raw dataset.

RaBitQ in Industry

The RaBitQ algorithm has been implemented in many real-world systems in industry including

  • Milvus - IVF + RaBitQ (C++)
  • Faiss - IVF + RaBitQ (C++)
  • VSAG - HGraph + RaBitQ (C++)
  • VectorChord - IVF + RaBitQ (Rust)
  • Volcengine OpenSearch - DiskANN + RaBitQ
  • CockroachDB - CSPANN + RaBitQ (Golang)
  • ElasticSearch - HNSW + RaBitQ (Java - the algorithm is adopted with some minor modifications and renamed as "BBQ")
  • Lucene - HNSW + RaBitQ (Java - the algorithm is adopted with some minor modifications and renamed as "BBQ")
  • turbopuffer - SPFresh + RaBitQ

Acknowledgement

We acknowledge Alexandr Guzhva, Li Liu, Chao Gao, Silu Huang, Jiabao Jin, Xiaoyao Zhong and Jinjing Zhou for valuable feedbacks.

Reference

Please provide a reference of our paper if it helps in your systems or research projects.

Jianyang Gao, Yutong Gou, Yuexuan Xu, Yongyi Yang, Cheng Long, Raymond Chi-Wing Wong, 
"Practical and Asymptotically Optimal Quantization of High-Dimensional Vectors in Euclidean Space for Approximate Nearest Neighbor Search", 
SIGMOD 2025, available at https://arxiv.org/abs/2409.09913

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rabitq-0.0.1.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rabitq-0.0.1-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file rabitq-0.0.1.tar.gz.

File metadata

  • Download URL: rabitq-0.0.1.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for rabitq-0.0.1.tar.gz
Algorithm Hash digest
SHA256 e4f2405d08389212e358eb1e65c1f2fb450c217e78ba52f4fa59cfbd7dac1516
MD5 95f1e113f7d90789239e287168f357f9
BLAKE2b-256 07e79f03c5f806cad597681da5706e02114bccc4c5bba87b8d1e589a90a8b2fd

See more details on using hashes here.

File details

Details for the file rabitq-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: rabitq-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for rabitq-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6bc61bc43c53349f38d9d8addf4f21c3be967060803fa68c32d4783a4a7a8fb6
MD5 2e64d72229cbb3d99cb36a4c08ff50d1
BLAKE2b-256 3f1c27ff99ef2098aa252d40d0a3aafc0d6e50f34ca608a2b1f167632804cf93

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page