Neighbors Ivf Flat Params Module

Rust module: cuvs::neighbors::ivf_flat::params

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

Builder-pattern parameter types for IVF-Flat 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-Flat index.

Methods

new

1
#[builder]
2
pub fn new(
3
n_lists: Option<u32>,
4
metric: Option<DistanceType>,
5
kmeans_n_iters: Option<u32>,
6
kmeans_trainset_fraction: Option<f64>,
7
add_data_on_build: Option<bool>,
8
) -> Result<Self, IvfFlatError>

Source: rust/cuvs/src/neighbors/ivf_flat/params.rs:28

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

SearchParams

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

Parameters for searching an IVF-Flat index.

Methods

new

1
#[builder]
2
pub fn new(n_probes: Option<u32>) -> Result<Self, IvfFlatError>

Source: rust/cuvs/src/neighbors/ivf_flat/params.rs:102

Source: rust/cuvs/src/neighbors/ivf_flat/params.rs:95