结构体 faiss::IndexIVF

struct IndexIVF : public faiss::Index, public faiss::IndexIVFInterface

基于倒排文件 (IVF) 的 Index

在倒排文件中，量化器（一个 Index 实例）为每个要添加的向量提供一个量化索引。量化索引映射到一个列表（也称为倒排列表或 posting list），向量的 ID 存储在该列表中。

倒排列表对象仅在训练后才需要。 如果没有从外部设置，则会自动使用 ArrayInvertedLists。

在搜索时，要搜索的向量也会被量化，并且只搜索与量化索引相对应的列表。 这通过使其成为非穷举搜索来加速搜索。 可以使用多探针搜索来放宽这一点：选择几个 (nprobe) 量化索引，并访问几个倒排列表。

子类实现了索引的后过滤，从而改进了从查询到数据库向量的距离估计。

被 faiss::IndexIVFAdditiveQuantizer, faiss::IndexIVFFastScan, faiss::IndexIVFFlat, faiss::IndexIVFPQ, faiss::IndexIVFScalarQuantizer, faiss::IndexIVFSpectralHash 继承

公共类型

using component_t = float

using distance_t = float

公共函数

IndexIVF(Index *quantizer, size_t d, size_t nlist, size_t code_size, MetricType metric = METRIC_L2)

倒排文件在输入端采用量化器（一个 Index），该量化器实现将向量映射到列表标识符的函数。

virtual void reset() override

从数据库中删除所有元素。

virtual void train(idx_t n, const float *x) override

训练量化器并调用 train_encoder 来训练子量化器。

virtual void add(idx_t n, const float *x) override

使用 NULL id 调用 add_with_ids。

virtual void add_with_ids(idx_t n, const float *x, const idx_t *xids) override

调用 encode_vectors 的默认实现

virtual void add_core(idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context = nullptr)

向量加法的实现，其中向量分配是预定义的。默认实现将代码提取交给 encode_vectors。

参数:

precomputed_idx – 输入向量的量化索引（大小为 n）

virtual void encode_vectors(idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno = false) const = 0

编码一组向量，使其出现在倒排列表中

参数:

• list_nos – 量化器返回的倒排列表 ID（大小为 n）。-1s 被忽略。

• codes – 输出码，大小为 n * code_size

• include_listno – 在码中包含列表 ID（在这种情况下，将 ceil(log8(nlist)) 添加到码的大小）

virtual void add_sa_codes(idx_t n, const uint8_t *codes, const idx_t *xids) override

添加使用独立编解码器计算的向量

参数:

• codes – 要添加的代码，大小为 n * sa_code_size()

• xids – 相应的ID，大小为n

virtual void train_encoder(idx_t n, const float *x, const idx_t *assign)

训练向量的编码器。

如果 by_residual 为真，则它会被使用残差和相应的 assign 数组调用，否则 x 是原始训练向量并且 assign=nullptr

virtual idx_t train_encoder_num_vectors() const

可以被子类重新定义，以指示他们需要多少训练向量

virtual void search_preassigned(idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params = nullptr, IndexIVFStats *stats = nullptr) const override

搜索一组由 IVF 量化器预量化的向量。 用查询结果填充相应的堆。 默认实现使用 InvertedListScanners 进行搜索。

参数:

• n – 要查询的向量数

• x – 查询向量，大小为 nx * d

• assign – 粗量化索引，大小为 nx * nprobe

• centroid_dis – 到粗糙质心的距离，大小为 nx * nprobe

• distance – 输出距离，大小为 n * k

• labels – 输出标签，大小为 n * k

• store_pairs – 将inv列表索引 + inv列表偏移量存储在结果的upper/lower 32位中，而不是ID（用于重新排序）。

• params – 用于覆盖对象的搜索参数

• stats – 要更新的搜索统计信息（可以为 null）

virtual void range_search_preassigned(idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs = false, const IVFSearchParameters *params = nullptr, IndexIVFStats *stats = nullptr) const override

范围搜索一组由 IVF 量化器预量化的向量。 填写 RangeSearchResults 结果。 默认实现使用 InvertedListScanners 进行搜索。

参数:

• n – 要查询的向量数

• x – 查询向量，大小为 nx * d

• assign – 粗量化索引，大小为 nx * nprobe

• centroid_dis – 到粗糙质心的距离，大小为 nx * nprobe

• result – 输出结果

• store_pairs – 将inv列表索引 + inv列表偏移量存储在结果的upper/lower 32位中，而不是ID（用于重新排序）。

• params – 用于覆盖对象的搜索参数

• stats – 要更新的搜索统计信息（可以为 null）

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

分配向量，然后调用 search_preassign

virtual void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params = nullptr) const override

查询索引中维度为 d 的 n 个向量。

返回所有距离 < radius 的向量。请注意，许多索引不实现 range_search（只有 k-NN 搜索是强制性的）。

参数:

• n – 向量数量

• x – 要搜索的输入向量，大小为 n * d

• radius – 搜索半径

• result – 结果表

virtual InvertedListScanner *get_InvertedListScanner(bool store_pairs = false, const IDSelector *sel = nullptr) const

获取此索引的扫描器（store_pairs 意味着忽略标签）

默认搜索实现使用它来计算距离

virtual void reconstruct(idx_t key, float *recons) const override

重建向量。 仅当 maintain_direct_map 设置为 1 或 2 时才有效

virtual void update_vectors(int nv, const idx_t *idx, const float *v)

更新向量的子集。

索引必须具有 direct_map

参数:

• nv – 要更新的向量数

• idx – 要更新的向量索引，大小为 nv

• v – 新值的向量，大小为 nv*d

virtual void reconstruct_n(idx_t i0, idx_t ni, float *recons) const override

重建索引向量的子集。

覆盖默认实现以绕过 reconstruct()，这需要维护 direct_map。

参数:

• i0 – 要重建的第一个向量

• ni – 要重建的向量数

• recons – 重建向量的输出数组，大小为 ni * d

virtual void search_and_reconstruct(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params = nullptr) const override

与搜索类似，但还会为搜索结果重建存储的向量（或在有损编码的情况下进行近似）。

覆盖默认实现以避免必须维护 direct_map，而是通过 search_preassigned() 中的 store_pairs 标志获取代码偏移量。

参数:

recons – 重建向量的大小 (n, k, d)

void search_and_return_codes(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno = false, const SearchParameters *params = nullptr) const

类似于搜索，但也会返回搜索结果中存储向量对应的代码。

参数:

• codes – 代码 (n, k, code_size)

• include_listno – 在码中包含列表 ID（在这种情况下，将 ceil(log8(nlist)) 添加到码的大小）

virtual void reconstruct_from_offset(int64_t list_no, int64_t offset, float *recons) const

根据位置（索引列表索引 + 索引列表偏移）而不是ID重建向量。

当direct_map未维护，并且索引列表偏移由 search_preassigned() 与 store_pairs 设置一起计算时，此方法很有用。

virtual size_t remove_ids(const IDSelector &sel) override

数据集操作函数。

virtual void check_compatible_for_merge(const Index &otherIndex) const override

检查两个索引是否兼容（即，它们以相同的方式进行训练并具有相同的参数）。 否则抛出异常。

virtual void merge_from(Index &otherIndex, idx_t add_id) override

将条目从另一个数据集移动到自身。 输出时，other 为空。 add_id 将被添加到所有移动的 ID 中（对于顺序 ID，这将是 this->ntotal）

virtual CodePacker *get_CodePacker() const

virtual void copy_subset_to(IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const

将索引条目的一个子集复制到另一个索引，有关 subset_type 的含义，请参见 Invlists::copy_subset_to

~IndexIVF() override

inline size_t get_list_size(size_t list_no) const

bool check_ids_sorted() const

ID 是否已排序？

void make_direct_map(bool new_maintain_direct_map = true)

初始化直接映射

参数:

new_maintain_direct_map – 如果为 true，则创建直接映射，否则清除它

void set_direct_map_type(DirectMap::Type type)

void replace_invlists(InvertedLists *il, bool own = false)

替换倒排列表，如果 own_invlists，则旧列表将被释放

virtual size_t sa_code_size() const override

以字节为单位的生成代码的大小

virtual void sa_encode(idx_t n, const float *x, uint8_t *bytes) const override

对一组向量进行编码 sa_encode 将会调用 encode_vector，且 include_listno=true

参数:

• n – 要编码的向量的数量

• x – 要编码的向量

• bytes – 用于存储代码的输出数组

返回值:

写入代码的字节数

IndexIVF()

virtual void assign(idx_t n, const float *x, idx_t *labels, idx_t k = 1) const

返回与查询 x 最接近的 k 个向量的索引。

此函数与 search 相同，但仅返回邻居的标签。

参数:

• n – 向量数量

• x – 要搜索的输入向量，大小为 n * d

• labels – NN 的输出标签，大小为 n*k

• k – 最近邻的数量

virtual void reconstruct_batch(idx_t n, const idx_t *keys, float *recons) const

重建几个存储的向量（如果是有损编码，则重建近似值）

对于某些索引，此函数可能未定义

参数:

• n – 要重建的向量的数量

• keys – 要重建的向量的 ID（大小为 n）

• recons – 重建的向量（大小为 n * d）

virtual void compute_residual(const float *x, float *residual, idx_t key) const

在索引编码后计算残差向量。

残差向量是向量与可以从其在索引中的表示形式解码的重建之间的差。 残差可用于多阶段索引方法，例如 IndexIVF 的方法。

参数:

• x – 输入向量，大小为 d

• residual – 输出残差向量，大小为 d

• key – 编码的索引，由搜索和分配返回

virtual void compute_residual_n(idx_t n, const float *xs, float *residuals, const idx_t *keys) const

在索引编码后计算残差向量（批量形式）。 相当于为每个向量调用 compute_residual。

残差向量是向量与可以从其在索引中的表示形式解码的重建之间的差。 残差可用于多阶段索引方法，例如 IndexIVF 的方法。

参数:

• n – 向量数量

• xs – 输入向量，大小 (n x d)

• residuals – 输出残差向量，大小 (n x d)

• keys – 编码的索引，由搜索和分配返回

virtual DistanceComputer *get_distance_computer() const

获取此类索引的 DistanceComputer（在 AuxIndexStructures 中定义）对象。

DistanceComputer 是为支持对其向量进行随机访问的索引实现的。

virtual void sa_decode(idx_t n, const uint8_t *bytes, float *x) const

解码一组向量

参数:

• n – 向量数量

• bytes – 输入编码的向量，大小为 n * sa_code_size()

• x – 输出向量，大小为 n * d

void train_q1(size_t n, const float *x, bool verbose, MetricType metric_type)

训练量化器并调用 train_residual 来训练子量化器。

size_t coarse_code_size() const

计算存储列表 ID 所需的字节数

void encode_listno(idx_t list_no, uint8_t *code) const

idx_t decode_listno(const uint8_t *code) const

公共成员

InvertedLists *invlists = nullptr

访问实际数据。

bool own_invlists = false

size_t code_size = 0

每个向量的码字大小（以字节为单位）

int parallel_mode = 0

并行模式决定了如何使用 OpenMP 对查询进行并行化

0 (默认): 在查询上进行分割 1: 在倒排列表上进行并行化 2: 在两者上进行并行化 3: 以更精细的粒度在查询上进行分割

PARALLEL_MODE_NO_HEAP_INIT: 二进制或与前一个一起使用，以防止堆被初始化和最终化

const int PARALLEL_MODE_NO_HEAP_INIT = 1024

DirectMap direct_map

可选的映射，将 id 映射回 invlist 条目。这使 reconstruct() 成为可能

bool by_residual = true

invlists 中的代码是否编码了相对于质心的向量？

int d

向量维度

idx_t ntotal

索引向量的总数

bool verbose

详细级别

bool is_trained

如果 Index 不需要训练，或者已经完成训练，则设置

MetricType metric_type

此索引用于搜索的度量类型

float metric_arg

度量类型的参数

size_t nprobe = 1

查询时的探针数量

size_t max_codes = 0

访问查询的最大代码数量

Index *quantizer = nullptr

将向量映射到倒排列表的量化器

size_t nlist = 0

倒排列表的数量

char quantizer_trains_alone = 0

>= 0: 将量化器用作 kmeans 训练中的索引 = 1: 只需将训练集传递给量化器的 train() = 2: 在平面索引上进行 kmeans 训练 + 将质心添加到量化器

bool own_fields = false

对象是否拥有量化器

ClusteringParameters cp

覆盖默认聚类参数

Index *clustering_index = nullptr

覆盖聚类期间使用的索引