Github url

annoy

by spotify

spotify /annoy

Approximate Nearest Neighbors in C++/Python optimized for memory usage and loading/saving to disk

7.2K Stars 793 Forks Last release: 7 months ago (v1.16.3) Apache License 2.0 747 Commits 23 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Annoy

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

.. image:: https://img.shields.io/travis/spotify/annoy/master.svg?style=flat :target: https://travis-ci.org/spotify/annoy

.. image:: https://ci.appveyor.com/api/projects/status/github/spotify/annoy?svg=true&pendingText=windows%20-%20Pending&passingText=windows%20-%20OK&failingText=windows%20-%20Failing :target: https://ci.appveyor.com/project/erikbern/annoy

.. image:: https://img.shields.io/pypi/v/annoy.svg?style=flat :target: https://pypi.python.org/pypi/annoy

Annoy (

Approximate Nearest Neighbors <http:></http:>

__ 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:></https:>

__ 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:></https:>

_.

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:></http:>

__ 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:></http:>

__ in a couple of afternoons during

Hack Week <http:></http:>

__.

Summary of features

  • Euclidean distance <https:></https:>
  • *,
    Manhattan distance <https:></https:>
    ```** , 
    cosine distance https: ```
  • *,
    Hamming distance <https:></https:>
    ```** , or 
    Dot (Inner) Product distance https: ``` __
  • Cosine distance is equivalent to Euclidean distance of normalized vectors = sqrt(2-2*cos(u, v))
  • Works better if you don't have too many dimensions (like <100) but seems to perform surprisingly well even up to 1,000 dimensions
  • Small memory usage
  • Lets you share memory between multiple processes
  • Index creation is separate from lookup (in particular you can not add more items once the tree has been created)
  • Native Python support, tested with 2.7, 3.6, and 3.7.
  • Build index on disk to enable indexing big datasets that won't fit into memory (contributed by
    Rene Hollander <https:></https:>
    __)

Python code example

.. code-block:: python

from annoy import AnnoyIndex import random

f = 40 t = AnnoyIndex(f, 'angular') # Length of item vector that will be indexed 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

  • AnnoyIndex(f, metric)
    returns a new index that's read-write and stores vector of
    f
    dimensions. Metric can be
    "angular"
    ,
    "euclidean"
    ,
    "manhattan"
    ,
    "hamming"
    , or
    "dot"
    .
  • a.add\_item(i, v)
    adds item
    i
    (any nonnegative integer) with vector
    v
    . Note that it will allocate memory for
    max(i)+1
    items.
  • a.build(n\_trees)
    builds a forest of
    n\_trees
    trees. More trees gives higher precision when querying. After calling
    build
    , no more items can be added.
  • a.save(fn, prefault=False)
    saves the index to disk and loads it (see next function). After saving, no more items can be added.
  • a.load(fn, prefault=False)
    loads (mmaps) an index from disk. If
    prefault
    is set to
    True
    , it will pre-read the entire file into memory (using mmap with
    MAP\_POPULATE
    ). Default is
    False
    .
  • a.unload()
    unloads.
  • a.get\_nns\_by\_item(i, n, search\_k=-1, include\_distances=False)
    returns the
    n
    closest items. During the query it will inspect up to
    search\_k
    nodes which defaults to
    n\_trees \* n
    if not provided.
    search\_k
    gives you a run-time tradeoff between better accuracy and speed. If you set
    include\_distances
    to
    True
    , it will return a 2 element tuple with two lists in it: the second one containing all corresponding distances.
  • a.get\_nns\_by\_vector(v, n, search\_k=-1, include\_distances=False)
    same but query by vector
    v
    .
  • a.get\_item\_vector(i)
    returns the vector for item
    i
    that was previously added.
  • a.get\_distance(i, j)
    returns the distance between items
    i
    and
    j
    . NOTE: this used to return the squared distance, but has been changed as of Aug 2016.
  • a.get\_n\_items()
    returns the number of items in the index.
  • a.get\_n\_trees()
    returns the number of trees in the index.
  • a.on\_disk\_build(fn)
    prepares annoy to build the index in the specified file instead of RAM (execute before adding items, no need to save after build)
  • a.set\_seed(seed)
    will initialize the random number generator with the given seed. Only used for building up the tree, i. e. only necessary to pass this before adding the items. Will have no effect after calling
    a.build(n\_trees)
    or
    a.load(fn)
    .

Notes:

  • There's no bounds checking performed on the values so be careful.
  • Annoy uses Euclidean distance of normalized vectors for its angular distance, which for two vectors u,v is equal to
    sqrt(2(1-cos(u,v)))

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

.

n\_trees

is provided during build time and affects the build time and the index size. A larger value will give more accurate results, but larger indexes.

search\_k

is provided in runtime and affects the search performance. A larger value will give more accurate results, but will take longer time to return.

If

search\_k

is not provided, it will default to

n \* n\_trees \* D

where

n

is the number of approximate nearest neighbors and

D

is a constant depending on the metric. 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:></http:>

__ 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:></https:>

__) 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:></https:>

**) 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:></https:>
```**.
## More info

- 

Dirk Eddelbuettel https:

\_\_ provides an 

R version of Annoy http:

\_\_.
- 

Andy Sloane https:

\_\_ provides a 

Java version of Annoy https:

\_\_ although currently limited to cosine and read-only.
- 

Pishen Tsai https:

\_\_ provides a 

Scala wrapper of Annoy https:

\_\_ which uses JNA to call the C++ library of Annoy.
- There is 

experimental support for Go https:

\_\_ provided by 

Taneli Leppä https:

\_\_.
- 

Boris Nagaev https:

\_\_ wrote 

Lua bindings https:

\_\_.
- During part of Spotify Hack Week 2016 (and a bit afterward), 

Jim Kang https:

\_\_ wrote 

Node bindings https:

\_\_ for Annoy.
- 

Min-Seok Kim https:

\_\_ built a 

Scala version https:

\_\_ of Annoy.
- 

Presentation from New York Machine Learning meetup http:

\_\_ about Annoy
- Annoy is available as a 

conda package https:

\_\_ on Linux, OS X, and Windows.
- 

ann-benchmarks https:

\_\_ is a benchmark for several approximate nearest neighbor libraries. Annoy seems to be fairly competitive, especially at higher precisions:

.. figure:: https://github.com/erikbern/ann-benchmarks/raw/master/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:

\_\_ and 

Timothy Riley https:

\_\_.

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:

\_\_ group. I'm 

@fulhack https:

``` __ on Twitter.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.