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

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

类型定义

using idx_t = int64_t

所有向量索引都是此类型

枚举

enum MetricType

用于 Faiss 索引和算法的向量比较的度量空间。

大多数算法都支持内积和 L2,其中平面(蛮力)索引支持用于向量比较的其他度量类型。

enumerator METRIC_INNER_PRODUCT

最大内积搜索

enumerator METRIC_L2

平方 L2 搜索

枚举值 METRIC_L1

L1 (又名城市街区)

枚举值 METRIC_Linf

无穷距离

枚举值 METRIC_Lp

L_p 距离, p 由 faiss::Index metric_arg 给出

枚举值 METRIC_Canberra

在 scipy.spatial.distance 中定义的一些附加指标

枚举值 METRIC_BrayCurtis
枚举值 METRIC_JensenShannon
枚举值 METRIC_Jaccard

sum_i(min(a_i, b_i)) / sum_i(max(a_i, b_i)) 其中 a_i, b_i > 0

枚举值 METRIC_NaNEuclidean

平方欧几里得距离,忽略 NaN。

枚举值 METRIC_ABS_INNER_PRODUCT

abs(x | y): 到超平面的距离

函数

constexpr bool is_similarity_metric(MetricType metric_type)

此函数用于区分最小和最大索引,因为我们需要以灵活的方式支持相似性和非相似性度量。