All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
GpuIndex.h
/**
* Copyright (c) 2015-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the CC-by-NC license found in the
* LICENSE file in the root directory of this source tree.
*/
// Copyright 2004-present Facebook. All Rights Reserved.
#pragma once
#include "../Index.h"
#include "utils/MemorySpace.h"
namespace faiss { namespace gpu {
class GpuResources;
struct GpuIndexConfig {
inline GpuIndexConfig()
: device(0),
memorySpace(MemorySpace::Device) {
}
/// GPU device on which the index is resident
int device;
/// What memory space to use for primary storae.
/// On Pascal and above (CC 6+) architectures, allows GPUs to use
/// more memory than is available on the GPU.
MemorySpace memorySpace;
};
class GpuIndex : public faiss::Index {
public:
GpuIndex(GpuResources* resources,
int dims,
faiss::MetricType metric,
GpuIndexConfig config);
int getDevice() const {
return device_;
}
GpuResources* getResources() {
return resources_;
}
/// `x` can be resident on the CPU or any GPU; copies are performed
/// as needed
/// Handles paged adds if the add set is too large; calls addInternal_
void add(faiss::Index::idx_t, const float* x) override;
/// `x` and `ids` can be resident on the CPU or any GPU; copies are
/// performed as needed
/// Handles paged adds if the add set is too large; calls addInternal_
void add_with_ids(Index::idx_t n, const float* x, const Index::idx_t* ids)
override;
/// `x`, `distances` and `labels` can be resident on the CPU or any
/// GPU; copies are performed as needed
void search(
faiss::Index::idx_t n,
const float* x,
faiss::Index::idx_t k,
float* distances,
faiss::Index::idx_t* labels) const override;
protected:
/// Handles paged adds if the add set is too large, passes to
/// addImpl_ to actually perform the add for the current page
void addInternal_(Index::idx_t n,
const float* x,
const Index::idx_t* ids);
/// Overridden to actually perform the add
virtual void addImpl_(Index::idx_t n,
const float* x,
const Index::idx_t* ids) = 0;
/// Overridden to actually perform the search
virtual void searchImpl_(faiss::Index::idx_t n,
const float* x,
faiss::Index::idx_t k,
float* distances,
faiss::Index::idx_t* labels) const = 0;
protected:
/// Manages streans, cuBLAS handles and scratch memory for devices
GpuResources* resources_;
/// The GPU device we are resident on
const int device_;
/// The memory space of our primary storage on the GPU
const MemorySpace memorySpace_;
};
} } // namespace
faiss::gpu::GpuIndex::search
void search(faiss::Index::idx_t n, const float *x, faiss::Index::idx_t k, float *distances, faiss::Index::idx_t *labels) const override
Definition: GpuIndex.cu:108
faiss::gpu::GpuIndex::searchImpl_
virtual void searchImpl_(faiss::Index::idx_t n, const float *x, faiss::Index::idx_t k, float *distances, faiss::Index::idx_t *labels) const =0
Overridden to actually perform the search.
faiss::gpu::GpuIndex::addInternal_
void addInternal_(Index::idx_t n, const float *x, const Index::idx_t *ids)
Definition: GpuIndex.cu:73
faiss::gpu::GpuResources
Definition: GpuResources.h:23
faiss::gpu::GpuIndexConfig::device
int device
GPU device on which the index is resident.
Definition: GpuIndex.h:27
faiss::gpu::GpuIndex
Definition: GpuIndex.h:35
faiss::gpu::GpuIndex::add_with_ids
void add_with_ids(Index::idx_t n, const float *x, const Index::idx_t *ids) override
Definition: GpuIndex.cu:66
faiss::gpu::GpuIndexConfig::memorySpace
MemorySpace memorySpace
Definition: GpuIndex.h:32
faiss::gpu::GpuIndex::device_
const int device_
The GPU device we are resident on.
Definition: GpuIndex.h:94
faiss::gpu::GpuIndex::resources_
GpuResources * resources_
Manages streans, cuBLAS handles and scratch memory for devices.
Definition: GpuIndex.h:91
faiss::Index::idx_t
long idx_t
all indices are this type
Definition: Index.h:62
faiss::gpu::GpuIndex::addImpl_
virtual void addImpl_(Index::idx_t n, const float *x, const Index::idx_t *ids)=0
Overridden to actually perform the add.
faiss::gpu::GpuIndex::add
void add(faiss::Index::idx_t, const float *x) override
Definition: GpuIndex.cu:61
faiss::gpu::GpuIndex::memorySpace_
const MemorySpace memorySpace_
The memory space of our primary storage on the GPU.
Definition: GpuIndex.h:97
faiss::gpu::GpuIndexConfig
Definition: GpuIndex.h:20
faiss::Index
Definition: Index.h:60
faiss::MetricType
MetricType
Some algorithms support both an inner product vetsion and a L2 search version.
Definition: Index.h:43