cuVS Neighbors Cagra Params

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

1 pub struct CompressionParams {
2     /* private fields */
3 }

VPQ (Vector-Product Quantization) compression parameters.

Attach to [IndexParams] to enable compressed dataset storage.

Methods

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

new

1 #[builder]
2 pub fn new(
3 pq_bits: Option<u32>,
4 pq_dim: Option<u32>,
5 vq_n_centers: Option<u32>,
6 kmeans_n_iters: Option<u32>,
7 vq_kmeans_trainset_fraction: Option<f64>,
8 pq_kmeans_trainset_fraction: Option<f64>,
9 ) -> Result<Self, CagraError>

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

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

IndexParams

1 pub struct IndexParams {
2     /* private fields */
3 }

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

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

new

1 #[builder]
2 pub fn new(
3 metric: Option<DistanceType>,
4 intermediate_graph_degree: Option<usize>,
5 graph_degree: Option<usize>,
6 compression: Option<CompressionParams>,
7 #[builder(setters(vis = "", some_fn = graph_build_internal))] graph_build: Option<
8 RequestedGraphBuild,
9 >,
10 ) -> Result<Self, CagraError>

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

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

SearchParams

1 pub struct SearchParams {
2     /* private fields */
3 }

Parameters for searching a CAGRA index.

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

Methods

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

new

1 #[builder]
2 #[allow(clippy::too_many_arguments)]
3 pub fn new(
4 max_queries: Option<usize>,
5 itopk_size: Option<usize>,
6 max_iterations: Option<usize>,
7 algo: Option<SearchAlgo>,
8 team_size: Option<usize>,
9 min_iterations: Option<usize>,
10 thread_block_size: Option<usize>,
11 hashmap_mode: Option<HashMode>,
12 hashmap_min_bitlen: Option<usize>,
13 hashmap_max_fill_rate: Option<f32>,
14 num_random_samplings: Option<u32>,
15 rand_xor_mask: Option<u64>,
16 ) -> Result<Self, CagraError>

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

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

impl IndexParamsBuilder

1 impl IndexParamsBuilder

Methods

Name	Source
`auto`	`rust/cuvs/src/neighbors/cagra/params.rs:214`
`nn_descent`	`rust/cuvs/src/neighbors/cagra/params.rs:221`
`nn_descent_with_iterations`	`rust/cuvs/src/neighbors/cagra/params.rs:228`
`iterative_cagra_search`	`rust/cuvs/src/neighbors/cagra/params.rs:238`
`ace`	`rust/cuvs/src/neighbors/cagra/params.rs:245`
`ivf_pq`	`rust/cuvs/src/neighbors/cagra/params.rs:252`

auto

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

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

nn_descent

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

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

nn_descent_with_iterations

1 pub fn nn_descent_with_iterations(
2 self,
3 iterations: usize,
4 ) -> IndexParamsBuilder<SetGraphBuild<S>>
5 where
6 S::GraphBuild: IsUnset,

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

iterative_cagra_search

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

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

ace

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

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

ivf_pq

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

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

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