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

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

函数

void write_index(const Index *idx, const char *fname, int io_flags = 0)
void write_index(const Index *idx, FILE *f, int io_flags = 0)
void write_index(const Index *idx, IOWriter *writer, int io_flags = 0)
将二进制索引写入文件。
将二进制索引写入文件。
将二进制索引写入 IOWriter。
从文件读取索引。
从 FILE 指针读取索引。
从 IOReader 读取索引。
从文件读取二进制索引。
从 FILE 指针读取二进制索引。
从 IOReader 读取二进制索引。
将 VectorTransform 写入文件。
void write_VectorTransform(const VectorTransform *vt, IOWriter *f)
VectorTransform *read_VectorTransform(const char *fname)
VectorTransform *read_VectorTransform(IOReader *f)
ProductQuantizer *read_ProductQuantizer(const char *fname)
ProductQuantizer *read_ProductQuantizer(IOReader *reader)
void write_ProductQuantizer(const ProductQuantizer *pq, const char *fname)
void write_ProductQuantizer(const ProductQuantizer *pq, IOWriter *f)
void write_InvertedLists(const InvertedLists *ils, IOWriter *f)
InvertedLists *read_InvertedLists(IOReader *reader, int io_flags = 0)

变量

const int IO_FLAG_SKIP_STORAGE = 1

跳过基于图的索引的存储

const int IO_FLAG_READ_ONLY = 2
const int IO_FLAG_ONDISK_SAME_DIR = 4
const int IO_FLAG_SKIP_IVF_DATA = 8
const int IO_FLAG_SKIP_PRECOMPUTE_TABLE = 16
const int IO_FLAG_PQ_SKIP_SDC_TABLE = 32
const int IO_FLAG_MMAP = IO_FLAG_SKIP_IVF_DATA | 0x646f0000