Neighbors Ivf Pq Params Module

Rust module: cuvs::neighbors::ivf_pq::params

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

Builder-pattern parameter types for IVF-PQ build and search.

All setters are optional; unset values retain the library defaults from the underlying C *ParamsCreate functions.

IndexParams

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

Parameters for building an IVF-PQ index.

Methods

Name	Source
`new`	`rust/cuvs/src/neighbors/ivf_pq/params.rs:29`

new

1 #[builder]
2 #[allow(clippy::too_many_arguments)]
3 pub fn new(
4 n_lists: Option<u32>,
5 metric: Option<DistanceType>,
6 kmeans_n_iters: Option<u32>,
7 kmeans_trainset_fraction: Option<f64>,
8 pq_bits: Option<u32>,
9 pq_dim: Option<u32>,
10 codebook_kind: Option<CodebookGen>,
11 codes_layout: Option<ListLayout>,
12 force_random_rotation: Option<bool>,
13 max_train_points_per_pq_code: Option<u32>,
14 add_data_on_build: Option<bool>,
15 ) -> Result<Self, IvfPqError>

Source: rust/cuvs/src/neighbors/ivf_pq/params.rs:29

Source: rust/cuvs/src/neighbors/ivf_pq/params.rs:21

SearchParams

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

Parameters for searching an IVF-PQ index.

Methods

Name	Source
`new`	`rust/cuvs/src/neighbors/ivf_pq/params.rs:143`

new

1 #[builder]
2 pub fn new(
3 n_probes: Option<u32>,
4 lut_dtype: Option<LutDType>,
5 internal_distance_dtype: Option<InternalDistanceDType>,
6 ) -> Result<Self, IvfPqError>

Source: rust/cuvs/src/neighbors/ivf_pq/params.rs:143

Source: rust/cuvs/src/neighbors/ivf_pq/params.rs:136