API ReferenceRust API Documentation

Neighbors Cagra Params Module

View as Markdown

Rust module: cuvs::neighbors::cagra::params

Source: rust/cuvs/src/neighbors/cagra/params.rs

Builder-pattern parameter types for CAGRA index build and search.

Each parameter type owns its C params handle directly. The generated bon builder configures that handle in the constructor, so there is no duplicate Rust field-bag to keep in sync with the FFI state. All setters are optional; unset values retain the library defaults from the underlying C *ParamsCreate functions. Out-of-range values are rejected by build() with [CagraError::Validation].

CompressionParams

pub struct CompressionParams {
    /* private fields */
}

VPQ (Vector-Product Quantization) compression parameters.

Attach to [IndexParams] to enable compressed dataset storage.

Methods

NameSource
newrust/cuvs/src/neighbors/cagra/params.rs:39

new

#[builder]
pub fn new(
pq_bits: Option<u32>,
pq_dim: Option<u32>,
vq_n_centers: Option<u32>,
kmeans_n_iters: Option<u32>,
vq_kmeans_trainset_fraction: Option<f64>,
pq_kmeans_trainset_fraction: Option<f64>,
) -> Result<Self, CagraError>

Source: rust/cuvs/src/neighbors/cagra/params.rs:39

Source: rust/cuvs/src/neighbors/cagra/params.rs:32

IndexParams

pub struct IndexParams {
    /* private fields */
}

Parameters for building a CAGRA index.

use cuvs::neighbors::cagra::IndexParams;
use cuvs::distance::DistanceType;
let params = IndexParams::builder()
.metric(DistanceType::InnerProduct)
.graph_degree(64)
.build()?;

Methods

NameSource
newrust/cuvs/src/neighbors/cagra/params.rs:153

new

#[builder]
pub fn new(
metric: Option<DistanceType>,
intermediate_graph_degree: Option<usize>,
graph_degree: Option<usize>,
compression: Option<CompressionParams>,
#[builder(setters(vis = "", some_fn = graph_build_internal))] graph_build: Option<
RequestedGraphBuild,
>,
) -> Result<Self, CagraError>

Source: rust/cuvs/src/neighbors/cagra/params.rs:153

Source: rust/cuvs/src/neighbors/cagra/params.rs:142

SearchParams

pub struct SearchParams {
    /* private fields */
}

Parameters for searching a CAGRA index.

use cuvs::neighbors::cagra::SearchParams;
let params = SearchParams::builder().itopk_size(128).build()?;

Methods

NameSource
newrust/cuvs/src/neighbors/cagra/params.rs:340

new

#[builder]
#[allow(clippy::too_many_arguments)]
pub fn new(
max_queries: Option<usize>,
itopk_size: Option<usize>,
max_iterations: Option<usize>,
algo: Option<SearchAlgo>,
team_size: Option<usize>,
min_iterations: Option<usize>,
thread_block_size: Option<usize>,
hashmap_mode: Option<HashMode>,
hashmap_min_bitlen: Option<usize>,
hashmap_max_fill_rate: Option<f32>,
num_random_samplings: Option<u32>,
rand_xor_mask: Option<u64>,
) -> Result<Self, CagraError>

Source: rust/cuvs/src/neighbors/cagra/params.rs:340

Source: rust/cuvs/src/neighbors/cagra/params.rs:332

impl IndexParamsBuilder

impl IndexParamsBuilder

Methods

NameSource
autorust/cuvs/src/neighbors/cagra/params.rs:214
nn_descentrust/cuvs/src/neighbors/cagra/params.rs:221
nn_descent_with_iterationsrust/cuvs/src/neighbors/cagra/params.rs:228
iterative_cagra_searchrust/cuvs/src/neighbors/cagra/params.rs:238
acerust/cuvs/src/neighbors/cagra/params.rs:245
ivf_pqrust/cuvs/src/neighbors/cagra/params.rs:252

auto

pub fn auto(self) -> IndexParamsBuilder<SetGraphBuild<S>>
where
S::GraphBuild: IsUnset,

Source: rust/cuvs/src/neighbors/cagra/params.rs:214

nn_descent

pub fn nn_descent(self) -> IndexParamsBuilder<SetGraphBuild<S>>
where
S::GraphBuild: IsUnset,

Source: rust/cuvs/src/neighbors/cagra/params.rs:221

nn_descent_with_iterations

pub fn nn_descent_with_iterations(
self,
iterations: usize,
) -> IndexParamsBuilder<SetGraphBuild<S>>
where
S::GraphBuild: IsUnset,

Source: rust/cuvs/src/neighbors/cagra/params.rs:228

pub fn iterative_cagra_search(self) -> IndexParamsBuilder<SetGraphBuild<S>>
where
S::GraphBuild: IsUnset,

Source: rust/cuvs/src/neighbors/cagra/params.rs:238

ace

pub fn ace(self) -> IndexParamsBuilder<SetGraphBuild<S>>
where
S::GraphBuild: IsUnset,

Source: rust/cuvs/src/neighbors/cagra/params.rs:245

ivf_pq

pub fn ivf_pq(self) -> IndexParamsBuilder<SetGraphBuild<S>>
where
S::GraphBuild: IsUnset,

Source: rust/cuvs/src/neighbors/cagra/params.rs:252

Source: rust/cuvs/src/neighbors/cagra/params.rs:213