Neighbors Ivf Flat Params Module

View as Markdown

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

pub struct IndexParams {
/* private fields */
}

Parameters for building an IVF-Flat index.

Methods

NameSource
newrust/cuvs/src/neighbors/ivf_flat/params.rs:28

new

#[builder]
pub fn new(
n_lists: Option<u32>,
metric: Option<DistanceType>,
kmeans_n_iters: Option<u32>,
kmeans_trainset_fraction: Option<f64>,
add_data_on_build: Option<bool>,
) -> Result<Self, IvfFlatError>

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

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

SearchParams

pub struct SearchParams {
/* private fields */
}

Parameters for searching an IVF-Flat index.

Methods

NameSource
newrust/cuvs/src/neighbors/ivf_flat/params.rs:102

new

#[builder]
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