Skip to content

Compiling and developing for Faiss

Jump to bottom
Tarang Jain edited this page Jan 7, 2025 · 1 revision

Developing for Python

The recommended way of setting up a development environment for Faiss is to start from a conda environment without Faiss but with the required dependencies.

Commands on a Mac M1

https://gist.github.com/mdouze/2b96e804ee2825e72323c0a296061c7e

Home

Tutorial

Installing Faiss

Getting started

Faster search

Lower memory footprint

Running on GPUs

Basics

MetricType and distances

Faiss building blocks: clustering, PCA, quantization

Guidelines to choose an index

Faiss indexes

Basic indexes

Binary indexes

Composite indexes

Pre- and post-processing

The index factory

Index IO, cloning and hyper parameter tuning

Special operations on indexes

Additive quantizers

GPU Faiss

GPU overview

GPU versus CPU

Sample: GPU k-means

GPU Faiss + NVIDIA cuVS - Overview

GPU Faiss + NVIDIA cuVS - Usage and Performance

Advanced topics

Faiss code structure

Threads and asynchronous calls

Inverted list objects and scanners

Indexes that do not fit in RAM

Vector codecs

Brute force search without an index

Fast accumulation of PQ and AQ codes (FastScan)

Implementation notes

Setting search parameters for one query

How to make Faiss run faster

Typical use cases and benchmarks

Low level benchmarks

Indexing 1M vectors

Indexing 1G vectors

Indexing 1T vectors

Vector codec benchmarks

Binary hashing index benchmark

Hybrid CPU/GPU and multiple GPUs

Case studies

Additional information

FAQ

Python/C++ code snippets

Troubleshooting

Related projects

Clone this wiki locally