文件 GpuIndexBinaryFlat.h

namespace faiss

实现了具有多种变体的 k-means 聚类。

版权所有 (c) Facebook, Inc. 及其附属公司。

此源代码已根据 MIT 许可证获得许可,该许可证位于此源树的根目录中的 LICENSE 文件中。

IDSelector 旨在定义要处理的向量子集(用于删除或作为搜索的子集)

PQ4 SIMD 打包和累积函数

基本内核使用 bbs = nb * 2 * 16 向量累积 nq 查询向量,并为此生成输出矩阵。 当 nq * nb <= 4 时很有用,否则寄存器溢出变得太大。

这些函数的实现分布在 3 个 cpp 文件中,以减少并行编译时间。 模板被显式实例化。

此文件包含用于计算距离的内核的回调。

在整个库中,向量作为 float * 指针提供。 当批量处理(添加/搜索)多个向量时,大多数算法都可以得到优化。 在这种情况下,它们作为矩阵传入。 当 n 个大小为 d 的向量作为 float * x 提供时,向量 i 的分量 j 为

x[ i * d + j ]

其中 0 <= i < n 且 0 <= j < d。 换句话说,矩阵始终是紧凑的。 在指定矩阵的大小时,我们称其为 n*d 矩阵,这意味着行优先存储。

I/O 函数可以读取/写入到文件名、文件句柄或抽象介质的对象。

读取函数返回应该使用 delete 释放的对象。 这些对象中的所有引用都归对象所有。

倒排列表的定义 + 一些实现该接口的常见类。

由于 IVF(倒排文件)索引对于大规模用例非常有用,因此我们将与它们相关的一些函数分组到这个小库中。 大多数函数都可以在 IndexIVF 和嵌入在 IndexPreTransform 中的 IndexIVF 上工作。

此文件中实现了 L2 和内积之外的额外度量标准

实现了一些神经网络层,主要用于支持 QINCo

定义一些将变换应用于一组向量的对象。 通常这些是预处理步骤。

namespace gpu
struct GpuIndexBinaryFlatConfig : public faiss::gpu::GpuIndexConfig
class GpuIndexBinaryFlat : public faiss::IndexBinary
#include <GpuIndexBinaryFlat.h>

IndexBinaryFlat 的 GPU 版本,用于通过汉明距离暴力比较位向量

公共函数

GpuIndexBinaryFlat(GpuResourcesProvider *resources, const faiss::IndexBinaryFlat *index, GpuIndexBinaryFlatConfig config = GpuIndexBinaryFlatConfig())

从预先存在的 faiss::IndexBinaryFlat 实例构造,将数据复制到给定的 GPU

GpuIndexBinaryFlat(GpuResourcesProvider *resources, int dims, GpuIndexBinaryFlatConfig config = GpuIndexBinaryFlatConfig())

构造一个可以添加到的空实例。

~GpuIndexBinaryFlat() override
int getDevice() const

返回此索引所在的设备。

std::shared_ptr<GpuResources> getResources()

返回对我们的 GpuResources 对象的引用,该对象管理 GPU 上的内存、流和句柄资源

void copyFrom(const faiss::IndexBinaryFlat *index)

从给定的 CPU 索引初始化自身; 将覆盖自身中的所有数据

void copyTo(faiss::IndexBinaryFlat *index) const

将自身复制到给定的 CPU 索引; 将覆盖索引实例中的所有数据

virtual void add(faiss::idx_t n, const uint8_t *x) override

将维度为 d 的 n 个向量添加到索引。

向量被隐式分配标签 ntotal .. ntotal + n - 1

参数:

x – 输入矩阵,大小为 n * d / 8

virtual void reset() override

从数据库中删除所有元素。

virtual void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, faiss::idx_t *labels, const faiss::SearchParameters *params = nullptr) const override

将维度为 d 的 n 个向量查询到索引。

最多返回 k 个向量。 如果查询的结果不足,则结果数组将填充 -1。

参数:
  • x – 要搜索的输入向量,大小为 n * d / 8

  • labels – NN 的输出标签,大小为 n*k

  • distances – 输出的成对距离,大小为 n*k

virtual void reconstruct(faiss::idx_t key, uint8_t *recons) const override

重建存储的向量。

对于某些索引,可能未定义此函数。

参数:
  • key – 要重建的向量的 ID

  • recons – 重建的向量(大小 d / 8)

受保护的函数

void searchFromCpuPaged_(idx_t n, const uint8_t *x, int k, int32_t *outDistancesData, idx_t *outIndicesData) const

当输入数据位于 CPU 上时从搜索调用; 可能允许使用固定内存

void searchNonPaged_(idx_t n, const uint8_t *x, int k, int32_t *outDistancesData, idx_t *outIndicesData) const

受保护的属性

std::shared_ptr<GpuResources> resources_

管理设备的流、cuBLAS 句柄和暂存内存。

const GpuIndexBinaryFlatConfig binaryFlatConfig_

配置选项。

std::unique_ptr<BinaryFlatIndex> data_

保存包含向量列表的 GPU 数据。