File IndexLSH.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 IndexLSH : public faiss::IndexFlatCodes
#include <IndexLSH.h>

每个向量分量的符号都放在二进制签名中

公共函数

IndexLSH(idx_t d, int nbits, bool rotate_data = true, bool train_thresholds = false)
const float *apply_preprocess(idx_t n, const float *x) const

预处理输入并调整其大小以符合二值化数据所需的大小

参数:

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

返回值:

输出向量,大小为 n * bits。 可能与 x 指向同一地址,否则应由调用者删除

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

通过解码实现的搜索

void transfer_thresholds(LinearTransform *vt)

将阈值转移到预处理阶段(并取消设置 train_thresholds)

inline ~IndexLSH() override
IndexLSH()
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

公共成员

int nbits

每个向量的位数

bool rotate_data

是否对输入应用随机旋转

bool train_thresholds

我们是否训练阈值或使用 0

RandomRotationMatrix rrot

可选的随机旋转

std::vector<float> thresholds

要比较的阈值