Rename GpuVectorsFormat to EsGpuHnswVectorsFormat

mayya-sharipova · mayya-sharipova · commit 7e0cc3d6e194 · 2025-08-20T11:50:08.000-04:00
We want to introduce a new int8 format for GPU, with its anticipation
rename GpuVectorsFormat to EsGpuHnswVectorsFormat
diff --git a/qa/vector/src/main/java/org/elasticsearch/test/knn/KnnIndexTester.java b/qa/vector/src/main/java/org/elasticsearch/test/knn/KnnIndexTester.java
@@ -31,7 +31,7 @@
 import org.elasticsearch.xcontent.XContentParser;
 import org.elasticsearch.xcontent.XContentParserConfiguration;
 import org.elasticsearch.xcontent.XContentType;
-import org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat;
+import org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat;
 
 import java.io.InputStream;
 import java.lang.management.ThreadInfo;
@@ -95,7 +95,7 @@ static Codec createCodec(CmdLineArgs args) {
         if (args.indexType() == IndexType.IVF) {
             format = new IVFVectorsFormat(args.ivfClusterSize());
         } else if (args.indexType() == IndexType.GPU) {
-            format = new GPUVectorsFormat();
+            format = new ESGpuHnswVectorsFormat();
         } else {
             if (args.quantizeBits() == 1) {
                 if (args.indexType() == IndexType.FLAT) {
diff --git a/x-pack/plugin/gpu/src/main/java/module-info.java b/x-pack/plugin/gpu/src/main/java/module-info.java
@@ -16,6 +16,6 @@
 
     exports org.elasticsearch.xpack.gpu.codec;
 
-    provides org.apache.lucene.codecs.KnnVectorsFormat with org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat;
+    provides org.apache.lucene.codecs.KnnVectorsFormat with org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat;
     provides org.elasticsearch.features.FeatureSpecification with org.elasticsearch.xpack.gpu.GPUFeatures;
 }
diff --git a/x-pack/plugin/gpu/src/main/java/org/elasticsearch/xpack/gpu/GPUPlugin.java b/x-pack/plugin/gpu/src/main/java/org/elasticsearch/xpack/gpu/GPUPlugin.java
@@ -14,7 +14,7 @@
 import org.elasticsearch.index.mapper.vectors.VectorsFormatProvider;
 import org.elasticsearch.plugins.MapperPlugin;
 import org.elasticsearch.plugins.Plugin;
-import org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat;
+import org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat;
 
 public class GPUPlugin extends Plugin implements MapperPlugin {
 
@@ -60,9 +60,9 @@ private static KnnVectorsFormat getVectorsFormat(DenseVectorFieldMapper.DenseVec
             DenseVectorFieldMapper.HnswIndexOptions hnswIndexOptions = (DenseVectorFieldMapper.HnswIndexOptions) indexOptions;
             int efConstruction = hnswIndexOptions.efConstruction();
             if (efConstruction == HnswGraphBuilder.DEFAULT_BEAM_WIDTH) {
-                efConstruction = GPUVectorsFormat.DEFAULT_BEAM_WIDTH; // default value for GPU graph construction is 128
+                efConstruction = ESGpuHnswVectorsFormat.DEFAULT_BEAM_WIDTH; // default value for GPU graph construction is 128
             }
-            return new GPUVectorsFormat(hnswIndexOptions.m(), efConstruction);
+            return new ESGpuHnswVectorsFormat(hnswIndexOptions.m(), efConstruction);
         } else {
             throw new IllegalArgumentException(
                 "GPU vector indexing is not supported on this vector type: [" + indexOptions.getType() + "]"
diff --git a/x-pack/plugin/gpu/src/main/java/org/elasticsearch/xpack/gpu/codec/ESGpuHnswVectorsFormat.java b/x-pack/plugin/gpu/src/main/java/org/elasticsearch/xpack/gpu/codec/ESGpuHnswVectorsFormat.java
@@ -19,12 +19,14 @@
 
 import java.io.IOException;
 
+import static org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.MAX_DIMS_COUNT;
+
 /**
  * Codec format for GPU-accelerated vector indexes. This format is designed to
  * leverage GPU processing capabilities for vector search operations.
  */
-public class GPUVectorsFormat extends KnnVectorsFormat {
-    public static final String NAME = "GPUVectorsFormat";
+public class ESGpuHnswVectorsFormat extends KnnVectorsFormat {
+    public static final String NAME = "ESGpuHnswVectorsFormat";
     public static final int VERSION_START = 0;
 
     static final String LUCENE99_HNSW_META_CODEC_NAME = "Lucene99HnswVectorsFormatMeta";
@@ -47,15 +49,15 @@ public class GPUVectorsFormat extends KnnVectorsFormat {
     private final int beamWidth;
     final CuVSResourceManager cuVSResourceManager;
 
-    public GPUVectorsFormat() {
+    public ESGpuHnswVectorsFormat() {
         this(CuVSResourceManager.pooling(), DEFAULT_MAX_CONN, DEFAULT_BEAM_WIDTH);
     }
 
-    public GPUVectorsFormat(int maxConn, int beamWidth) {
+    public ESGpuHnswVectorsFormat(int maxConn, int beamWidth) {
         this(CuVSResourceManager.pooling(), maxConn, beamWidth);
     };
 
-    public GPUVectorsFormat(CuVSResourceManager cuVSResourceManager, int maxConn, int beamWidth) {
+    public ESGpuHnswVectorsFormat(CuVSResourceManager cuVSResourceManager, int maxConn, int beamWidth) {
         super(NAME);
         this.cuVSResourceManager = cuVSResourceManager;
         this.maxConn = maxConn;
@@ -64,7 +66,7 @@ public GPUVectorsFormat(CuVSResourceManager cuVSResourceManager, int maxConn, in
 
     @Override
     public KnnVectorsWriter fieldsWriter(SegmentWriteState state) throws IOException {
-        return new GPUToHNSWVectorsWriter(cuVSResourceManager, state, maxConn, beamWidth, flatVectorsFormat.fieldsWriter(state));
+        return new ESGpuHnswVectorsWriter(cuVSResourceManager, state, maxConn, beamWidth, flatVectorsFormat.fieldsWriter(state));
     }
 
     @Override
@@ -74,7 +76,7 @@ public KnnVectorsReader fieldsReader(SegmentReadState state) throws IOException
 
     @Override
     public int getMaxDimensions(String fieldName) {
-        return 4096;
+        return MAX_DIMS_COUNT;
     }
 
     @Override
diff --git a/x-pack/plugin/gpu/src/main/java/org/elasticsearch/xpack/gpu/codec/ESGpuHnswVectorsWriter.java b/x-pack/plugin/gpu/src/main/java/org/elasticsearch/xpack/gpu/codec/ESGpuHnswVectorsWriter.java
@@ -50,20 +50,20 @@
 
 import static org.apache.lucene.codecs.lucene99.Lucene99HnswVectorsReader.SIMILARITY_FUNCTIONS;
 import static org.apache.lucene.search.DocIdSetIterator.NO_MORE_DOCS;
-import static org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat.LUCENE99_HNSW_META_CODEC_NAME;
-import static org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat.LUCENE99_HNSW_META_EXTENSION;
-import static org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat.LUCENE99_HNSW_VECTOR_INDEX_CODEC_NAME;
-import static org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat.LUCENE99_HNSW_VECTOR_INDEX_EXTENSION;
-import static org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat.LUCENE99_VERSION_CURRENT;
-import static org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat.MIN_NUM_VECTORS_FOR_GPU_BUILD;
+import static org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat.LUCENE99_HNSW_META_CODEC_NAME;
+import static org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat.LUCENE99_HNSW_META_EXTENSION;
+import static org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat.LUCENE99_HNSW_VECTOR_INDEX_CODEC_NAME;
+import static org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat.LUCENE99_HNSW_VECTOR_INDEX_EXTENSION;
+import static org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat.LUCENE99_VERSION_CURRENT;
+import static org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat.MIN_NUM_VECTORS_FOR_GPU_BUILD;
 
 /**
  * Writer that builds a Nvidia Carga Graph on GPU and than writes it into the Lucene99 HNSW format,
  * so that it can be searched on CPU with Lucene99HNSWVectorReader.
  */
-final class GPUToHNSWVectorsWriter extends KnnVectorsWriter {
-    private static final Logger logger = LogManager.getLogger(GPUToHNSWVectorsWriter.class);
-    private static final long SHALLOW_RAM_BYTES_USED = RamUsageEstimator.shallowSizeOfInstance(GPUToHNSWVectorsWriter.class);
+final class ESGpuHnswVectorsWriter extends KnnVectorsWriter {
+    private static final Logger logger = LogManager.getLogger(ESGpuHnswVectorsWriter.class);
+    private static final long SHALLOW_RAM_BYTES_USED = RamUsageEstimator.shallowSizeOfInstance(ESGpuHnswVectorsWriter.class);
     private static final int LUCENE99_HNSW_DIRECT_MONOTONIC_BLOCK_SHIFT = 16;
 
     private final CuVSResourceManager cuVSResourceManager;
@@ -76,7 +76,7 @@ final class GPUToHNSWVectorsWriter extends KnnVectorsWriter {
     private final List<FieldWriter> fields = new ArrayList<>();
     private boolean finished;
 
-    GPUToHNSWVectorsWriter(
+    ESGpuHnswVectorsWriter(
         CuVSResourceManager cuVSResourceManager,
         SegmentWriteState state,
         int M,
diff --git a/x-pack/plugin/gpu/src/main/resources/META-INF/services/org.apache.lucene.codecs.KnnVectorsFormat b/x-pack/plugin/gpu/src/main/resources/META-INF/services/org.apache.lucene.codecs.KnnVectorsFormat
@@ -1,2 +1,2 @@
 
-org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat
+org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat
diff --git a/x-pack/plugin/gpu/src/test/java/org/elasticsearch/xpack/gpu/codec/ESGpuHnswVectorsFormatTests.java b/x-pack/plugin/gpu/src/test/java/org/elasticsearch/xpack/gpu/codec/ESGpuHnswVectorsFormatTests.java
@@ -17,7 +17,7 @@
 import org.elasticsearch.xpack.gpu.GPUSupport;
 import org.junit.BeforeClass;
 
-public class GPUVectorsFormatTests extends BaseKnnVectorsFormatTestCase {
+public class ESGpuHnswVectorsFormatTests extends BaseKnnVectorsFormatTestCase {
 
     static {
         LogConfigurator.loadLog4jPlugins();
@@ -29,7 +29,7 @@ public static void beforeClass() {
         assumeTrue("cuvs not supported", GPUSupport.isSupported(false));
     }
 
-    static final Codec codec = TestUtil.alwaysKnnVectorsFormat(new GPUVectorsFormat());
+    static final Codec codec = TestUtil.alwaysKnnVectorsFormat(new ESGpuHnswVectorsFormat());
 
     @Override
     protected Codec getCodec() {
@@ -80,10 +80,10 @@ public void testToString() {
         FilterCodec customCodec = new FilterCodec("foo", Codec.getDefault()) {
             @Override
             public KnnVectorsFormat knnVectorsFormat() {
-                return new GPUVectorsFormat();
+                return new ESGpuHnswVectorsFormat();
             }
         };
-        String expectedPattern = "GPUVectorsFormat(maxConn=16, beamWidth=128, flatVectorFormat=Lucene99FlatVectorsFormat)";
+        String expectedPattern = "ESGpuHnswVectorsFormat(maxConn=16, beamWidth=128, flatVectorFormat=Lucene99FlatVectorsFormat)";
         assertEquals(expectedPattern, customCodec.knnVectorsFormat().toString());
     }
 
diff --git a/x-pack/plugin/gpu/src/test/java/org/elasticsearch/xpack/gpu/codec/GPUDenseVectorFieldMapperTests.java b/x-pack/plugin/gpu/src/test/java/org/elasticsearch/xpack/gpu/codec/GPUDenseVectorFieldMapperTests.java
@@ -39,7 +39,7 @@ protected Collection<Plugin> getPlugins() {
         return Collections.singletonList(plugin);
     }
 
-    public void testKnnGPUVectorsFormat() throws IOException {
+    public void testKnnESGPUHnswVectorsFormat() throws IOException {
         final int dims = randomIntBetween(128, 4096);
         MapperService mapperService = createMapperService(fieldMapping(b -> {
             b.field("type", "dense_vector");
@@ -63,7 +63,7 @@ public void testKnnGPUVectorsFormat() throws IOException {
             assertThat(codec, instanceOf(LegacyPerFieldMapperCodec.class));
             knnVectorsFormat = ((LegacyPerFieldMapperCodec) codec).getKnnVectorsFormatForField("field");
         }
-        String expectedString = "GPUVectorsFormat()";
+        String expectedString = "ESGpuHnswVectorsFormat(maxConn=16, beamWidth=128, flatVectorFormat=Lucene99FlatVectorsFormat)";
         assertEquals(expectedString, knnVectorsFormat.toString());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,6 @@`
`16`	`16`
`17`	`17`	`exports org.elasticsearch.xpack.gpu.codec;`
`18`	`18`
`19`		`- provides org.apache.lucene.codecs.KnnVectorsFormat with org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat;`
	`19`	`+ provides org.apache.lucene.codecs.KnnVectorsFormat with org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat;`
`20`	`20`	`provides org.elasticsearch.features.FeatureSpecification with org.elasticsearch.xpack.gpu.GPUFeatures;`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`
`2`		`-org.elasticsearch.xpack.gpu.codec.GPUVectorsFormat`
	`2`	`+org.elasticsearch.xpack.gpu.codec.ESGpuHnswVectorsFormat`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ protected Collection<Plugin> getPlugins() {`
`39`	`39`	`return Collections.singletonList(plugin);`
`40`	`40`	`}`
`41`	`41`
`42`		`- public void testKnnGPUVectorsFormat() throws IOException {`
	`42`	`+ public void testKnnESGPUHnswVectorsFormat() throws IOException {`
`43`	`43`	`final int dims = randomIntBetween(128, 4096);`
`44`	`44`	`MapperService mapperService = createMapperService(fieldMapping(b -> {`
`45`	`45`	`b.field("type", "dense_vector");`
`@@ -63,7 +63,7 @@ public void testKnnGPUVectorsFormat() throws IOException {`
`63`	`63`	`assertThat(codec, instanceOf(LegacyPerFieldMapperCodec.class));`
`64`	`64`	`knnVectorsFormat = ((LegacyPerFieldMapperCodec) codec).getKnnVectorsFormatForField("field");`
`65`	`65`	`}`
`66`		`- String expectedString = "GPUVectorsFormat()";`
	`66`	`+ String expectedString = "ESGpuHnswVectorsFormat(maxConn=16, beamWidth=128, flatVectorFormat=Lucene99FlatVectorsFormat)";`
`67`	`67`	`assertEquals(expectedString, knnVectorsFormat.toString());`
`68`	`68`	`}`
`69`	`69`	`}`