vertebrae.retrieval

Training-free query–gallery benchmark runner.

Classes

RetrievalBenchmark

Compare frozen extractors under an explicit exact retrieval protocol.

Module Contents

class vertebrae.retrieval.RetrievalBenchmark(dataset, extractors, retrieval_config=None, compression_config=None, compression_configs=None, query_branch=None, gallery_branch=None, embedding_config=None, memory_config=None, resource_profiling_config=None)

Compare frozen extractors under an explicit exact retrieval protocol.

Parameters:

• dataset (vertebrae.datasets.retrieval.RetrievalDataset)

• extractors (Iterable[Any])

• retrieval_config (Optional[vertebrae.config.RetrievalConfig])

• compression_config (Optional[vertebrae.config.EmbeddingCompressionConfig])

• compression_configs (Optional[Iterable[vertebrae.config.EmbeddingCompressionConfig]])

• query_branch (Optional[str])

• gallery_branch (Optional[str])

• embedding_config (Optional[vertebrae.config.EmbeddingConfig])

• memory_config (Optional[vertebrae.config.MemoryConfig])

• resource_profiling_config (Optional[vertebrae.config.ResourceProfilingConfig])