CagraCompressionParams
Java package: com.nvidia.cuvs
Supplemental compression parameters to build CAGRA Index.
Public Members
getPqBits
Gets the bit length of the vector element after compression by PQ.
Returns
the bit length of the vector element after compression by PQ.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:57
getPqDim
Gets the dimensionality of the vector after compression by PQ.
Returns
the dimensionality of the vector after compression by PQ.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:66
getVqNCenters
Gets the vector quantization (VQ) codebook size - number of “coarse cluster centers”.
Returns
the vector quantization (VQ) codebook size - number of “coarse cluster centers”.
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:77
getKmeansNIters
Gets the number of iterations searching for kmeans centers (both VQ and PQ phases).
Returns
the number of iterations searching for kmeans centers (both VQ and PQ phases).
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:88
getVqKmeansTrainsetFraction
Gets the fraction of data to use during iterative kmeans building (VQ phase).
Returns
the fraction of data to use during iterative kmeans building (VQ phase).
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:98
getPqKmeansTrainsetFraction
Gets the fraction of data to use during iterative kmeans building (PQ phase).
Returns
the fraction of data to use during iterative kmeans building (PQ phase).
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:108
withPqBits
Sets the bit length of the vector element after compression by PQ.
Possible values: [4, 5, 6, 7, 8]. Hint: the smaller the ‘pq_bits’, the smaller the index size and the better the search performance, but the lower the recall.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:153
withPqDim
Sets the dimensionality of the vector after compression by PQ.
When zero, an optimal value is selected using a heuristic.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:166
withVqNCenters
Sets the vector quantization (VQ) codebook size - number of “coarse cluster centers”.
When zero, an optimal value is selected using a heuristic.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:180
withKmeansNIters
Sets the number of iterations searching for kmeans centers (both VQ and PQ phases).
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:192
withVqKmeansTrainsetFraction
Sets the fraction of data to use during iterative kmeans building (VQ phase).
When zero, an optimal value is selected using a heuristic.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:205
withPqKmeansTrainsetFraction
Sets the fraction of data to use during iterative kmeans building (PQ phase).
When zero, an optimal value is selected using a heuristic.
Parameters
Returns
an instance of Builder
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:218
build
Builds an instance of CagraCompressionParams.
Returns
an instance of CagraCompressionParams
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:228
Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraCompressionParams.java:12