文件 Index2Layer.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

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

变量

FAISS_API int index2layer_sa_encode_bs
struct Index2Layer : public faiss::IndexFlatCodes
#include <Index2Layer.h>

与没有倒排列表的 IndexIVFPQ 相同:代码按顺序存储

该类主要用于存储可以随机访问的编码向量,未实现搜索功能。

公共函数

Index2Layer(Index *quantizer, size_t nlist, int M, int nbit = 8, MetricType metric = METRIC_L2)
Index2Layer()
~Index2Layer()
virtual void train(idx_t n, const float *x) override

在具有代表性的向量集上执行训练

参数:
  • 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

未实现

virtual DistanceComputer *get_distance_computer() const override

获取此类型索引的 DistanceComputer (在 AuxIndexStructures 中定义) 对象。

DistanceComputer 是为支持随机访问其向量的索引实现的。

void transfer_to_IVFPQ(IndexIVFPQ &other) const

将平面代码传输到 IVFPQ 索引

virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

编码一组向量

参数:
  • n – 向量的数量

  • x – 输入向量,大小为 n * d

  • bytes – 输出编码向量,大小为 n * sa_code_size()

virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const override

解码一组向量

参数:
  • n – 向量的数量

  • bytes – 输入编码向量,大小为 n * sa_code_size()

  • x – 输出向量,大小为 n * d

公共成员

Level1Quantizer q1

第一级量化器

ProductQuantizer pq

第二级量化器始终是 PQ

size_t code_size_1

第一级的代码大小 (ceil(log8(q1.nlist)))

size_t code_size_2

第二级的代码大小