Merge pull request #144 from nmslib/develop

Merge pypi package changes to master

Author: yurymalkov

.travis.yml

@@ -3,6 +3,7 @@ language: python
 matrix:
   include:
     - python: 3.6
+    - python: 3.7
 install:
   - |
     cd python_bindings
@@ -12,4 +13,4 @@ install:
 script:
   - |
     cd python_bindings
-    python setup.py test
+    python setup.py test

README.md

@@ -1,6 +1,10 @@
 # Hnswlib - fast approximate nearest neighbor search
 Header-only C++ HNSW implementation with python bindings. Paper code for the HNSW 200M SIFT experiment
 
+**NEWS:**
+
+**Thanks to Louis Abraham ([@louisabraham](https://github.com/louisabraham)) hnswlib is now can be installed via pip!**
+
 Highlights:
 1) Lightweight, header-only, no dependencies other than C++ 11.
 2) Interfaces for C++, python and R (https://github.com/jlmelville/rcpphnsw).
@@ -26,7 +30,7 @@ Note that inner product is not an actual metric. An element can be closer to som
 
 For other spaces use the nmslib library https://github.com/nmslib/nmslib. 
 
-#### short API description
+#### Short API description
 * `hnswlib.Index(space, dim)` creates a non-initialized index an HNSW in space `space` with integer dimension `dim`.
 
 Index methods:
@@ -45,7 +49,7 @@ Index methods:
 * `resize_index(new_size)` - changes the maximum capacity of the index. Not thread safe with `add_items` and `knn_query`.
 
 * `set_ef(ef)` - sets the query time accuracy/speed trade-off, defined by the `ef` parameter (
-[ALGO_PARAMS.md](ALGO_PARAMS.md)).
+[ALGO_PARAMS.md](ALGO_PARAMS.md)). Note that the parameter is currently not saved along with the index, so you need to set it manually after loading.
 
 * `knn_query(data, k = 1, num_threads = -1)` make a batch query for `k` closests elements for each element of the 
     * `data` (shape:`N*dim`). Returns a numpy array of (shape:`N*k`).
@@ -166,13 +170,18 @@ print("Recall for two batches:", np.mean(labels.reshape(-1) == np.arange(len(dat
 ```
 
 ### Bindings installation
+
+You can install from sources:
 ```bash
 apt-get install -y python-setuptools python-pip
 pip3 install pybind11 numpy setuptools
 cd python_bindings
 python3 setup.py install
 ```
 
+or you can install via pip:
+`pip install hnswlib`
+
 ### Other implementations
 * Non-metric space library (nmslib) - main library(python, C++), supports exotic distances: https://github.com/nmslib/nmslib
 * Faiss libary by facebook, uses own HNSW  implementation for coarse quantization (python, C++):

python_bindings/MANIFEST.in

@@ -0,0 +1 @@
+include hnswlib/*.h

python_bindings/Makefile

@@ -0,0 +1,14 @@
+pypi: dist
+	twine upload dist/*
+
+dist:
+	-rm dist/*
+	python3 setup.py sdist
+
+test:
+	python3 setup.py test
+
+clean:
+	rm -rf *.egg-info build dist var first_half.bin tests/__pycache__ hnswlib.cpython-36m-darwin.so
+
+.PHONY: dist

python_bindings/bindings.cpp

@@ -2,7 +2,7 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/numpy.h>
 #include <pybind11/stl.h>
-#include "../hnswlib/hnswlib.h"
+#include "hnswlib/hnswlib.h"
 #include <thread>
 #include <atomic>
 

python_bindings/hnswlib

@@ -0,0 +1 @@
+../hnswlib