文件 IndexIVFSpectralHash.h

namespace faiss

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

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

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

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

PQ4 SIMD 打包和累积函数

基本内核将 nq 查询向量与 bbs = nb * 2 * 16 个向量累积,并生成一个输出矩阵。 这对于 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 IndexIVFSpectralHash : public faiss::IndexIVF
#include <IndexIVFSpectralHash.h>

倒排列表,用于存储大小为 nbit 的二进制代码。 在二进制转换之前,向量的维度通过 vt(默认情况下是随机旋转)从维度 d 转换为维度 nbit。

每个坐标都从由 threshold_type 确定的值中减去,并分割成大小为 period 的间隔。 间隔的一半是一个 0 位,另一半是一个 1 位。

公共类型

enum ThresholdType

enumerator Thresh_global

全局阈值为 0

enumerator Thresh_centroid

与质心比较

enumerator Thresh_centroid_half

围绕质心的中心区间

enumerator Thresh_median

训练集的中位数

公共函数

IndexIVFSpectralHash(Index *quantizer, size_t d, size_t nlist, int nbit, float period)
IndexIVFSpectralHash()
virtual void train_encoder(idx_t n, const float *x, const idx_t *assign) override

为向量训练编码器。

如果 by_residual 为真,则使用残差和相应的 assign 数组调用它,否则 x 是原始训练向量,assign=nullptr

virtual void encode_vectors(idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos = false) const override

对一组向量进行编码,使其出现在倒排列表中

参数:
  • list_nos – 由量化器返回的倒排列表 ID(大小为 n)。-1s 被忽略。

  • codes – 输出代码,大小为 n * code_size

  • include_listno – 在代码中包含列表 ID(在这种情况下,将 ceil(log8(nlist)) 添加到代码大小)

virtual InvertedListScanner *get_InvertedListScanner(bool store_pairs, const IDSelector *sel) const override

获取此索引的扫描器(store_pairs 意味着忽略标签)

默认搜索实现使用它来计算距离

void replace_vt(VectorTransform *vt, bool own = false)

替换空(且可能未训练)索引的向量变换

void replace_vt(IndexPreTransform *index, bool own = false)

方便函数从 index_factory 构建的索引中获取 VT(应以“LSH”结尾)

~IndexIVFSpectralHash() override

公共成员

VectorTransform *vt = nullptr

从 d 到 nbit 维的变换

bool own_fields = true

拥有 vt

int nbit = 0

二进制签名的位数

float period = 0

0 和 1 的间隔大小

ThresholdType threshold_type = Thresh_global
std::vector<float> trained

训练好的阈值。大小为 nlist * nbit,如果为 Thresh_global 则为 0