CagraIndexParams
Java package: com.nvidia.cuvs
Supplemental parameters to build CAGRA Index.
Public Members
AUTO_SELECT
Select build algorithm automatically
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:35
IVF_PQ
Use IVF-PQ to build all-neighbors knn graph
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:39
NN_DESCENT
Experimental, use NN-Descent to build all-neighbors knn graph
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:43
ACE
Experimental, use ACE (Augmented Core Extraction) to build graph for large datasets. 4 to be consistent with the other interfaces.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:48
SIMILAR_SEARCH_PERFORMANCE
Create a graph that is very similar to an HNSW graph in terms of the number of nodes and search performance. Since HNSW produces a variable-degree graph (2M being the max graph degree) and CAGRA produces a fixed-degree graph, there’s always a difference in the performance of the two.
This function attempts to produce such a graph that the QPS and recall of the two graphs being searched by HNSW are close for any search parameter combination. The CAGRA-produced graph tends to have a “longer tail” on the low recall side (that is being slightly faster and less precise).
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:84
SAME_GRAPH_FOOTPRINT
Create a graph that has the same binary size as an HNSW graph with the given parameters (graph_degree = 2 * M) while trying to match the search performance as closely as possible.
The reference HNSW index and the corresponding from-CAGRA generated HNSW index will NOT produce the same recalls and QPS for the same parameter ef. The graphs are different internally. For the same ef, the from-CAGRA index likely has a slightly higher recall and slightly lower QPS. However, the Recall-QPS curves should be similar (i.e. the points are just shifted along the curve).
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:95
L2Expanded
evaluate as dist_ij = sum(x_ik^2) + sum(y_ij)^2 - 2*sum(x_ik * y_jk)
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:123
L2SqrtExpanded
same as above, but inside the epilogue, perform square root operation
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:127
CosineExpanded
cosine distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:131
L1
L1 distance *
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:135
L2Unexpanded
evaluate as dist_ij += (x_ik - y-jk)^2 *
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:139
L2SqrtUnexpanded
same as above, but inside the epilogue, perform square root operation
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:143
InnerProduct
basic inner product
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:147
Linf
Chebyshev (Linf) distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:151
Canberra
Canberra distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:155
LpUnexpanded
Generalized Minkowski distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:159
CorrelationExpanded
Correlation distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:163
JaccardExpanded
Jaccard distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:167
HellingerExpanded
Hellinger distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:171
Haversine
Haversine distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:175
BrayCurtis
Bray-Curtis distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:179
JensenShannon
Jensen-Shannon distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:183
HammingUnexpanded
Hamming distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:187
KLDivergence
KLDivergence
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:191
RusselRaoExpanded
RusselRao
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:195
DiceExpanded
Dice-Sorensen distance
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:199
Precomputed
Precomputed (special value)
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:203
getIntermediateGraphDegree
Gets the degree of input graph for pruning.
Returns
the degree of input graph
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:369
getGraphDegree
Gets the degree of output graph.
Returns
the degree of output graph
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:378
getCagraGraphBuildAlgo
Gets the CagraGraphBuildAlgo used to build the index.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:385
getNNDescentNumIterations
Gets the number of iterations to run if building with
CagraGraphBuildAlgo#NN_DESCENT
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:393
getCuvsDistanceType
Gets the CuvsDistanceType used to build the index.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:400
getNumWriterThreads
Gets the number of threads used to build the index.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:407
getCuVSIvfPqParams
Gets the IVF_PQ parameters.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:414
getCuVSAceParams
Gets the ACE parameters.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:421
getCuvsCagraGraphBuildAlgo
Gets the CAGRA build algorithm.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:428
withIntermediateGraphDegree
Sets the degree of input graph for pruning.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:475
withGraphDegree
Sets the degree of output graph.
Parameters
Returns
an instance to Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:486
withCagraGraphBuildAlgo
Sets the CuvsCagraGraphBuildAlgo to use.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:497
withMetric
Sets the metric to use.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:508
withNNDescentNumIterations
Sets the Number of Iterations to run if building with
CagraGraphBuildAlgo#NN_DESCENT.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:521
withNumWriterThreads
Sets the number of writer threads to use for indexing.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:532
withCuVSIvfPqParams
Sets the IVF_PQ index parameters.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:543
withCuVSAceParams
Sets the ACE index parameters.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:554
build
Builds an instance of CagraIndexParams.
Returns
an instance of CagraIndexParams
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:564
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndexParams.java:18