Vamana Index Params Module

Rust module: cuvs::vamana::index_params

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

IndexParams

1
pub struct IndexParams(pub ffi::cuvsVamanaIndexParams_t);

Methods

new

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

Returns a new IndexParams

Source: rust/cuvs/src/vamana/index_params.rs:15

set_metric

1
pub fn set_metric(self, metric: DistanceType) -> IndexParams { ... }

DistanceType to use for building the index

Source: rust/cuvs/src/vamana/index_params.rs:24

set_graph_degree

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

Maximum degree of output graph corresponds to the R parameter in the original Vamana literature.

Source: rust/cuvs/src/vamana/index_params.rs:33

set_visited_size

1
pub fn set_visited_size(self, visited_size: u32) -> IndexParams { ... }

Maximum number of visited nodes per search corresponds to the L parameter in the Vamana literature

Source: rust/cuvs/src/vamana/index_params.rs:42

set_vamana_iters

1
pub fn set_vamana_iters(self, vamana_iters: f32) -> IndexParams { ... }

Number of Vamana vector insertion iterations (each iteration inserts all vectors).

Source: rust/cuvs/src/vamana/index_params.rs:50

set_alpha

1
pub fn set_alpha(self, alpha: f32) -> IndexParams { ... }

Alpha for pruning parameter

Source: rust/cuvs/src/vamana/index_params.rs:58

set_max_fraction

1
pub fn set_max_fraction(self, max_fraction: f32) -> IndexParams { ... }

Maximum fraction of dataset inserted per batch. Larger max batch decreases graph quality, but improves speed

Source: rust/cuvs/src/vamana/index_params.rs:67

set_batch_base

1
pub fn set_batch_base(self, batch_base: f32) -> IndexParams { ... }

Base of growth rate of batch sizes

Source: rust/cuvs/src/vamana/index_params.rs:75

set_queue_size

1
pub fn set_queue_size(self, queue_size: u32) -> IndexParams { ... }

Size of candidate queue structure - should be (2^x)-1

Source: rust/cuvs/src/vamana/index_params.rs:83

set_reverse_batchsize

1
pub fn set_reverse_batchsize(self, reverse_batchsize: u32) -> IndexParams { ... }

Max batchsize of reverse edge processing (reduces memory footprint)

Source: rust/cuvs/src/vamana/index_params.rs:91

Source: rust/cuvs/src/vamana/index_params.rs:11