文件 IndexReplicas.h

namespace faiss

k-means聚类的多种变体的实现。

版权所有 (c) Facebook, Inc. 及其附属公司。

此源代码根据MIT许可证获得许可,该许可证位于此源代码树的根目录中的LICENSE文件中。

IDSelector 旨在定义要处理的向量子集(用于删除或作为搜索子集)

PQ4 SIMD 打包和累加函数

基本内核累加 nq 查询向量,其中 bbs = nb * 2 * 16 向量,并生成该输出矩阵。 它对于 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

定义了一些对象,这些对象对一组向量应用变换。 这些通常是预处理步骤。

类型定义

using IndexReplicas = IndexReplicasTemplate<Index>
using IndexBinaryReplicas = IndexReplicasTemplate<IndexBinary>
template<typename IndexT>
class IndexReplicasTemplate : public faiss::ThreadedIndex<IndexT>
#include <IndexReplicas.h>

接收单个 faiss::Index 实例,并拆分查询以发送到每个 Index 实例,并在完成后将结果合并在一起。每个索引都由一个单独的 CPU 线程管理。

公共类型

using component_t = typename IndexT::component_t
using distance_t = typename IndexT::distance_t

公共函数

explicit IndexReplicasTemplate(bool threaded = true)

所有子索引必须共享的维度将是添加的第一个子索引的维度

参数:

threaded – 我们是否为每个子索引使用一个线程,或者顺序查询?

explicit IndexReplicasTemplate(idx_t d, bool threaded = true)
参数:
  • d – 所有子索引必须共享的维度

  • threaded – 我们是否为每个子索引使用一个线程,或者顺序查询?

explicit IndexReplicasTemplate(int d, bool threaded = true)

int 版本,因为 int 作为维度的隐式 bool 转换存在歧义

inline void add_replica(IndexT *index)

addIndex() 的别名

inline void remove_replica(IndexT *index)

removeIndex() 的别名

void train(idx_t n, const component_t *x) override

faiss::Index API 所有索引都收到相同的调用

void add(idx_t n, const component_t *x) override

faiss::Index API 所有索引都收到相同的调用

void search(idx_t n, const component_t *x, idx_t k, distance_t *distances, idx_t *labels, const SearchParameters *params = nullptr) const override

faiss::Index API 查询被划分为每个子索引的切片,并由 ceil(n / #indices) 分割成我们的子索引

void reconstruct(idx_t, component_t *v) const override

从第一个索引重建

void syncWithSubIndexes()

将顶层索引(IndexShards)与子索引中的数据同步

保护函数

virtual void onAfterAddIndex(IndexT *index) override

在添加索引后立即调用。

virtual void onAfterRemoveIndex(IndexT *index) override

在删除索引后立即调用。