All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
GpuIndexIVFPQ.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 "GpuIndexIVF.h"
#include <vector>
namespace faiss { struct IndexIVFPQ; }
namespace faiss { namespace gpu {
class GpuIndexFlat;
class IVFPQ;
/// IVFPQ index for the GPU
class GpuIndexIVFPQ : public GpuIndexIVF {
public:
/// Construct from a pre-existing faiss::IndexIVFPQ instance, copying
/// data over to the given GPU, if the input index is trained.
GpuIndexIVFPQ(GpuResources* resources,
int device,
IndicesOptions indicesOptions,
bool useFloat16LookupTables,
const faiss::IndexIVFPQ* index);
/// Construct an empty index
GpuIndexIVFPQ(GpuResources* resources,
int device,
int dims,
int nlist,
int subQuantizers,
int bitsPerCode,
bool usePrecomputed,
IndicesOptions indicesOptions,
bool useFloat16LookupTables,
faiss::MetricType metric);
~GpuIndexIVFPQ() override;
/// Reserve space on the GPU for the inverted lists for `num`
/// vectors, assumed equally distributed among
/// Initialize ourselves from the given CPU index; will overwrite
/// all data in ourselves
void copyFrom(const faiss::IndexIVFPQ* index);
/// Copy ourselves to the given CPU index; will overwrite all data
/// in the index instance
void copyTo(faiss::IndexIVFPQ* index) const;
/// Reserve GPU memory in our inverted lists for this number of vectors
void reserveMemory(size_t numVecs);
/// Enable or disable pre-computed codes
void setPrecomputedCodes(bool enable);
/// Are pre-computed codes enabled?
bool getPrecomputedCodes() const;
/// Are float16 residual distance lookup tables enabled?
bool getFloat16LookupTables() const;
/// Return the number of sub-quantizers we are using
int getNumSubQuantizers() const;
/// Return the number of bits per PQ code
int getBitsPerCode() const;
/// Return the number of centroids per PQ code (2^bits per code)
int getCentroidsPerSubQuantizer() const;
/// After adding vectors, one can call this to reclaim device memory
/// to exactly the amount needed. Returns space reclaimed in bytes
size_t reclaimMemory();
/// Clears out all inverted lists, but retains the coarse and
/// product centroid information
void reset() override;
void train(Index::idx_t n, const float* x) override;
/// `x` and `xids` can be resident on the CPU or any GPU; the proper
/// copies are performed
void add_with_ids(Index::idx_t n,
const float* x,
const Index::idx_t* xids) 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;
void set_typename() override;
/// For debugging purposes, return the list length of a particular
/// list
int getListLength(int listId) const;
/// For debugging purposes, return the list codes of a particular
/// list
std::vector<unsigned char> getListCodes(int listId) const;
/// For debugging purposes, return the list indices of a particular
/// list
std::vector<long> getListIndices(int listId) const;
private:
void assertSettings_() const;
void trainResidualQuantizer_(Index::idx_t n, const float* x);
private:
/// Do we use float16 residual distance lookup tables for query?
const bool useFloat16LookupTables_;
/// Number of sub-quantizers per encoded vector
int subQuantizers_;
/// Bits per sub-quantizer code
int bitsPerCode_;
/// Should we or should we not use precomputed codes?
bool usePrecomputed_;
/// Desired inverted list memory reservation
size_t reserveMemoryVecs_;
/// The product quantizer instance that we own; contains the
/// inverted lists
IVFPQ* index_;
};
} } // namespace
faiss::gpu::GpuIndexIVFPQ::getListIndices
std::vector< long > getListIndices(int listId) const
Definition: GpuIndexIVFPQ.cu:428
faiss::gpu::GpuIndexIVFPQ::reset
void reset() override
Definition: GpuIndexIVFPQ.cu:252
faiss::gpu::GpuIndexIVFPQ::getListLength
int getListLength(int listId) const
Definition: GpuIndexIVFPQ.cu:414
faiss::gpu::GpuResources
Definition: GpuResources.h:24
faiss::gpu::GpuIndexIVFPQ::getBitsPerCode
int getBitsPerCode() const
Return the number of bits per PQ code.
Definition: GpuIndexIVFPQ.cu:232
faiss::gpu::GpuIndexIVF
Definition: GpuIndexIVF.h:25
faiss::gpu::GpuIndexIVFPQ::train
void train(Index::idx_t n, const float *x) override
Definition: GpuIndexIVFPQ.cu:307
faiss::gpu::GpuIndexIVFPQ::reclaimMemory
size_t reclaimMemory()
Definition: GpuIndexIVFPQ.cu:242
faiss::IndexIVFPQ
Definition: IndexIVFPQ.h:30
faiss::gpu::GpuIndexIVFPQ::reserveMemory
void reserveMemory(size_t numVecs)
Reserve GPU memory in our inverted lists for this number of vectors.
Definition: GpuIndexIVFPQ.cu:197
faiss::gpu::GpuIndexIVFPQ::copyFrom
void copyFrom(const faiss::IndexIVFPQ *index)
Definition: GpuIndexIVFPQ.cu:92
faiss::Index::idx_t
long idx_t
all indices are this type
Definition: Index.h:64
faiss::gpu::GpuIndexIVFPQ::copyTo
void copyTo(faiss::IndexIVFPQ *index) const
Definition: GpuIndexIVFPQ.cu:149
faiss::gpu::GpuIndexIVFPQ::getFloat16LookupTables
bool getFloat16LookupTables() const
Are float16 residual distance lookup tables enabled?
Definition: GpuIndexIVFPQ.cu:222
faiss::gpu::GpuIndexIVFPQ
IVFPQ index for the GPU.
Definition: GpuIndexIVFPQ.h:25
faiss::gpu::GpuIndexIVFPQ::add_with_ids
void add_with_ids(Index::idx_t n, const float *x, const Index::idx_t *xids) override
Definition: GpuIndexIVFPQ.cu:326
faiss::gpu::GpuIndexIVFPQ::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: GpuIndexIVFPQ.cu:359
faiss::gpu::GpuIndexIVFPQ::getNumSubQuantizers
int getNumSubQuantizers() const
Return the number of sub-quantizers we are using.
Definition: GpuIndexIVFPQ.cu:227
faiss::gpu::GpuIndexIVFPQ::getCentroidsPerSubQuantizer
int getCentroidsPerSubQuantizer() const
Return the number of centroids per PQ code (2^bits per code)
Definition: GpuIndexIVFPQ.cu:237
faiss::gpu::GpuIndexIVFPQ::setPrecomputedCodes
void setPrecomputedCodes(bool enable)
Enable or disable pre-computed codes.
Definition: GpuIndexIVFPQ.cu:206
faiss::gpu::GpuIndexIVFPQ::getPrecomputedCodes
bool getPrecomputedCodes() const
Are pre-computed codes enabled?
Definition: GpuIndexIVFPQ.cu:217
faiss::gpu::GpuIndexIVFPQ::GpuIndexIVFPQ
GpuIndexIVFPQ(GpuResources *resources, int device, IndicesOptions indicesOptions, bool useFloat16LookupTables, const faiss::IndexIVFPQ *index)
Definition: GpuIndexIVFPQ.cu:26
faiss::gpu::IVFPQ
Implementing class for IVFPQ on the GPU.
Definition: IVFPQ.cuh:20
faiss::MetricType
MetricType
Some algorithms support both an inner product vetsion and a L2 search version.
Definition: Index.h:44
faiss::gpu::GpuIndexIVFPQ::getListCodes
std::vector< unsigned char > getListCodes(int listId) const
Definition: GpuIndexIVFPQ.cu:420