文件 IndexRowwiseMinMax.h
-
namespace faiss
实现多种 k 均值聚类变体。
版权所有 (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
定义了一些对向量集合应用变换的对象 通常这些是预处理步骤。
变量
- FAISS_API int rowwise_minmax_sa_encode_bs
执行 sa_encode 和 sa_decode 的块大小
- FAISS_API int rowwise_minmax_sa_decode_bs
-
struct IndexRowwiseMinMaxBase : public faiss::Index
- #include <IndexRowwiseMinMax.h>
提供行式归一化索引的基本功能。
Index 包装器，执行行式归一化到 [0,1]，保留系数。 这只是一个向量编解码器索引。
基本上，这个索引对输入数据集中的每一行进行行向缩放到 [0,1]，然后再调用 subindex::train() 和 subindex::sa_encode()。sa_encode() 调用将缩放系数（scaler 和 minv）存储在每个输出代码的开头。格式为：[scaler][minv][subindex::sa_encode() output]。sa_decode() 中的反缩放使用以下公式完成：output_rescaled = scaler * output + minv
提供了一个额外的 ::train_inplace() 函数，以便在调用 subindex::train() 之前进行原地缩放，从而避免克隆输入数据集，但会由于缩放和缩放回来而修改输入数据集。用户可以自行决定调用此函数而不是 ::train()
派生类为缩放系数提供不同的数据类型。目前，有 fp16 和 fp32 缩放系数的版本可用。
fp16 版本为每个编码向量添加 4 个额外的字节
fp32 版本为每个编码向量添加 8 个额外的字节
被 faiss::IndexRowwiseMinMax, faiss::IndexRowwiseMinMaxFP16 继承
公共函数
-
IndexRowwiseMinMaxBase()
-
~IndexRowwiseMinMaxBase() override
-
virtual void add(idx_t n, const float *x) override
将维度为 d 的 n 个向量添加到索引。
向量被隐式地分配标签 ntotal .. ntotal + n - 1。此函数将输入向量切片成小于 blocksize_add 的块，并调用 add_core。
- 参数：
n – 向量的数量
x – 输入矩阵，大小为 n * d
-
virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
向索引查询维度为 d 的 n 个向量。
最多返回 k 个向量。如果一个查询没有足够的结果，结果数组将用 -1 填充。
- 参数：
n – 向量的数量
x – 要搜索的输入向量，大小为 n * d
k – 提取的向量数
distances – 输出成对距离，大小为 n*k
labels – NNs 的输出标签，大小为 n*k
-
virtual void reset() override
从数据库中删除所有元素。
-
struct IndexRowwiseMinMaxFP16 : public faiss::IndexRowwiseMinMaxBase
- #include <IndexRowwiseMinMax.h>
将缩放系数存储为 fp16 值。
公共函数
-
IndexRowwiseMinMaxFP16()
-
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
-
virtual void add(idx_t n, const float *x) override
将维度为 d 的 n 个向量添加到索引。
向量被隐式地分配标签 ntotal .. ntotal + n - 1。此函数将输入向量切片成小于 blocksize_add 的块，并调用 add_core。
- 参数：
n – 向量的数量
x – 输入矩阵，大小为 n * d
-
virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
向索引查询维度为 d 的 n 个向量。
最多返回 k 个向量。如果一个查询没有足够的结果，结果数组将用 -1 填充。
- 参数：
n – 向量的数量
x – 要搜索的输入向量，大小为 n * d
k – 提取的向量数
distances – 输出成对距离，大小为 n*k
labels – NNs 的输出标签，大小为 n*k
-
virtual void reset() override
从数据库中删除所有元素。
-
IndexRowwiseMinMaxFP16()
-
struct IndexRowwiseMinMax : public faiss::IndexRowwiseMinMaxBase
- #include <IndexRowwiseMinMax.h>
存储缩放系数为fp32值。
公共函数
-
IndexRowwiseMinMax()
-
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
-
virtual void add(idx_t n, const float *x) override
将维度为 d 的 n 个向量添加到索引。
向量被隐式地分配标签 ntotal .. ntotal + n - 1。此函数将输入向量切片成小于 blocksize_add 的块，并调用 add_core。
- 参数：
n – 向量的数量
x – 输入矩阵，大小为 n * d
-
virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params = nullptr) const override
向索引查询维度为 d 的 n 个向量。
最多返回 k 个向量。如果一个查询没有足够的结果，结果数组将用 -1 填充。
- 参数：
n – 向量的数量
x – 要搜索的输入向量，大小为 n * d
k – 提取的向量数
distances – 输出成对距离，大小为 n*k
labels – NNs 的输出标签，大小为 n*k
-
virtual void reset() override
从数据库中删除所有元素。
-
IndexRowwiseMinMax()