FaissPQIndexConfig

class lightning_ir.retrieve.faiss.faiss_indexer.FaissPQIndexConfig(num_train_embeddings: int | None = None, num_subquantizers: int = 16, n_bits: int = 8)

Bases: _FaissTrainIndexConfig

Configuration class for FAISS PQ indexers in the Lightning IR framework.

__init__(num_train_embeddings: int | None = None, num_subquantizers: int = 16, n_bits: int = 8) → None

Initialize the FaissPQIndexConfig.

Parameters:

• num_train_embeddings (int | None) – Number of embeddings to use for training the index. If None, it will be set later. Defaults to None.

• num_subquantizers (int) – Number of subquantizers for the PQ index. Defaults to 16.

• n_bits (int) – Number of bits for the PQ index. Defaults to 8.

Methods

__init__([num_train_embeddings, ...])

Initialize the FaissPQIndexConfig.

Attributes

indexer_class

alias of FaissPQIndexer