Neighbors Ivf Flat Index Module

Rust module: cuvs::neighbors::ivf_flat::index

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

Index

1
#[derive(Debug)]
2
pub struct Index(ffi::cuvsIvfFlatIndex_t); {
3
    /* private fields */
4
}

IVF-Flat ANN index.

Methods

build

1
pub fn build<T>(res: &Resources, params: &IndexParams, dataset: &T) -> Result<Index>
2
where
3
T: AsDlTensor + ?Sized,

Builds an IVF-Flat index over dataset for efficient search.

dataset is a row-major matrix on the host or device implementing [AsDlTensor]. It is copied into the index, so the caller may free it once this call returns (hence Index carries no lifetime).

Supported dataset/query dtypes in the current C-backed implementation are f32, f16, i8, and u8.

Source: rust/cuvs/src/neighbors/ivf_flat/index.rs:29

search

1
pub fn search<Q, N, D>(
2
&self,
3
res: &Resources,
4
params: &SearchParams,
5
queries: &Q,
6
neighbors: &mut N,
7
distances: &mut D,
8
) -> Result<()>
9
where
10
Q: AsDlTensor + ?Sized,
11
N: AsDlTensorMut + ?Sized,
12
D: AsDlTensorMut + ?Sized,

Searches the index for the k nearest neighbors of each query.

queries, neighbors, and distances must reside in device memory and implement [AsDlTensor] / [AsDlTensorMut]. neighbors receives the neighbor indices and distances their distances; both are written in place.

Source: rust/cuvs/src/neighbors/ivf_flat/index.rs:60

search_filtered

1
pub fn search_filtered<Q, N, D>(
2
&self,
3
res: &Resources,
4
params: &SearchParams,
5
queries: &Q,
6
neighbors: &mut N,
7
distances: &mut D,
8
filter: &Filter<'_, Bitset>,
9
) -> Result<()>
10
where
11
Q: AsDlTensor + ?Sized,
12
N: AsDlTensorMut + ?Sized,
13
D: AsDlTensorMut + ?Sized,

Searches the index with a row-level bitset filter.

Source: rust/cuvs/src/neighbors/ivf_flat/index.rs:80

Source: rust/cuvs/src/neighbors/ivf_flat/index.rs:18