HnswIndexParams

Java package: com.nvidia.cuvs

1
public class HnswIndexParams

Supplemental parameters to build HNSW index.

Public Members

NONE

1
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

1
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

1
GPU(2)

Full hierarchy is built using the GPU

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

getHierarchy

1
public CuvsHnswHierarchy getHierarchy()

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

getEfConstruction

1
public int getEfConstruction()

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

getNumThreads

1
public int getNumThreads()

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

getVectorDimension

1
public int getVectorDimension()

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

getM

1
public long getM()

Gets the HNSW M parameter: number of bi-directional links per node (used when building with ACE). graph_degree = m * 2, intermediate_graph_degree = m * 3.

Returns

the M parameter

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

getMetric

1
public CuvsDistanceType getMetric()

Gets the distance metric type.

Returns

the metric type

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

getAceParams

1
public HnswAceParams getAceParams()

Gets the ACE parameters for building HNSW index using ACE algorithm.

Returns

the ACE parameters, or null if not set

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

Builder

1
public Builder()

Constructs this Builder with an instance of Arena.

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

withHierarchy

1
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

Returns

an instance of Builder

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

withEfConstruction

1
public Builder withEfConstruction(int efConstruction)

Sets the size of the candidate list during hierarchy construction when hierarchy is CPU.

Parameters

Returns

an instance of Builder

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

withNumThreads

1
public Builder withNumThreads(int numThreads)

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

Parameters

Returns

an instance of Builder

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

withVectorDimension

1
public Builder withVectorDimension(int vectorDimension)

Sets the vector dimension

Parameters

Returns

an instance of Builder

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

withM

1
public Builder withM(long m)

Sets the HNSW M parameter: number of bi-directional links per node (used when building with ACE). graph_degree = m * 2, intermediate_graph_degree = m * 3.

Parameters

Returns

an instance of Builder

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

withMetric

1
public Builder withMetric(CuvsDistanceType metric)

Sets the distance metric type.

Parameters

Returns

an instance of Builder

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

withAceParams

1
public Builder withAceParams(HnswAceParams aceParams)

Sets the ACE parameters for building HNSW index using ACE algorithm.

Parameters

Returns

an instance of Builder

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

build

1
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:283

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