File IndexIVFIndependentQuantizer.h

namespace faiss

k-means 聚类的一种实现,包含许多变体。

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

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

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

PQ4 SIMD 打包和累积函数

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

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

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

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

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

struct IndexIVFIndependentQuantizer : public faiss::Index
#include <IndexIVFIndependentQuantizer.h>

一个 IVF 索引,其量化器具有与有效负载大小不同的输入维度。要编码的向量通过 VectorTransform 从输入向量中获得。

公共函数

IndexIVFIndependentQuantizer(Index *quantizer, IndexIVF *index_ivf, VectorTransform *vt = nullptr)
inline IndexIVFIndependentQuantizer()
virtual void train(idx_t n, const float *x) override

对代表性的向量集执行训练

参数:
  • n – 训练向量的数量

  • x – 训练向量,大小为 n * d

virtual void add(idx_t n, const float *x) override

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

向量被隐式分配标签 ntotal .. ntotal + n - 1 此函数将输入向量切分成小于 blocksize_add 的块,并调用 add_core。

参数:
  • n – 向量的数量

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

virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override

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

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

参数:
  • n – 向量的数量

  • x – 要搜索的输入向量,大小为 n * d

  • k – 提取的向量数量

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

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

virtual void reset() override

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

~IndexIVFIndependentQuantizer() override

公共成员

Index *quantizer = nullptr

量化器直接与输入向量进行交互

VectorTransform *vt = nullptr

在应用 IVF 向量之前进行转换

IndexIVF *index_ivf = nullptr

IVF 索引,控制 nlist 和 nprobe

bool own_fields = false

*this 是否拥有这 3 个字段