Class Lucene102BinaryQuantizedVectorsFormat
java.lang.Object
org.apache.lucene.codecs.KnnVectorsFormat
org.apache.lucene.codecs.hnsw.FlatVectorsFormat
org.apache.lucene.codecs.lucene102.Lucene102BinaryQuantizedVectorsFormat
- All Implemented Interfaces:
NamedSPILoader.NamedSPI
The binary quantization format used here is a per-vector optimized scalar quantization. These
ideas are evolutions of LVQ proposed in Similarity
search in the blink of an eye with compressed indices by Cecilia Aguerrebere et al., the
previous work on globally optimized scalar quantization in Apache Lucene, and Accelerating Large-Scale Inference with Anisotropic
Vector Quantization by Ruiqi Guo et. al. Also see
OptimizedScalarQuantizer
. Some of key features are:
- Estimating the distance between two vectors using their centroid centered distance. This requires some additional corrective factors, but allows for centroid centering to occur.
- Optimized scalar quantization to single bit level of centroid centered vectors.
- Asymmetric quantization of vectors, where query vectors are quantized to half-byte (4 bits) precision (normalized to the centroid) and then compared directly against the single bit quantized vectors in the index.
- Transforming the half-byte quantized query vectors in such a way that the comparison with single bit vectors can be done with bit arithmetic.
The format is stored within two files:
.veb (vector data) file
Stores the binary quantized vectors in a flat format. Additionally, it stores each vector's corrective factors. At the end of the file, additional information is stored for vector ordinal to centroid ordinal mapping and sparse vector information.
- For each vector:
- [byte] the binary quantized values, each byte holds 8 bits.
- [float] the optimized quantiles and an additional similarity dependent corrective factor.
- short the sum of the quantized components
- After the vectors, sparse vector information keeping track of monotonic blocks.
.vemb (vector metadata) file
Stores the metadata for the vectors. This includes the number of vectors, the number of dimensions, and file offset information.
- int the field number
- int the vector encoding ordinal
- int the vector similarity ordinal
- vint the vector dimensions
- vlong the offset to the vector data in the .veb file
- vlong the length of the vector data in the .veb file
- vint the number of vectors
- [float] the centroid
- float the centroid square magnitude
- The sparse vector information, if required, mapping vector ordinal to doc ID
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final byte
static final String
static final byte
Fields inherited from class org.apache.lucene.codecs.KnnVectorsFormat
DEFAULT_MAX_DIMENSIONS, EMPTY
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance with the default number of vectors per cluster. -
Method Summary
Modifier and TypeMethodDescriptionfieldsReader
(SegmentReadState state) Returns aKnnVectorsReader
to read the vectors from the index.fieldsWriter
(SegmentWriteState state) Returns aFlatVectorsWriter
to write the vectors to the index.int
getMaxDimensions
(String fieldName) Returns the maximum number of vector dimensions supported by this codec for the given field nametoString()
Methods inherited from class org.apache.lucene.codecs.KnnVectorsFormat
availableKnnVectorsFormats, forName, getName, reloadKnnVectorsFormat
-
Field Details
-
QUERY_BITS
public static final byte QUERY_BITS- See Also:
-
INDEX_BITS
public static final byte INDEX_BITS- See Also:
-
BINARIZED_VECTOR_COMPONENT
- See Also:
-
NAME
- See Also:
-
-
Constructor Details
-
Lucene102BinaryQuantizedVectorsFormat
public Lucene102BinaryQuantizedVectorsFormat()Creates a new instance with the default number of vectors per cluster.
-
-
Method Details
-
fieldsWriter
Description copied from class:FlatVectorsFormat
Returns aFlatVectorsWriter
to write the vectors to the index.- Specified by:
fieldsWriter
in classFlatVectorsFormat
- Throws:
IOException
-
fieldsReader
Description copied from class:FlatVectorsFormat
Returns aKnnVectorsReader
to read the vectors from the index.- Specified by:
fieldsReader
in classFlatVectorsFormat
- Throws:
IOException
-
getMaxDimensions
Description copied from class:KnnVectorsFormat
Returns the maximum number of vector dimensions supported by this codec for the given field nameCodecs implement this method to specify the maximum number of dimensions they support.
- Overrides:
getMaxDimensions
in classFlatVectorsFormat
- Parameters:
fieldName
- the field name- Returns:
- the maximum number of vector dimensions.
-
toString
-