Struct faiss::index::gpu::GpuIndexImpl

pub struct GpuIndexImpl<'gpu, I> { /* private fields */ }

Native GPU implementation of a Faiss index. GPU indexes in Faiss are first built on the CPU, and subsequently transferred to one or more GPU’s via the into_gpu or to_gpu methods. Calling into_cpu (or to_cpu) enables the user to bring the index back to CPU memory.

When using to_gpu or to_cpu, the indexes will contain the same indexed vectors, but are independent at the point of creation. The use of into_gpu or into_cpu isn’t necessarily faster, but will automatically free the originating index.

The 'gpu lifetime ensures that the GPU resources are in scope for as long as the index lives.

Implementations

impl<'gpu, I> GpuIndexImpl<'gpu, I>where
    I: NativeIndex,
    I: FromInnerPtr,

pub fn to_cpu(&self) -> Result<I>

Transfer the GPU index back to its original CPU implementation.

pub fn into_cpu(self) -> Result<I>

Transfer the GPU index back to its original CPU implementation, freeing the GPU-backed index in the process.

Trait Implementations

impl<'gpu, I: Debug> Debug for GpuIndexImpl<'gpu, I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'g, I> Drop for GpuIndexImpl<'g, I>

fn drop(&mut self)

Executes the destructor for this type.

impl<'gpu, I> Index for GpuIndexImpl<'gpu, I>where
    I: Index,

fn is_trained(&self) -> bool

Whether the Index does not require training, or if training is done already

fn ntotal(&self) -> u64

The total number of vectors indexed

fn d(&self) -> u32

The dimensionality of the indexed vectors

fn metric_type(&self) -> MetricType

The metric type assumed by the index

fn add(&mut self, x: &[f32]) -> Result<()>

Add new data vectors to the index. This assumes a C-contiguous memory slice of vectors, where the total number of vectors is x.len() / d.

fn add_with_ids(&mut self, x: &[f32], xids: &[Idx]) -> Result<()>

Add new data vectors to the index with IDs. This assumes a C-contiguous memory slice of vectors, where the total number of vectors is x.len() / d. Not all index types may support this operation.

fn train(&mut self, x: &[f32]) -> Result<()>

Train the underlying index with the given data.

fn assign(&mut self, query: &[f32], k: usize) -> Result<AssignSearchResult>

Similar to search, but only provides the labels.

fn search(&mut self, query: &[f32], k: usize) -> Result<SearchResult>

Perform a search for the k closest vectors to the given query vectors.

fn range_search(
    &mut self,
    query: &[f32],
    radius: f32
) -> Result<RangeSearchResult>

Perform a ranged search for the vectors closest to the given query vectors by the given radius.

fn reset(&mut self) -> Result<()>

Clear the entire index.

fn remove_ids(&mut self, sel: &IdSelector) -> Result<i64>

Remove data vectors represented by IDs.

impl<'g, I> NativeIndex for GpuIndexImpl<'g, I>where
    I: NativeIndex,

fn inner_ptr(&self) -> *mut FaissIndex

Retrieve a pointer to the native index object.

impl<'g, I> GpuIndex for GpuIndexImpl<'g, I>where
    I: NativeIndex,

impl<'g, I> Send for GpuIndexImpl<'g, I>where
    I: Send,