HnswIndexParams
Java package: com.nvidia.cuvs
Supplemental parameters to build HNSW index.
Public Members
NONE
Flat hierarchy, search is base-layer only
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:38
CPU
Full hierarchy is built using the CPU
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:43
GPU
Full hierarchy is built using the GPU
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:48
getHierarchy
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:98
getEfConstruction
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:106
getNumThreads
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:114
getVectorDimension
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:122
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
Gets the distance metric type.
Returns
the metric type
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:141
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
Constructs this Builder with an instance of Arena.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:190
withHierarchy
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
Sets the maximum candidate list size used during index construction.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:213
withNumThreads
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:225
withVectorDimension
Sets the vector dimension
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:236
withM
Sets the HNSW M parameter: number of bi-directional links per node used to derive the internal graph build parameters for GPU construction.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:248
withMetric
Sets the distance metric type.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:259
withAceParams
Sets optional ACE parameters for explicit out-of-core graph construction. When not set, the graph build algorithm is selected automatically.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndexParams.java:271
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