Index API

Index API#

Indices are used for fast nearest neighbor search. Optionally, they may also perform transformation prior to indexing.

The module provides a few index implementations:

  • FaissIndex: Uses the Faiss library for fast nearest neighbor search.

  • HnswlibIndex: Uses the hnswlib library for fast nearest neighbor search.

  • PolarIndex: Transforms spatial coordinates into polar coordinates for indexing.

  • WhiteningIndex: Whitens the data before indexing.