Cagra Search Params Module

Rust module: cuvs::cagra::search_params

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

SearchAlgo

1
pub type SearchAlgo = ffi::cuvsCagraSearchAlgo;

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

HashMode

1
pub type HashMode = ffi::cuvsCagraHashMode;

Source: rust/cuvs/src/cagra/search_params.rs:11

SearchParams

1
pub struct SearchParams(pub ffi::cuvsCagraSearchParams_t);

Supplemental parameters to search CAGRA index

Methods

new

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

Returns a new SearchParams object

Source: rust/cuvs/src/cagra/search_params.rs:18

set_max_queries

1
pub fn set_max_queries(self, max_queries: usize) -> SearchParams { ... }

Maximum number of queries to search at the same time (batch size). Auto select when 0

Source: rust/cuvs/src/cagra/search_params.rs:27

set_itopk_size

1
pub fn set_itopk_size(self, itopk_size: usize) -> SearchParams { ... }

Number of intermediate search results retained during the search. This is the main knob to adjust trade off between accuracy and search speed. Higher values improve the search accuracy

Source: rust/cuvs/src/cagra/search_params.rs:37

set_max_iterations

1
pub fn set_max_iterations(self, max_iterations: usize) -> SearchParams { ... }

Upper limit of search iterations. Auto select when 0.

Source: rust/cuvs/src/cagra/search_params.rs:45

set_algo

1
pub fn set_algo(self, algo: SearchAlgo) -> SearchParams { ... }

Which search implementation to use.

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

set_team_size

1
pub fn set_team_size(self, team_size: usize) -> SearchParams { ... }

Number of threads used to calculate a single distance. 4, 8, 16, or 32.

Source: rust/cuvs/src/cagra/search_params.rs:61

set_min_iterations

1
pub fn set_min_iterations(self, min_iterations: usize) -> SearchParams { ... }

Lower limit of search iterations.

Source: rust/cuvs/src/cagra/search_params.rs:69

set_thread_block_size

1
pub fn set_thread_block_size(self, thread_block_size: usize) -> SearchParams { ... }

Thread block size. 0, 64, 128, 256, 512, 1024. Auto selection when 0.

Source: rust/cuvs/src/cagra/search_params.rs:77

set_hashmap_mode

1
pub fn set_hashmap_mode(self, hashmap_mode: HashMode) -> SearchParams { ... }

Hashmap type. Auto selection when AUTO.

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

set_hashmap_min_bitlen

1
pub fn set_hashmap_min_bitlen(self, hashmap_min_bitlen: usize) -> SearchParams { ... }

Lower limit of hashmap bit length. More than 8.

Source: rust/cuvs/src/cagra/search_params.rs:93

set_hashmap_max_fill_rate

1
pub fn set_hashmap_max_fill_rate(self, hashmap_max_fill_rate: f32) -> SearchParams { ... }

Upper limit of hashmap fill rate. More than 0.1, less than 0.9.

Source: rust/cuvs/src/cagra/search_params.rs:101

set_num_random_samplings

1
pub fn set_num_random_samplings(self, num_random_samplings: u32) -> SearchParams { ... }

Number of iterations of initial random seed node selection. 1 or more.

Source: rust/cuvs/src/cagra/search_params.rs:109

set_rand_xor_mask

1
pub fn set_rand_xor_mask(self, rand_xor_mask: u64) -> SearchParams { ... }

Bit mask used for initial random seed node selection.

Source: rust/cuvs/src/cagra/search_params.rs:117

Source: rust/cuvs/src/cagra/search_params.rs:14