Skip to navigation

HnswIndexParams

View as Markdown

Java package: com.nvidia.cuvs

public class HnswIndexParams

Supplemental parameters to build HNSW index.

Public Members

NONE

NONE(0), /** * Full hierarchy is built using the CPU */ CPU(1), /** * Full hierarchy is built using the GPU */ GPU(2)

Flat hierarchy, search is base-layer only

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:38

CPU

CPU(1), /** * Full hierarchy is built using the GPU */ GPU(2)

Full hierarchy is built using the CPU

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:43

GPU

GPU(2)

Full hierarchy is built using the GPU

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:48

getHierarchy

public CuvsHnswHierarchy getHierarchy()

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:98

getEfConstruction

public int getEfConstruction()

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:106

getNumThreads

public int getNumThreads()

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:114

getVectorDimension

public int getVectorDimension()

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:122

getM

public long getM()

Gets the HNSW M parameter: number of bi-directional links per node used to derive the internal graph build parameters for GPU construction.

Returns

the M parameter

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:132

getMetric

public CuvsDistanceType getMetric()

Gets the distance metric type.

Returns

the metric type

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:141

getAceParams

public HnswAceParams getAceParams()

Gets the optional ACE parameters for explicit out-of-core graph construction. When not set, the graph build algorithm is selected automatically.

Returns

the ACE parameters, or null if not set

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:151

Builder

public Builder()

Constructs this Builder with an instance of Arena.

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:190

withHierarchy

public Builder withHierarchy(CuvsHnswHierarchy hierarchy)

Sets the hierarchy for HNSW index when converting from CAGRA index.

NOTE: When the value is NONE, the HNSW index is built as a base-layer-only index.

Parameters

NameDescription
hierarchythe hierarchy for HNSW index when converting from CAGRA index

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:202

withEfConstruction

public Builder withEfConstruction(int efConstruction)

Sets the maximum candidate list size used during index construction.

Parameters

NameDescription
efConstructionthe maximum candidate list size used during construction

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:213

withNumThreads

public Builder withNumThreads(int numThreads)

Sets the number of host threads to use to construct hierarchy when hierarchy is CPU.

Parameters

NameDescription
numThreadsthe number of threads

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:225

withVectorDimension

public Builder withVectorDimension(int vectorDimension)

Sets the vector dimension

Parameters

NameDescription
vectorDimensionthe vector dimension

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:236

withM

public Builder withM(long m)

Sets the HNSW M parameter: number of bi-directional links per node used to derive the internal graph build parameters for GPU construction.

Parameters

NameDescription
mthe M parameter

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:248

withMetric

public Builder withMetric(CuvsDistanceType metric)

Sets the distance metric type.

Parameters

NameDescription
metricthe metric type

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:259

withAceParams

public Builder withAceParams(HnswAceParams aceParams)

Sets optional ACE parameters for explicit out-of-core graph construction. When not set, the graph build algorithm is selected automatically.

Parameters

NameDescription
aceParamsthe ACE parameters

Returns

an instance of Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:271

build

public HnswIndexParams build()

Builds an instance of HnswIndexParams.

Returns

an instance of HnswIndexParams

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:281

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:12