Struct IndexParams

pub struct IndexParams(pub cuvsIvfFlatIndexParams_t);

Tuple Fields

0: cuvsIvfFlatIndexParams_t

Implementations

impl IndexParams

pub fn new() -> Result<IndexParams>

Returns a new IndexParams

pub fn set_n_lists(self, n_lists: u32) -> IndexParams

The number of clusters used in the coarse quantizer.

pub fn set_metric(self, metric: DistanceType) -> IndexParams

DistanceType to use for building the index

pub fn set_metric_arg(self, metric_arg: f32) -> IndexParams

The number of iterations searching for kmeans centers during index building.

pub fn set_kmeans_n_iters(self, kmeans_n_iters: u32) -> IndexParams

The number of iterations searching for kmeans centers during index building.

pub fn set_kmeans_trainset_fraction( self, kmeans_trainset_fraction: f64, ) -> IndexParams

If kmeans_trainset_fraction is less than 1, then the dataset is subsampled, and only n_samples * kmeans_trainset_fraction rows are used for training.

pub fn set_add_data_on_build(self, add_data_on_build: bool) -> IndexParams

After training the coarse and fine quantizers, we will populate the index with the dataset if add_data_on_build == true, otherwise the index is left empty, and the extend method can be used to add new vectors to the index.

Trait Implementations

impl Debug for IndexParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for IndexParams

fn drop(&mut self)

Executes the destructor for this type.