Metadata-Version: 1.1
Name: annoy
Version: 1.3.2
Summary: Approximate Nearest Neighbors in C++/Python optimized for memory usage and loading/saving to disk.
Home-page: https://github.com/spotify/annoy
Author: Erik Bernhardsson
Author-email: mail@erikbern.com
License: Apache License 2.0
Description: .. note::
        
           For the latest source, discussion, etc, please visit the
           `GitHub repository <https://github.com/spotify/annoy>`_
        
        
        
        .. image:: https://img.shields.io/github/stars/spotify/annoy.svg
            :target: https://github.com/spotify/annoy
        
        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://img.shields.io/pypi/dm/annoy.svg?style=flat
           :target: https://pypi.python.org/pypi/annoy
        
        .. image:: https://img.shields.io/pypi/l/annoy.svg?style=flat
           :target: https://pypi.python.org/pypi/annoy
        
        .. image:: https://pypip.in/py_versions/annoy/badge.svg?style=flat
        
        Annoy (`Approximate Nearest Neighbors <http://en.wikipedia.org/wiki/Nearest_neighbor_search#Approximate_nearest_neighbor>`__ Something Something) 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 into memory so that many processes may share the same data.
        
        Install
        -------
        
        To install, simply do ``sudo pip install 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 appears to be both faster and more accurate in benchmarks (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 the RAM to fit 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
        -------------------
        
        * Euclidean distance (squared) or cosine similarity (using the squared distance of the normalized vectors)
        * 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.6, 2.7, 3.3, 3.4
        
        Python code example
        -------------------
        
        .. code-block:: python
        
          from annoy import AnnoyIndex
          import random
        
          f = 40
          t = AnnoyIndex(f)  # Length of item vector that will be indexed
          for i in xrange(1000):
              v = [random.gauss(0, 1) for z in xrange(f)]
                  t.add_item(i, v)
        
          t.build(10) # 10 trees
          t.save('test.ann')
        
          # ...
        
          u = AnnoyIndex(f)
          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='angular')`` returns a new index that's read-write and stores vector of ``f`` dimensions. Metric can be either ``"angular"`` or ``"euclidean"``.
        * ``a.add_item(i, v)`` adds item ``i`` (any nonnegative integer) with vector ``v``. Note that it will allocate memory up to ``i+1``.
        * ``a.build(n_trees)`` builds a forest of ``n_trees`` trees. Better trees gives higher precision when querying.
        * ``a.save(fn)`` saves the index to disk.
        * ``a.load(fn)`` loads (mmaps) an index from disk.
        * ``a.unload(fn)`` unloads.
        * ``a.get_nns_by_item(i, n)`` returns the ``n`` closest items. During the query it will inspect up to ``n_trees * n`` nodes. Note that for better performance you might want to oversample ``n``, eg. to fetch the top 100 items with higher precision, do ``a.get_nns_by_item(i, 1000)[:100]``. Also note that the array returned will include ``i`` as the first element.
        * ``a.get_nns_by_vector(v, n)`` same but query by vector ``v``.
        * ``a.get_item_vector_item(i)`` returns the vector for item ``i`` that was previously added.
        * ``a.get_distance(i, j)`` returns the distance between items ``i`` and ``j``.
        * ``a.get_n_items()`` returns the number of items in the index.
        
        Note that there's no bounds checking performed on the values so be careful.
        
        The C++ API is very similar: just ``#include "annoylib.h"`` to get access to it.
        
        
        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.
        
        More info
        ---------
        
        * `Dirk Eddelbuettel <http://dirk.eddelbuettel.com/>`__ provides an `R version of Annoy <http://dirk.eddelbuettel.com/code/rcpp.annoy.html>`__.
        * `Andy Sloane <http://www.a1k0n.net/>`__ provides a `Java version of Annoy <https://github.com/spotify/annoy-java>`__ although currently limited to cosine and read-only.
        
        For some interesting stats, check out Radim Řehůřek's great blog posts comparing Annoy to a couple of other similar Python libraries:
        
        * `Part 1: Intro <http://radimrehurek.com/2013/11/performance-shootout-of-nearest-neighbours-intro/>`__
        * `Part 2: Contestants <http://radimrehurek.com/2013/12/performance-shootout-of-nearest-neighbours-contestants/>`__
        * `Part 3: Querying <http://radimrehurek.com/2014/01/performance-shootout-of-nearest-neighbours-querying/>`__
        
        There's also some biased performance metrics in a `blog post <http://erikbern.com/?p=783>`__ by me. It compares Annoy, `FLANN <http://www.cs.ubc.ca/research/flann/>`__, `PANNS <https://github.com/ryanrhymes/panns>`__, and a `pull request <https://github.com/scikit-learn/scikit-learn/pull/3304>`__ to scikit-learn.
        
        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 `thirdwing <https://github.com/thirdwing>`__.
        
        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.
        
        Future stuff
        ------------
        
        * More performance tweaks
        * Expose some performance/accuracy tradeoffs at query time rather than index building time
        * Figure what O and Y stand for in the backronym :)
        
Keywords: nns,approximate nearest neighbor search
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
