Neighbors Ivf Flat Module

View as Markdown

Rust module: cuvs::neighbors::ivf_flat

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

IVF-Flat: an inverted-file index over uncompressed (“flat”) vectors. It partitions the dataset into n_lists clusters and, at query time, scans only the n_probes closest clusters — a simple knob to trade recall for speed.

Build an [Index] from a dataset, then search it with device-resident queries and output buffers. Tensors are borrowed through the AsDlTensor / AsDlTensorMut traits; see the dlpack module for the tensor model and examples/cagra.rs for the same build/search workflow.

crate::neighbors::filters::{Bitset, Filter}

1pub use crate::neighbors::filters::{Bitset, Filter};

Source: rust/cuvs/src/neighbors/ivf_flat/mod.rs:19

index::Index

1pub use index::Index;

Source: rust/cuvs/src/neighbors/ivf_flat/mod.rs:20

params::{IndexParams, SearchParams}

1pub use params::{IndexParams, SearchParams};

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

IvfFlatError

1#[derive(Debug, thiserror::Error)]
2#[non_exhaustive]
3pub enum IvfFlatError {
4 /* variants omitted */
5}

Error type for IVF-Flat operations.

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