Class CuVSCodec

solr/modules/cuvs/src/java/org/apache/solr/cuvs/CuVSCodec.java:40–112

This codec utilizes the Lucene99AcceleratedHNSWVectorsFormat from the lucene-cuvs library to enable GPU-based accelerated vector search. @since 10.0.0

 * @since 10.0.0
 */
public class CuVSCodec extends FilterCodec {

  private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  private static final String FALLBACK_CODEC = "Lucene104";
  private final SolrCore core;
  private final Lucene104Codec fallbackCodec;

  public CuVSCodec(SolrCore core, Lucene104Codec fallback, NamedList<?> args) {
    super(FALLBACK_CODEC, fallback);
    this.core = core;
    this.fallbackCodec = fallback;
  }

  @Override
  public KnnVectorsFormat knnVectorsFormat() {
    return perFieldKnnVectorsFormat;
  }

  private PerFieldKnnVectorsFormat perFieldKnnVectorsFormat =
      new PerFieldKnnVectorsFormat() {
        @Override
        public KnnVectorsFormat getKnnVectorsFormatForField(String field) {
          final SchemaField schemaField = core.getLatestSchema().getFieldOrNull(field);
          FieldType fieldType = (schemaField == null ? null : schemaField.getType());
          if (fieldType instanceof DenseVectorField vectorType) {
            String knnAlgorithm = vectorType.getKnnAlgorithm();
            if (DenseVectorField.CAGRA_HNSW_ALGORITHM.equals(knnAlgorithm)) {

              int cuvsWriterThreads = vectorType.getCuvsWriterThreads();
              int cuvsIntGraphDegree = vectorType.getCuvsIntGraphDegree();
              int cuvsGraphDegree = vectorType.getCuvsGraphDegree();
              int cuvsHnswLayers = vectorType.getCuvsHnswLayers();
              int cuvsHnswM = vectorType.getCuvsHnswMaxConn();
              int cuvsHnswEfConstruction = vectorType.getCuvsHnswEfConstruction();

              assert cuvsWriterThreads > 0 : "cuvsWriterThreads cannot be less then or equal to 0";
              assert cuvsIntGraphDegree > 0
                  : "cuvsIntGraphDegree cannot be less then or equal to 0";
              assert cuvsGraphDegree > 0 : "cuvsGraphDegree cannot be less then or equal to 0";
              assert cuvsHnswLayers > 0 : "cuvsHnswLayers cannot be less then or equal to 0";
              assert cuvsHnswM > 0 : "cuvsHnswM cannot be less then or equal to 0";
              assert cuvsHnswEfConstruction > 0
                  : "cuvsHnswEfConstruction cannot be less then or equal to 0";

              if (log.isInfoEnabled()) {
                log.info(
                    "Initializing Lucene99AcceleratedHNSWVectorsFormat with parameter values: cuvsWriterThreads {}, cuvsIntGraphDegree {}, cuvsGraphDegree {}, cuvsHnswLayers {}, cuvsHnswM {}, cuvsHnswEfConstruction {}",
                    cuvsWriterThreads,
                    cuvsIntGraphDegree,
                    cuvsGraphDegree,
                    cuvsHnswLayers,
                    cuvsHnswM,
                    cuvsHnswEfConstruction);
              }
              return new Lucene99AcceleratedHNSWVectorsFormat(
                  cuvsWriterThreads,
                  cuvsIntGraphDegree,
                  cuvsGraphDegree,