FaissIVFIndexConfig

class lightning_ir.retrieve.faiss.faiss_indexer.FaissIVFIndexConfig(num_train_embeddings: int | None = None, num_centroids: int = 262144, ef_construction: int = 40)

Bases: _FaissTrainIndexConfig

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

__init__(num_train_embeddings: int | None = None, num_centroids: int = 262144, ef_construction: int = 40) → None

Initialize the FaissIVFIndexConfig.

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_centroids (int) – Number of centroids for the IVF index. Defaults to 262144.

• ef_construction (int) – The size of the dynamic list used during construction. Defaults to 40.

Methods

__init__([num_train_embeddings, ...])

Initialize the FaissIVFIndexConfig.

Attributes

classmethod from_pretrained(index_dir: Path | str) → IndexConfig

Load the index configuration from a directory.

Parameters:

index_dir (Path | str) – Path to the directory containing the index configuration.

Returns:

An instance of the index configuration class.

Return type:

IndexConfig

Raises:

ValueError – If the index type in the configuration does not match the expected class name.

indexer_class

alias of FaissIVFIndexer

save(index_dir: Path) → None

Save the index configuration to a directory.

Parameters:

index_dir (Path) – The directory to save the index configuration.

to_dict() → dict

Convert the index configuration to a dictionary.

Returns:

A dictionary representation of the index configuration.

Return type:

dict