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

均匀量化器具有范围 [vmin, vmax]。 该范围可以对所有维度相同(均匀)或对每个维度特定(默认)。

公共类型

enum QuantizerType

enumerator QT_8bit

每个分量 8 位

enumerator QT_4bit

每个分量 4 位

enumerator QT_8bit_uniform

相同,所有维度共享范围

枚举器 QT_4bit_uniform
枚举器 QT_fp16
枚举器 QT_8bit_direct

uint8 的快速索引

枚举器 QT_6bit

每个分量 6 位

枚举器 QT_bf16
枚举器 QT_8bit_direct_signed

从 [-128 到 127] 范围内的有符号 int8 的快速索引

枚举 RangeStat

统一编码器可以使用不同的统计信息来估计 unform 编码器的可表示值范围。 此处 rs = rangestat_arg

枚举器 RS_minmax

[min - rs*(max-min), max + rs*(max-min)]

枚举器 RS_meanstd

[mean - std * rs, mean + std * rs]

枚举器 RS_quantiles

[Q(rs), Q(1-rs)]

枚举器 RS_optim

重建误差的交替优化

公共函数

ScalarQuantizer(size_t d, QuantizerType qtype)
ScalarQuantizer()
void set_derived_sizes()

基于 qtype 和 d 更新内部值

virtual void train(size_t n, const float *x) override

训练量化器

参数:

x – 训练向量,大小为 n * d

virtual void compute_codes(const float *x, uint8_t *codes, size_t n) const override

编码一组向量

参数:
  • x – 要编码的向量,大小为 n * d

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

virtual void decode(const uint8_t *code, float *x, size_t n) const override

解码一组向量

参数:
  • codes – 要解码的代码,大小为 n * code_size

  • x – 输出向量,大小为 n * d

SQuantizer *select_quantizer() const
SQDistanceComputer *get_distance_computer(MetricType metric = METRIC_L2) const
InvertedListScanner *select_InvertedListScanner(MetricType mt, const Index *quantizer, bool store_pairs, const IDSelector *sel, bool by_residual = false) const

公共成员

QuantizerType qtype = QT_8bit
范围统计方法,默认为 RS_minmax
范围统计参数,默认为 0
size_t bits = 0

每个标量代码的比特数

std::vector<float> trained

训练后的值(包括范围)

SQ距离计算器结构体,继承自 FlatCodesDistanceComputer

公共函数

SQ距离计算器构造函数
虚拟函数,计算查询向量到编码向量的距离
inline virtual float distance_to_code(const uint8_t *code) final

计算当前查询向量到编码向量的距离

公共成员

查询向量
标量量化器结构体

公共函数

虚拟函数,将向量编码为 uint8_t 类型
虚拟函数,将 uint8_t 类型编码解码为向量
标量量化器析构函数