文件 ThreadedIndex.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

定义一些将转换应用于一组向量的对象。 这些通常是预处理步骤。

template<typename IndexT>
class ThreadedIndex : public IndexT
#include <ThreadedIndex.h>

线程集合中索引的持有者。 此类的接口本身不是线程安全的

faiss::IndexReplicasTemplate< IndexT >, faiss::IndexShardsTemplate< IndexT > 继承

公共函数

explicit ThreadedIndex(bool threaded)
explicit ThreadedIndex(int d, bool threaded)
~ThreadedIndex() override
virtual void addIndex(IndexT *index)

覆盖我们自己管理的索引。警告:一旦添加索引,在关闭之前,从任何其他线程(而不是管理它的线程)访问它都是不安全的。请使用 runOnIndex 来执行它的工作。

void removeIndex(IndexT *index)

移除我们自己管理的索引。这将刷新该索引上的所有挂起工作,然后关闭其管理线程,并移除该索引。

void runOnIndex(std::function<void(int, IndexT*)> f)

在索引的管理线程中,对所有索引运行函数。函数参数是(集合中的索引,索引指针)

void runOnIndex(std::function<void(int, const IndexT*)> f) const
void reset() override

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

inline int count() const

返回子索引的数量。

inline IndexT *at(size_t i)

返回第 i 个子索引。

inline const IndexT *at(size_t i) const

返回第 i 个子索引(const 版本)

公共成员

bool own_indices = false

我们是否负责删除包含的索引。

保护函数

virtual void onAfterAddIndex(IndexT *index)

在添加索引后立即调用。

virtual void onAfterRemoveIndex(IndexT *index)

在删除索引后立即调用。

保护属性

std::vector<std::pair<IndexT*, std::unique_ptr<WorkerThread>>> indices_

Index 实例的集合,以及它们的管理工作线程(如果有)。

bool isThreaded_

这个索引是多线程的吗?

保护静态函数

static void waitAndHandleFutures(std::vector<std::future<bool>> &v)