Simple Approximate Nearest Neighbors in Python with Annoy and lmdb
Recently, I’ve been playing around with adding and subtracting word embeddings learned from GloVe. For example, we can take the embedding for the word “king” subtract the embedding for “man” and then add the embedding for “woman” and end up with a resulting embedding (vector). Next, if we have a corpus of these word-embedding pairs we can search through it to find the most similar embedding and retrieve the corresponding word. If we did this for the query above we would get:
King + (Woman - Man) = Queen
There are many ways to search through this corpus of word-embedding pairs for the nearest neighbors to a query. One way to guarantee that you find the optimal vector is to iterate through your corpus and compare how similar each pair is to the query. This however is incredibly time consuming and not often used. A better exact technique would be to use a vectorized cosine distance shown below:
For more info on cosine distance check out this great resource: Cosine Similarity
Vectorized cosine distance is notably faster than the iterative method but still may be too slow. This is where approximate nearest neighbors shines: returning approximate results but blazingly quickly. Many times you don’t need exact optimal results, for example: what even is the exact similar word for “Queen?” In these cases where you need good enough results quickly, you should use approximate nearest neighbors.
In this article we will be writing a simple python script to quickly find approximate nearest neighbors. We will use the Python library Annoy and lmdb. For my corpus, I will be using word-embedding pairs, but the instructions below work with any type of embeddings: such as embeddings of songs to create a recommendation engine for similar songs or even photo embeddings to enable reverse image search.
Making an Annoy Index
Lets create a python script called: “make_annoy_index.” To start off lets include the dependencies that we will use:
The last line we have is an import from “vector_utils”. We will be writing “vector_utils” later on so don’t worry now!
Next, on to the meat of our script: the “create_index” function. Here we will be generating our lmdb map and our Annoy index.
- First we find the length of our embedding which is used to instantiate an Annoy index.
- Next we instantiate an lmdb map with the line: “env = lmdb.open(fn_lmdb, map_size=int(1e9)).”
- Make sure we don’t have an Annoy index or lmdb map in the current path
- Add every key and vector from our embeddings file to both our lmdb map and our Annoy index
- Build and save our Annoy index
I’ve included “argparse” so we can call our script from the command line:
Add a main function to call our script and we are done with “make_annoy_index.py”:
Now we can just call our new script from the command line to generate an Annoy index and a corresponding lmdb map!
python2 make_annoy_index.py \
--embeddings=<embedding path> \
Writing Vector Utils
In “make_annoy_index.py” we included a python script “vector_utils.” We will write this script now. “Vector_utils” is used to help read in vectors from .txt, .bin, and .pkl files.
Writing this script is not that relevant to what we are doing so I’ve just included the whole script below:
Testing our Index and lmdb Map
Now that we have generated an Annoy index and lmdb map lets write a script to use them to do inference.
Name our file “annoy_inference.py” and include the dependencies:
Now we need to load in our Annoy index and our lmdb map; we will load them globally for easy access. Note that for me “VEC_LENGTH” is 50. Make sure that your “VEC_LENGTH” matches the length of your embedding, otherwise Annoy will not be happy.
The fun part, the “calculate” function.
- Get the index for our query from our lmdb map
- Get the corresponding vector from Annoy with “get_item_vector(id)”
- Get the nearest neighbors from Annoy with “a.get_nns_by_vector(v, num_results)”
Again, here is an “argparse” object to make reading command line arguments easier
And, a main function to call “annoy_inference.py” from the command line:
Great! Now we can use our Annoy index and lmdb map to get the nearest neighbors to a query!
python2 annoy_inference.py --token="test" --num_results=30
['test', 'tests', 'determine', 'for', 'crucial', 'only', 'preparation', 'needed', 'positive', 'guided', 'time', 'performance', 'one', 'fitness', 'replacement', 'stages', 'made', 'both', 'accuracy', 'deliver', 'put', 'standardized', 'best', 'discovery', '.', 'a', 'diagnostic', 'delayed', 'while', 'side']
You can clone the corresponding repo to get all the code in this tutorial: https://github.com/kyang6/annoy_tutorial
Boy, that was a lot of code. But, now we have scripts to take any embedding data and generate an Annoy index and lmdb map to find approximate nearest neighbors!
If you have questions or concerns please email me! firstname.lastname@example.org