Skip to navigation

Lucene101AcceleratedHNSWCodec

View as Markdown

Java package: com.nvidia.cuvs.lucene

public class Lucene101AcceleratedHNSWCodec extends FilterCodec

A codec that enables GPU-based accelerated HNSW capability and can be used to accelerated indexing using GPUs and search using CPUs. Fallbacks to CPU based indexing when used on a machine without a GPU and/or cuVS.

Public Members

Lucene101AcceleratedHNSWCodec

public Lucene101AcceleratedHNSWCodec() throws Exception

Default constructor for Lucene101AcceleratedHNSWCodec.

Throws

TypeDescription
Exception

Source: java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:31

Lucene101AcceleratedHNSWCodec

public Lucene101AcceleratedHNSWCodec(String name, Codec delegate)

Constructor for Lucene101AcceleratedHNSWCodec.

Parameters

NameDescription
namethe codec’s name
delegatethe delegate codec to filter

Source: java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:41

Lucene101AcceleratedHNSWCodec

public Lucene101AcceleratedHNSWCodec(AcceleratedHNSWParams acceleratedHNSWParams) throws Exception

Constructor for Lucene101AcceleratedHNSWCodec.

Parameters

NameDescription
acceleratedHNSWParamsinstance of AcceleratedHNSWParams

Throws

TypeDescription
Exceptionexception

Source: java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:52

knnVectorsFormat

@Override public KnnVectorsFormat knnVectorsFormat()

Get the configured KnnVectorsFormat.

Returns

the instance of the KnnVectorsFormat

Source: java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:87

setKnnFormat

public void setKnnFormat(KnnVectorsFormat format)

Set the KnnVectorsFormat.

Parameters

NameDescription
formatthe KnnVectorsFormat to set

Source: java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:97

Source: java/cuvs-lucene/src/main/java/com/nvidia/cuvs/lucene/Lucene101AcceleratedHNSWCodec.java:21