PlaidIndexConfig

class lightning_ir.retrieve.plaid.plaid_indexer.PlaidIndexConfig(num_centroids: int, k_means_iters: int = 4, n_bits: int = 2, seed: int = 42)

Bases: IndexConfig

Configuration class for Plaid indexers in the Lightning IR framework.

__init__(num_centroids: int, k_means_iters: int = 4, n_bits: int = 2, seed: int = 42) → None

Initialize the PlaidIndexConfig.

Parameters:

• num_centroids (int) – Number of centroids for the Plaid index.

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

• k_means_iters (int) – Number of iterations for k-means clustering. Defaults to 4.

• n_bits (int) – Number of bits for the residual codec. Defaults to 2.

• seed (int) – Random seed for reproducibility. Defaults to 42.

Methods

__init__(num_centroids[, k_means_iters, ...])

Initialize the PlaidIndexConfig.

Attributes

SUPPORTED_MODELS

indexer_class

alias of PlaidIndexer