-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new dynamic confidence interval configuration to scalar quantized…
… format (#13445) When int4 scalar quantization was merged, it added a new way to dynamically calculate quantiles. However, when that was merged, I inadvertently changed the default behavior, where a null confidenceInterval would actually calculate the dynamic quantiles instead of doing the previous auto-setting to 1 - 1/(dim + 1). This commit formalizes the dynamic quantile calculate through setting the confidenceInterval to 0, and preserves the previous behavior for null confidenceIntervals so that users upgrading will not see different quantiles than they would expect.
- Loading branch information
Showing
8 changed files
with
172 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
.../src/test/org/apache/lucene/codecs/lucene99/TestLucene99ScalarQuantizedVectorsWriter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. | ||
| */ | ||
|
|
||
| package org.apache.lucene.codecs.lucene99; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import org.apache.lucene.index.FloatVectorValues; | ||
| import org.apache.lucene.index.VectorSimilarityFunction; | ||
| import org.apache.lucene.tests.util.LuceneTestCase; | ||
| import org.apache.lucene.util.quantization.ScalarQuantizer; | ||
|
|
||
| public class TestLucene99ScalarQuantizedVectorsWriter extends LuceneTestCase { | ||
|
|
||
| public void testBuildScalarQuantizerCosine() throws IOException { | ||
| assertScalarQuantizer( | ||
| new float[] {0.3234983f, 0.6236096f}, 0.9f, (byte) 7, VectorSimilarityFunction.COSINE); | ||
| assertScalarQuantizer( | ||
| new float[] {0.28759837f, 0.62449116f}, 0f, (byte) 7, VectorSimilarityFunction.COSINE); | ||
| assertScalarQuantizer( | ||
| new float[] {0.3234983f, 0.6236096f}, 0.9f, (byte) 4, VectorSimilarityFunction.COSINE); | ||
| assertScalarQuantizer( | ||
| new float[] {0.37247902f, 0.58848244f}, 0f, (byte) 4, VectorSimilarityFunction.COSINE); | ||
| } | ||
|
|
||
| public void testBuildScalarQuantizerDotProduct() throws IOException { | ||
| assertScalarQuantizer( | ||
| new float[] {0.3234983f, 0.6236096f}, 0.9f, (byte) 7, VectorSimilarityFunction.DOT_PRODUCT); | ||
| assertScalarQuantizer( | ||
| new float[] {0.28759837f, 0.62449116f}, 0f, (byte) 7, VectorSimilarityFunction.DOT_PRODUCT); | ||
| assertScalarQuantizer( | ||
| new float[] {0.3234983f, 0.6236096f}, 0.9f, (byte) 4, VectorSimilarityFunction.DOT_PRODUCT); | ||
| assertScalarQuantizer( | ||
| new float[] {0.37247902f, 0.58848244f}, 0f, (byte) 4, VectorSimilarityFunction.DOT_PRODUCT); | ||
| } | ||
|
|
||
| public void testBuildScalarQuantizerMIP() throws IOException { | ||
| assertScalarQuantizer( | ||
| new float[] {2.0f, 20.0f}, 0.9f, (byte) 7, VectorSimilarityFunction.MAXIMUM_INNER_PRODUCT); | ||
| assertScalarQuantizer( | ||
| new float[] {2.4375f, 19.0625f}, | ||
| 0f, | ||
| (byte) 7, | ||
| VectorSimilarityFunction.MAXIMUM_INNER_PRODUCT); | ||
| assertScalarQuantizer( | ||
| new float[] {2.0f, 20.0f}, 0.9f, (byte) 4, VectorSimilarityFunction.MAXIMUM_INNER_PRODUCT); | ||
| assertScalarQuantizer( | ||
| new float[] {2.6875f, 19.0625f}, | ||
| 0f, | ||
| (byte) 4, | ||
| VectorSimilarityFunction.MAXIMUM_INNER_PRODUCT); | ||
| } | ||
|
|
||
| public void testBuildScalarQuantizerEuclidean() throws IOException { | ||
| assertScalarQuantizer( | ||
| new float[] {2.0f, 20.0f}, 0.9f, (byte) 7, VectorSimilarityFunction.EUCLIDEAN); | ||
| assertScalarQuantizer( | ||
| new float[] {2.125f, 19.375f}, 0f, (byte) 7, VectorSimilarityFunction.EUCLIDEAN); | ||
| assertScalarQuantizer( | ||
| new float[] {2.0f, 20.0f}, 0.9f, (byte) 4, VectorSimilarityFunction.EUCLIDEAN); | ||
| assertScalarQuantizer( | ||
| new float[] {2.1875f, 19.0625f}, 0f, (byte) 4, VectorSimilarityFunction.EUCLIDEAN); | ||
| } | ||
|
|
||
| private void assertScalarQuantizer( | ||
| float[] expectedQuantiles, | ||
| Float confidenceInterval, | ||
| byte bits, | ||
| VectorSimilarityFunction vectorSimilarityFunction) | ||
| throws IOException { | ||
| List<float[]> vectors = new ArrayList<>(30); | ||
| for (int i = 0; i < 30; i++) { | ||
| float[] vector = new float[] {i, i + 1, i + 2, i + 3}; | ||
| vectors.add(vector); | ||
| } | ||
| FloatVectorValues vectorValues = | ||
| new Lucene99ScalarQuantizedVectorsWriter.FloatVectorWrapper( | ||
| vectors, | ||
| vectorSimilarityFunction == VectorSimilarityFunction.COSINE | ||
| || vectorSimilarityFunction == VectorSimilarityFunction.DOT_PRODUCT); | ||
| ScalarQuantizer scalarQuantizer = | ||
| Lucene99ScalarQuantizedVectorsWriter.buildScalarQuantizer( | ||
| vectorValues, 30, vectorSimilarityFunction, confidenceInterval, bits); | ||
| assertEquals(expectedQuantiles[0], scalarQuantizer.getLowerQuantile(), 0.0001f); | ||
| assertEquals(expectedQuantiles[1], scalarQuantizer.getUpperQuantile(), 0.0001f); | ||
| } | ||
| } |