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

具有附加 PQ 细化级别的 Index

公共函数

IndexIVFPQR(Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits_per_idx, size_t M_refine, size_t nbits_per_idx_refine)
virtual void reset() override

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

virtual size_t remove_ids(const IDSelector &sel) override

数据集操作函数。

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

训练两个乘积量化器

virtual idx_t train_encoder_num_vectors() const override

可以被子类重新定义,以指示它们需要多少训练向量

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

调用 encode_vectors 的默认实现

virtual void add_core(idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context = nullptr) override

与 add_with_ids 相同,但可以选择使用预计算的列表 ID

virtual void reconstruct_from_offset(int64_t list_no, int64_t offset, float *recons) const override

根据(逆列表索引 + 逆列表偏移)而不是 ID 重构向量。

当不维护 direct_map 并且通过 search_preassigned()store_pairs 设置时计算 inv 列表偏移量时很有用。

virtual void merge_from(Index &otherIndex, idx_t add_id) override

将条目从另一个数据集移动到 self。在输出时,other 为空。 add_id 被添加到所有移动的 ID(对于顺序 ID,这将是 this->ntotal)

virtual void search_preassigned(idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params = nullptr, IndexIVFStats *stats = nullptr) const override

搜索一组向量,这些向量已由 IVF 量化器预先量化。用查询结果填充相应的堆。默认实现使用 InvertedListScanners 进行搜索。

参数:
  • n – 要查询的向量数

  • x – 查询向量,大小为 nx * d

  • assign – 粗量化索引,大小为 nx * nprobe

  • centroid_dis – 到粗糙质心的距离,大小为 nx * nprobe

  • distance – 输出距离,大小为 n * k

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

  • store_pairs – 将倒排列表索引 + 倒排列表偏移量存储在结果的高/低 32 位中,而不是存储 ID(用于重新排序)。

  • params – 用于覆盖对象的搜索参数

  • stats – 要更新的搜索统计信息(可以为空)

IndexIVFPQR()

公共成员

ProductQuantizer refine_pq

第三级量化器

std::vector<uint8_t> refine_codes

相应的代码

float k_factor

搜索中请求的 k 与从 IVFPQ 请求的 k 之间的因子