faiss is a free, open source machine learning infrastructure project written in C++ and released under MIT. It has 40,929 GitHub stars, 4,526 forks and 327 open issues, and was last pushed 2 hours ago. On this registry it ranks #7 of 86 tracked projects in Machine Learning Infrastructure, with 5 head-to-head comparisons available.

What is faiss?

Faiss is an MIT-licensed C++ library for efficient similarity search and clustering of dense vectors, with complete Python and NumPy wrappers, developed primarily at Meta's Fundamental AI Research group, and it is intended for engineers and researchers who need nearest-neighbour search over vector sets that range from small collections to sets that possibly do not fit in RAM.

What it is

Faiss is a library that stores a set of vectors and provides a search function over them using L2 (Euclidean) distance, dot products, or cosine similarity on normalized vectors. Each instance is represented as a vector and identified by an integer, and the library supplies a range of index types built around that abstraction. Some of those index types are simple baselines, such as exact search, while most correspond to explicit trade-offs in search time, search quality, memory used per index vector, training time, adding time, and the need for external data for unsupervised training. The library lives in the AI and machine learning infrastructure ecosystem, alongside the vector-search components of retrieval and recommendation systems, and it is written in C++ with the Python interface and GPU support both optional.

The concrete problem it solves is the cost of comparing a query vector against a stored vector set directly. Rather than scanning every stored vector, Faiss provides indexing structures such as HNSW and NSG, which add a structure on top of the raw vectors to make searching more efficient, and compression-based methods, which use only a compressed representation of the vectors. Compression methods based on binary vectors and compact quantization codes do not require the original vectors to be kept at all, and they can scale to billions of vectors in main memory on a single server, generally at the cost of a less precise search. That is what the library replaces: brute-force comparison against every candidate vector, and the memory footprint that keeping all original vectors implies.

Key capabilities

  • Index types covering exact search and approximate search, with comparison by L2 (Euclidean) distance, dot product, and cosine similarity on normalized vectors.
  • Compression-based methods that rely solely on a compressed representation of the vectors and can scale to billions of vectors in main memory on a single server, trading precision for scale.
  • Graph-based indexing structures, specifically HNSW and NSG, layered on top of the raw vectors to make searching more efficient.
  • GPU implementations that accept input from either CPU or GPU memory and act as drop-in replacements for CPU indexes, for example replacing IndexFlatL2 with GpuIndexFlatL2, with copies to and from GPU memory handled automatically.
  • Single-GPU and multi-GPU usage, with optional support through CUDA or AMD ROCm, plus optional enabling of NVIDIA cuVS backend implementations.
  • Complete Python and NumPy wrappers, distributed as precompiled Anaconda packages named faiss-cpu, faiss-gpu, and faiss-gpu-cuvs.
  • Supporting code for evaluation and parameter tuning, with build instructions in INSTALL.md, a changelog in CHANGELOG.md, and reproduction material for the Polysemous codes and Billion-scale similarity search with GPUs papers under benchs/README.md.

Who uses it and how

  • Teams running a server with GPUs use GPU indexes as a drop-in replacement for CPU indexes; results are faster when both input and output remain resident on GPU memory.
  • Teams holding very large vector sets use compressed-domain indexes to keep billions of vectors in main memory on a single server instead of sharding across many machines.
  • Researchers reproduce published results for Polysemous codes and for billion-scale similarity search with GPUs using the benchmark material referenced from benchs/README.md.
  • Engineers choosing an index type work through the documented trade-offs of search time, search quality, memory per index vector, training time, adding time, and dependence on external data for unsupervised training.
  • Python users install the precompiled conda package rather than building the C++ library, while teams needing custom builds compile with cmake.

Getting started

Install the precompiled Python packages faiss-cpu, faiss-gpu, or faiss-gpu-cuvs from Anaconda, or compile from source with cmake following INSTALL.md. The only required dependency is a BLAS implementation; CUDA, AMD ROCm, and the cuVS backend are optional.

How it compares

The facts provided name no paid products that Faiss replaces, and they name no comparable tools either. Within this registry it stands alone: no sibling project is cited alongside it for similarity search and clustering of dense vectors.

When to use it — and when not to

A self-hoster must operate a build toolchain around cmake and a BLAS implementation, and must additionally supply a CUDA or AMD ROCm stack to use the GPU indexes; index training, parameter tuning, and the storage strategy for compressed or graph-based structures remain the operator's responsibility. Anyone who wants a managed service, a hosted endpoint, or a database-style API should not pick this up, because Faiss is a library rather than a service. Two honest weaknesses are visible in the record: the topics list is empty, which makes the project harder to discover through registry browsing, and the open issue count stands at 327, so expect a busy tracker; the README's performance claim for the GPU implementation is explicitly dated March 2017 and should be treated as historical rather than current.

project readme (upstream, from github) — read inline

Faiss

Faiss is a library for efficient similarity search and clustering of dense vectors. It contains algorithms that search in sets of vectors of any size, up to ones that possibly do not fit in RAM. It also contains supporting code for evaluation and parameter tuning. Faiss is written in C++ with complete wrappers for Python/numpy. Some of the most useful algorithms are implemented on the GPU. It is developed primarily at Meta's Fundamental AI Research group.

News

See CHANGELOG.md for detailed information about latest features.

Introduction

Faiss contains several methods for similarity search. It assumes that the instances are represented as vectors and are identified by an integer, and that the vectors can be compared with L2 (Euclidean) distances or dot products. Vectors that are similar to a query vector are those that have the lowest L2 distance or the highest dot product with the query vector. It also supports cosine similarity, since this is a dot product on normalized vectors.

Some of the methods, like those based on binary vectors and compact quantization codes, solely use a compressed representation of the vectors and do not require to keep the original vectors. This generally comes at the cost of a less precise search but these methods can scale to billions of vectors in main memory on a single server. Other methods, like HNSW and NSG add an indexing structure on top of the raw vectors to make searching more efficient.

The GPU implementation can accept input from either CPU or GPU memory. On a server with GPUs, the GPU indexes can be used a drop-in replacement for the CPU indexes (e.g., replace IndexFlatL2 with GpuIndexFlatL2) and copies to/from GPU memory are handled automatically. Results will be faster however if both input and output remain resident on the GPU. Both single and multi-GPU usage is supported.

Installing

Faiss comes with precompiled libraries for Anaconda in Python, see faiss-cpu, faiss-gpu and faiss-gpu-cuvs. The library is mostly implemented in C++, the only dependency is a BLAS implementation. Optional GPU support is provided via CUDA or AMD ROCm, and the Python interface is also optional. The backend GPU implementations of NVIDIA cuVS can also be enabled optionally. It compiles with cmake. See INSTALL.md for details.

How Faiss works

Faiss is built around an index type that stores a set of vectors, and provides a function to search in them with L2 and/or dot product vector comparison. Some index types are simple baselines, such as exact search. Most of the available indexing structures correspond to various trade-offs with respect to

  • search time
  • search quality
  • memory used per index vector
  • training time
  • adding time
  • need for external data for unsupervised training

The optional GPU implementation provides what is likely (as of March 2017) the fastest exact and approximate (compressed-domain) nearest neighbor search implementation for high-dimensional vectors, fastest Lloyd's k-means, and fastest small k-selection algorithm known. The implementation is detailed here.

Full documentation of Faiss

The following are entry points for documentation:

Authors

The main authors of Faiss are:

  • Hervé Jégou initiated the Faiss project and wrote its first implementation
  • Matthijs Douze implemented most of the CPU Faiss
  • Jeff Johnson implemented all of the GPU Faiss
  • Lucas Hosseini implemented the binary indexes and the build system
  • Chengqi Deng implemented NSG, NNdescent and much of the additive quantization code.
  • Alexandr Guzhva many optimizations: SIMD, memory allocation and layout, fast decoding kernels for vector codecs, etc.
  • Gergely Szilvasy build system, benchmarking framework.

Reference

References to cite when you use Faiss in a research paper:

@article{douze2024faiss,
      title={The Faiss library},
      author={Matthijs Douze and Alexandr Guzhva and Chengqi Deng and Jeff Johnson and Gergely Szilvasy and Pierre-Emmanuel Mazaré and Maria Lomeli and Lucas Hosseini and Hervé Jégou},
      year={2024},
      eprint={2401.08281},
      archivePrefix={arXiv},
      primaryClass={cs.LG}
}

For the GPU version of Faiss, please cite:

@article{johnson2019billion,
  title={Billion-scale similarity search with {GPUs}},
  author={Johnson, Jeff and Douze, Matthijs and J{\'e}gou, Herv{\'e}},
  journal={IEEE Transactions on Big Data},
  volume={7},
  number={3},
  pages={535--547},
  year={2019},
  publisher={IEEE}
}

Join the Faiss community

For public discussion of Faiss or for questions, visit https://github.com/facebookresearch/faiss/discussions.

We monitor the issues page of the repository. You can report bugs, ask questions, etc.

Legal

Faiss is MIT-licensed, refer to the LICENSE file in the top level directory.

Copyright © Meta Platforms, Inc.

Frequently asked questions

Is faiss free to use?

faiss is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does faiss do?

A library for efficient similarity search and clustering of dense vectors.

What is faiss written in?

faiss is primarily written in C++. Its source is publicly available at https://github.com/facebookresearch/faiss, and it has 40,929 GitHub stars.