annoy README

The project's README from github.com/spotify/annoy. As one markdown file: README.md.

Annoy

.. figure:: https://raw.github.com/spotify/annoy/master/ann.png :alt: Annoy example :align: center

.. image:: https://github.com/spotify/annoy/actions/workflows/ci.yml/badge.svg :target: https://github.com/spotify/annoy/actions

Annoy (Approximate Nearest Neighbors <http://en.wikipedia.org/wiki/Nearest_neighbor_search#Approximate_nearest_neighbor>__ Oh Yeah) is a C++ library with Python bindings to search for points in space that are close to a given query point. It also creates large read-only file-based data structures that are mmapped <https://en.wikipedia.org/wiki/Mmap>__ into memory so that many processes may share the same data.

Install

To install, simply do pip install --user annoy to pull down the latest version from PyPI <https://pypi.python.org/pypi/annoy>_.

For the C++ version, just clone the repo and #include "annoylib.h".

Background

There are some other libraries to do nearest neighbor search. Annoy is almost as fast as the fastest libraries, (see below), but there is actually another feature that really sets Annoy apart: it has the ability to use static files as indexes. In particular, this means you can share index across processes. Annoy also decouples creating indexes from loading them, so you can pass around indexes as files and map them into memory quickly. Another nice thing of Annoy is that it tries to minimize memory footprint so the indexes are quite small.

Why is this useful? If you want to find nearest neighbors and you have many CPU's, you only need to build the index once. You can also pass around and distribute static files to use in production environment, in Hadoop jobs, etc. Any process will be able to load (mmap) the index into memory and will be able to do lookups immediately.

We use it at Spotify <http://www.spotify.com/>__ for music recommendations. After running matrix factorization algorithms, every user/item can be represented as a vector in f-dimensional space. This library helps us search for similar users/items. We have many millions of tracks in a high-dimensional space, so memory usage is a prime concern.

Annoy was built by Erik Bernhardsson <http://www.erikbern.com>__ in a couple of afternoons during Hack Week <http://labs.spotify.com/2013/02/15/organizing-a-hack-week/>__.

Summary of features

Python code example

.. code-block:: python

from annoy import AnnoyIndex import random

f = 40 # Length of item vector that will be indexed

t = AnnoyIndex(f, 'angular') for i in range(1000): v = [random.gauss(0, 1) for z in range(f)] t.add_item(i, v)

t.build(10) # 10 trees t.save('test.ann')

...

u = AnnoyIndex(f, 'angular') u.load('test.ann') # super fast, will just mmap the file print(u.get_nns_by_item(0, 1000)) # will find the 1000 nearest neighbors

Right now it only accepts integers as identifiers for items. Note that it will allocate memory for max(id)+1 items because it assumes your items are numbered 0 … n-1. If you need other id's, you will have to keep track of a map yourself.

Full Python API

Notes:

The C++ API is very similar: just #include "annoylib.h" to get access to it.

Tradeoffs

There are just two main parameters needed to tune Annoy: the number of trees n_trees and the number of nodes to inspect during searching search_k.

If search_k is not provided, it will default to n * n_trees where n is the number of approximate nearest neighbors. Otherwise, search_k and n_trees are roughly independent, i.e. the value of n_trees will not affect search time if search_k is held constant and vice versa. Basically it's recommended to set n_trees as large as possible given the amount of memory you can afford, and it's recommended to set search_k as large as possible given the time constraints you have for the queries.

You can also accept slower search times in favour of reduced loading times, memory usage, and disk IO. On supported platforms the index is prefaulted during load and save, causing the file to be pre-emptively read from disk into memory. If you set prefault to False, pages of the mmapped index are instead read from disk and cached in memory on-demand, as necessary for a search to complete. This can significantly increase early search times but may be better suited for systems with low memory compared to index size, when few queries are executed against a loaded index, and/or when large areas of the index are unlikely to be relevant to search queries.

How does it work

Using random projections <http://en.wikipedia.org/wiki/Locality-sensitive_hashing#Random_projection>__ and by building up a tree. At every intermediate node in the tree, a random hyperplane is chosen, which divides the space into two subspaces. This hyperplane is chosen by sampling two points from the subset and taking the hyperplane equidistant from them.

We do this k times so that we get a forest of trees. k has to be tuned to your need, by looking at what tradeoff you have between precision and performance.

Hamming distance (contributed by Martin Aumüller <https://github.com/maumueller>__) packs the data into 64-bit integers under the hood and uses built-in bit count primitives so it could be quite fast. All splits are axis-aligned.

Dot Product distance (contributed by Peter Sobot <https://github.com/psobot>__ and Pavel Korobov <https://github.com/pkorobov>) reduces the provided vectors from dot (or "inner-product") space to a more query-friendly cosine space using a method by Bachrach et al., at Microsoft Research, published in 2014 <https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/XboxInnerProduct.pdf>.

More info

.. figure:: https://raw.githubusercontent.com/erikbern/ann-benchmarks/main/results/glove-100-angular.png :alt: ANN benchmarks :align: center :target: https://github.com/erikbern/ann-benchmarks

Source code

It's all written in C++ with a handful of ugly optimizations for performance and memory usage. You have been warned :)

The code should support Windows, thanks to Qiang Kou <https://github.com/thirdwing>__ and Timothy Riley <https://github.com/tjrileywisc>__.

To run the tests, execute python setup.py nosetests. The test suite includes a big real world dataset that is downloaded from the internet, so it will take a few minutes to execute.

Discuss

Feel free to post any questions or comments to the annoy-user <https://groups.google.com/group/annoy-user>__ group. I'm @fulhack <https://twitter.com/fulhack>__ on Twitter.

annoy (spotify/annoy)

Searching Database…

14.3K ·GitHub
Что это такое?Annoy (Approximate Nearest Neighbors Oh Yeah) — это библиотека на C++ с привязками для Python, которая находит точки в пространстве, ближайшие к заданной точке-запросу. Она оптимизирована по расходу памяти и по сохранению и загрузке индексов с диска.
Это приложение, которое я запускаю, или код, который я подключаю в свой проект?Это библиотека, а не приложение: из Python импортируется пакет annoy; в C++ нужно клонировать репозиторий и сделать #include annoylib.h. Существуют также привязки от сообщества для R, Java, Scala, Ruby, Go, Lua, Node, Rust, dotnet и dart.
Как добавить её в свой проект?Выполните pip install --user annoy, чтобы получить последнюю версию с PyPI, или возьмите пакет из conda (он доступен на Linux, OS X и Windows). Для C++ ничего устанавливать не нужно — просто клонируйте репозиторий и подключите заголовочный файл.
Нужно ли мне что-то ещё установить, чтобы начать пользоваться?Никаких серверов, баз данных или GPU — всё работает внутри процесса. Благодаря пакетам на PyPI и в conda компилятор при работе из Python не нужен; в README указана проверенная поддержка Python 2.7, 3.6 и 3.7.
В чём подвох, когда я уже построил индекс?Индексы после построения доступны только для чтения — после построения или сохранения добавить элементы нельзя, а создание индекса полностью отделено от поиска. Id должны быть неотрицательными целыми числами, причём память выделяется под max(id)+1, так что для разреженных или нецелых id ведите свою таблицу соответствия.
Кто использует её в продакшене?Spotify использует её для музыкальных рекомендаций: после матричной факторизации пользователи и треки превращаются в векторы, и Annoy находит похожие среди миллионов треков в пространстве высокой размерности, где расход памяти — ключевой фактор.
Могут ли несколько процессов использовать один и тот же индекс?Да — это главная особенность. Индексы — это статические файлы, которые отображаются в память через mmap, так что вы строите индекс один раз, а много процессов пользуются одними и теми же данными. Есть ещё и построение индекса прямо на диске — для наборов данных, которые не помещаются в оперативную память.
Как выглядит типичный рабочий процесс в Python?Создайте AnnoyIndex(f, 'angular') для векторов размерности f, добавьте каждый вектор через additem, вызовите build(10) для 10 деревьев, затем сохраните индекс в файл вроде test.ann. В другом месте загрузите этот файл — он просто отображается через mmap — и вызовите get_nns_by_item или get_nns_by_vector.
Как мне найти баланс между точностью и скоростью?Всего две настройки: n_trees на этапе построения (больше деревьев — выше точность, но больше индексы) и search_k на этапе запроса (просматривается больше узлов — точнее, но медленнее). По умолчанию search_k равен n_trees, умноженному на n — количество запрошенных соседей.
Какие метрики расстояния я могу выбрать?'angular' (косинусное расстояние), 'euclidean', 'manhattan', 'hamming' и 'dot' (скалярное произведение). Angular — это евклидово расстояние между нормализованными векторами. Лучше всего работает при меньше чем 100 измерениях, но неожиданно хорошо показывает себя и до 1 000.
What are similar projects?faiss, pgvector, weaviate, lancedb, qdrant, zvec, dlib, flatbuffers
Creator
spotify
Size
2 MB
Stars
14.3K
Age
13y
Commits · 90 Days