文件 GpuIndexIVFScalarQuantizer.h
-
namespace faiss
实现了 k-means 聚类，包含多种变体。
版权所有 (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
定义了一些对象，这些对象将变换应用于一组向量。 这些通常是预处理步骤。
-
namespace gpu
-
struct GpuIndexIVFScalarQuantizerConfig : public faiss::gpu::GpuIndexIVFConfig
公共成员
-
bool interleavedLayout = true
使用 IVF 列表的替代内存布局（当前为默认设置）
-
bool interleavedLayout = true
-
class GpuIndexIVFScalarQuantizer : public faiss::gpu::GpuIndexIVF
- #include <GpuIndexIVFScalarQuantizer.h>
围绕 GPU 实现的包装器，看起来像 faiss::IndexIVFScalarQuantizer
公共函数
-
GpuIndexIVFScalarQuantizer(GpuResourcesProvider *provider, const faiss::IndexIVFScalarQuantizer *index, GpuIndexIVFScalarQuantizerConfig config = GpuIndexIVFScalarQuantizerConfig())
从预先存在的 faiss::IndexIVFScalarQuantizer 实例构造，如果输入索引已训练，则将数据复制到给定的 GPU。
-
GpuIndexIVFScalarQuantizer(GpuResourcesProvider *provider, int dims, idx_t nlist, faiss::ScalarQuantizer::QuantizerType qtype, faiss::MetricType metric = MetricType::METRIC_L2, bool encodeResidual = true, GpuIndexIVFScalarQuantizerConfig config = GpuIndexIVFScalarQuantizerConfig())
构造具有空平坦量化器的新实例；用户提供所需的 IVF 列表的数量。
-
GpuIndexIVFScalarQuantizer(GpuResourcesProvider *provider, Index *coarseQuantizer, int dims, idx_t nlist, faiss::ScalarQuantizer::QuantizerType qtype, faiss::MetricType metric = MetricType::METRIC_L2, bool encodeResidual = true, GpuIndexIVFScalarQuantizerConfig config = GpuIndexIVFScalarQuantizerConfig())
构造具有提供的 CPU 或 GPU 粗量化器的新实例；用户提供所需的 IVF 列表的数量。
-
~GpuIndexIVFScalarQuantizer() override
-
void reserveMemory(size_t numVecs)
在我们的倒排列表中为此数量的向量保留 GPU 内存。
-
void copyFrom(const faiss::IndexIVFScalarQuantizer *index)
从给定的 CPU 索引初始化我们自己；将覆盖我们自己的所有数据
-
void copyTo(faiss::IndexIVFScalarQuantizer *index) const
将自身复制到给定的 CPU 索引；将覆盖索引实例中的所有数据
-
size_t reclaimMemory()
添加向量后，可以调用此方法来回收设备内存，使其正好达到所需的量。返回回收的空间，以字节为单位
-
virtual void reset() override
清除所有倒排列表，但保留粗量化器和标量量化器信息
-
virtual void updateQuantizer() override
如果用户手动更改 IVF 粗量化器的状态（例如，替换新实例或在训练范围之外更改粗量化器中的向量），则应调用此方法
-
virtual void train(idx_t n, const float *x) override
根据给定的向量数据训练粗量化器和标量量化器。
受保护的函数
-
void verifySQSettings_() const
验证索引 SQ 参数。
-
void trainResiduals_(idx_t n, const float *x)
从 train 调用以处理 SQ 残差训练。
受保护的属性
-
const GpuIndexIVFScalarQuantizerConfig ivfSQConfig_
我们的配置选项。
-
size_t reserveMemoryVecs_
所需的倒排列表内存保留。
-
std::shared_ptr<IVFFlat> index_
我们拥有的实例；包含倒排列表。
-
GpuIndexIVFScalarQuantizer(GpuResourcesProvider *provider, const faiss::IndexIVFScalarQuantizer *index, GpuIndexIVFScalarQuantizerConfig config = GpuIndexIVFScalarQuantizerConfig())
-
struct GpuIndexIVFScalarQuantizerConfig : public faiss::gpu::GpuIndexIVFConfig
-
namespace gpu