Skip to content

Commit

Permalink
doc update to mention the paper
Browse files Browse the repository at this point in the history
Summary: reference the new Faiss paper in the docs. Also added Gergely as a co-author of Faiss. Some minor updates.

Reviewed By: mlomeli1

Differential Revision: D52829321

fbshipit-source-id: 0f1845beace6cd88f809ba50b87a8d446475d30b
  • Loading branch information
mdouze authored and facebook-github-bot committed Jan 17, 2024
1 parent 9a63a3c commit 739ce13
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ outlined on that page and do not file a public issue.

## Coding Style

* 4 or 2 spaces for indentation in C++ (no tabs)
* 4 spaces for indentation in C++ (no tabs)
* 80 character line length (both for C++ and Python)
* C++ language level: C++17

Expand Down
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installing Faiss via conda

The recommended way to install Faiss is through [conda](https://docs.conda.io).
The supported way to install Faiss is through [conda](https://docs.conda.io).
Stable releases are pushed regularly to the pytorch conda channel, as well as
pre-release nightly builds.

Expand Down Expand Up @@ -77,7 +77,7 @@ found to run on other platforms as well, see

The basic requirements are:
- a C++17 compiler (with support for OpenMP support version 2 or higher),
- a BLAS implementation (we strongly recommend using Intel MKL for best
- a BLAS implementation (on Intel machines we strongly recommend using Intel MKL for best
performance).

The optional requirements are:
Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,22 @@ The main authors of Faiss are:
- [Lucas Hosseini](https://github.com/beauby) implemented the binary indexes and the build system
- [Chengqi Deng](https://github.com/KinglittleQ) implemented NSG, NNdescent and much of the additive quantization code.
- [Alexandr Guzhva](https://github.com/alexanderguzhva) many optimizations: SIMD, memory allocation and layout, fast decoding kernels for vector codecs, etc.
- [Gergely Szilvasy](https://github.com/algoriddle) build system, benchmarking framework.

## Reference

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

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}},
Expand Down

0 comments on commit 739ce13

Please sign in to comment.