Cagra Index Params Module

Rust module: cuvs::cagra::index_params

Source: rust/cuvs/src/cagra/index_params.rs

BuildAlgo

1
pub type BuildAlgo = ffi::cuvsCagraGraphBuildAlgo;

Source: rust/cuvs/src/cagra/index_params.rs:10

CompressionParams

1
pub struct CompressionParams(pub ffi::cuvsCagraCompressionParams_t);

Supplemental parameters to build CAGRA Index

Methods

new

1
pub fn new() -> Result<CompressionParams> { ... }

Returns a new CompressionParams

Source: rust/cuvs/src/cagra/index_params.rs:17

set_pq_bits

1
pub fn set_pq_bits(self, pq_bits: u32) -> CompressionParams { ... }

The bit length of the vector element after compression by PQ.

Source: rust/cuvs/src/cagra/index_params.rs:26

set_pq_dim

1
pub fn set_pq_dim(self, pq_dim: u32) -> CompressionParams { ... }

The dimensionality of the vector after compression by PQ. When zero, an optimal value is selected using a heuristic.

Source: rust/cuvs/src/cagra/index_params.rs:35

set_vq_n_centers

1
pub fn set_vq_n_centers(self, vq_n_centers: u32) -> CompressionParams { ... }

Vector Quantization (VQ) codebook size - number of “coarse cluster centers”. When zero, an optimal value is selected using a heuristic.

Source: rust/cuvs/src/cagra/index_params.rs:44

set_kmeans_n_iters

1
pub fn set_kmeans_n_iters(self, kmeans_n_iters: u32) -> CompressionParams { ... }

The number of iterations searching for kmeans centers (both VQ & PQ phases).

Source: rust/cuvs/src/cagra/index_params.rs:53

set_vq_kmeans_trainset_fraction

1
pub fn set_vq_kmeans_trainset_fraction(
2
self,
3
vq_kmeans_trainset_fraction: f64,
4
) -> CompressionParams { ... }

The fraction of data to use during iterative kmeans building (VQ phase). When zero, an optimal value is selected using a heuristic.

Source: rust/cuvs/src/cagra/index_params.rs:62

set_pq_kmeans_trainset_fraction

1
pub fn set_pq_kmeans_trainset_fraction(
2
self,
3
pq_kmeans_trainset_fraction: f64,
4
) -> CompressionParams { ... }

The fraction of data to use during iterative kmeans building (PQ phase). When zero, an optimal value is selected using a heuristic.

Source: rust/cuvs/src/cagra/index_params.rs:74

Source: rust/cuvs/src/cagra/index_params.rs:13

IndexParams

1
pub struct IndexParams(pub ffi::cuvsCagraIndexParams_t, Option<CompressionParams>);

Methods

new

1
pub fn new() -> Result<IndexParams> { ... }

Returns a new IndexParams

Source: rust/cuvs/src/cagra/index_params.rs:89

set_intermediate_graph_degree

1
pub fn set_intermediate_graph_degree(self, intermediate_graph_degree: usize) -> IndexParams { ... }

Degree of input graph for pruning

Source: rust/cuvs/src/cagra/index_params.rs:98

set_graph_degree

1
pub fn set_graph_degree(self, graph_degree: usize) -> IndexParams { ... }

Degree of output graph

Source: rust/cuvs/src/cagra/index_params.rs:106

set_build_algo

1
pub fn set_build_algo(self, build_algo: BuildAlgo) -> IndexParams { ... }

ANN algorithm to build knn graph

Source: rust/cuvs/src/cagra/index_params.rs:114

set_nn_descent_niter

1
pub fn set_nn_descent_niter(self, nn_descent_niter: usize) -> IndexParams { ... }

Number of iterations to run if building with NN_DESCENT

Source: rust/cuvs/src/cagra/index_params.rs:122

set_compression

1
pub fn set_compression(mut self, compression: CompressionParams) -> IndexParams { ... }

Source: rust/cuvs/src/cagra/index_params.rs:129

Source: rust/cuvs/src/cagra/index_params.rs:85