文件 BlockInvertedLists.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 BlockInvertedLists : public faiss::InvertedLists
#include <BlockInvertedLists.h>

按块组织的倒排列表。

与常规倒排列表不同,代码按大小为 block_size 字节的块组织,这些块表示一组 n_per_block。 因此,代码分配总是向上舍入到 block_size 字节。 代码也对齐在 32 字节边界上,以便与 SIMD 一起使用。

为避免误解,即使可以说代码消耗的内存量是 block_size / n_per_block,code_size 也设置为 (size_t)(-1)。

写入函数 add_entries 和 update_entries 在块对齐的数据上运行。

公共函数

BlockInvertedLists(size_t nlist, size_t vec_per_block, size_t block_size)
BlockInvertedLists(size_t nlist, const CodePacker *packer)
BlockInvertedLists()
virtual size_t list_size(size_t list_no) const override

获取列表的大小

virtual const uint8_t *get_codes(size_t list_no) const override

获取倒排列表的代码,必须由 release_codes 释放

返回值:

codes 大小 list_size * code_size

virtual const idx_t *get_ids(size_t list_no) const override

获取倒排列表的 ID,必须由 release_ids 释放

返回值:

ids 大小 list_size

size_t remove_ids(const IDSelector &sel)

InvertedLists 中删除 ID

virtual size_t add_entries(size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override
virtual void update_entries(size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override

未实现

virtual void resize(size_t list_no, size_t new_size) override
~BlockInvertedLists() override

公共成员

size_t n_per_block = 0
size_t block_size = 0
const CodePacker *packer = nullptr
std::vector<AlignedTable<uint8_t>> codes
std::vector<std::vector<idx_t>> ids
struct BlockInvertedListsIOHook : public faiss::InvertedListsIOHook

公共函数

BlockInvertedListsIOHook()
virtual void write(const InvertedLists *ils, IOWriter *f) const override

将索引写入 IOWriter (包括 fourcc)

virtual InvertedLists *read(IOReader *f, int io_flags) const override

当 fourcc 与此类的 fourcc 匹配时调用