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

Index,它使用一系列 Zn 格量化器对向量进行编码

公共函数

IndexLattice(idx_t d, int nsq, int scale_nbit, int r2)
virtual void train(idx_t n, const float *x) override

对代表性向量集执行训练。

参数:
  • n – 训练向量的数量。

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

virtual size_t sa_code_size() const override

以字节为单位的生成代码的大小。

virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

编码一组向量。

参数:
  • n – 向量的数量。

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

  • bytes – 输出编码向量,大小为 n * sa_code_size()

virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const override

解码一组向量。

参数:
  • n – 向量的数量。

  • bytes – 输入编码向量,大小为 n * sa_code_size()

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

公共成员

int nsq

子向量的数量。

size_t dsq

子向量的维度。

ZnSphereCodecAlt zn_sphere_codec

晶格量化器。

int scale_nbit

用于编码比例的位数,每个子向量。

int lattice_nbit
std::vector<float> trained

每个子量化器的向量范数的最小值和最大值。