文件 IndexNeuralNetCodec.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
定义一些对一组向量应用变换的对象。 通常,这些是预处理步骤。
-
struct IndexNeuralNetCodec : public faiss::IndexFlatCodes
被 faiss::IndexQINCo 继承
公共函数
-
explicit IndexNeuralNetCodec(int d = 0, int M = 0, int nbits = 0, MetricType metric = METRIC_L2)
-
virtual void train(idx_t n, const float *x) override
对一组具有代表性的向量执行训练。
- 参数:
n – 训练向量的数量
x – 训练向量,大小为 n * d
-
virtual void sa_encode(idx_t n, const float *x, uint8_t *codes) const override
编码一组向量
- 参数:
n – 向量数量
x – 输入向量,大小为 n * d
bytes – 输出编码向量,大小为 n * sa_code_size()
-
virtual void sa_decode(idx_t n, const uint8_t *codes, float *x) const override
解码一组向量
- 参数:
n – 向量数量
bytes – 输入编码向量,大小为 n * sa_code_size()
x – 输出向量,大小为 n * d
-
inline ~IndexNeuralNetCodec()
-
explicit IndexNeuralNetCodec(int d = 0, int M = 0, int nbits = 0, MetricType metric = METRIC_L2)
-
struct IndexQINCo : public faiss::IndexNeuralNetCodec
公共函数
-
IndexQINCo(int d, int M, int nbits, int L, int h, MetricType metric = METRIC_L2)
-
inline ~IndexQINCo()
-
virtual void train(idx_t n, const float *x) override
对一组具有代表性的向量执行训练。
- 参数:
n – 训练向量的数量
x – 训练向量,大小为 n * d
-
virtual void sa_encode(idx_t n, const float *x, uint8_t *codes) const override
编码一组向量
- 参数:
n – 向量数量
x – 输入向量,大小为 n * d
bytes – 输出编码向量,大小为 n * sa_code_size()
-
virtual void sa_decode(idx_t n, const uint8_t *codes, float *x) const override
解码一组向量
- 参数:
n – 向量数量
bytes – 输入编码向量,大小为 n * sa_code_size()
x – 输出向量,大小为 n * d
-
IndexQINCo(int d, int M, int nbits, int L, int h, MetricType metric = METRIC_L2)
-
struct IndexNeuralNetCodec : public faiss::IndexFlatCodes