Ivf Pq Search Params Module

View as Markdown

Rust module: cuvs::ivf_pq::search_params

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

ffi::cudaDataType_t

1pub use ffi::cudaDataType_t;

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

SearchParams

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

Supplemental parameters to search IvfPq index

Methods

NameSource
newrust/cuvs/src/ivf_pq/search_params.rs:17
set_n_probesrust/cuvs/src/ivf_pq/search_params.rs:26
set_lut_dtyperust/cuvs/src/ivf_pq/search_params.rs:39
set_internal_distance_dtyperust/cuvs/src/ivf_pq/search_params.rs:47

new

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

Returns a new SearchParams object

Source: rust/cuvs/src/ivf_pq/search_params.rs:17

set_n_probes

1pub fn set_n_probes(self, n_probes: u32) -> SearchParams { ... }

The number of clusters to search.

Source: rust/cuvs/src/ivf_pq/search_params.rs:26

set_lut_dtype

1pub fn set_lut_dtype(self, lut_dtype: cudaDataType_t) -> SearchParams { ... }

Data type of look up table to be created dynamically at search time. The use of low-precision types reduces the amount of shared memory required at search time, so fast shared memory kernels can be used even for datasets with large dimansionality. Note that the recall is slightly degraded when low-precision type is selected.

Source: rust/cuvs/src/ivf_pq/search_params.rs:39

set_internal_distance_dtype

1pub fn set_internal_distance_dtype(
2self,
3internal_distance_dtype: cudaDataType_t,
4) -> SearchParams { ... }

Storage data type for distance/similarity computation.

Source: rust/cuvs/src/ivf_pq/search_params.rs:47

Source: rust/cuvs/src/ivf_pq/search_params.rs:13