From 5f3e8d6e7a670a4339bd4afea5c62ba4d7d18c00 Mon Sep 17 00:00:00 2001 From: Leonid Boytsov Date: Fri, 2 Feb 2018 09:53:57 -0500 Subject: [PATCH 1/5] Update README.md --- python_bindings/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/python_bindings/README.md b/python_bindings/README.md index 91651d4..7384063 100644 --- a/python_bindings/README.md +++ b/python_bindings/README.md @@ -23,6 +23,8 @@ information](https://github.com/pybind/python_example#installation). #### Example Usage +Here is a simple example, but we have [Python notebooks with more details](notebooks) (for both sparse and dense space): + ```python import nmslib import numpy From 4a3078b9d7d38df6beac88dd6fe47635e65d4e52 Mon Sep 17 00:00:00 2001 From: Leonid Boytsov Date: Fri, 2 Feb 2018 09:55:26 -0500 Subject: [PATCH 2/5] Update README.md --- python_bindings/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_bindings/README.md b/python_bindings/README.md index 7384063..f8372f2 100644 --- a/python_bindings/README.md +++ b/python_bindings/README.md @@ -23,7 +23,7 @@ information](https://github.com/pybind/python_example#installation). #### Example Usage -Here is a simple example, but we have [Python notebooks with more details](notebooks) (for both sparse and dense space): +Here is a simple example, but we also have [Python notebooks with more elaborate end-to-end examples, which include even computation of gold-standard data](notebooks) (for both sparse and dense space): ```python import nmslib From 2edf3c064ac8f8acbcbed2407cb78c2e972f71c8 Mon Sep 17 00:00:00 2001 From: Leonid Boytsov Date: Fri, 2 Feb 2018 09:56:06 -0500 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 60cbd59..beb21fd 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Non-Metric Space Library (NMSLIB) ================= -The latest **pre**-release is [1.6](https://github.com/searchivarius/nmslib/releases/tag/v1.6). Note that the manual is not updated to reflect 1.6 changes. In particular, we changed the build procedure for Windows. Also note that the manual targets primiarily developers who will extend the library. For most other folks, [Python binding docs should be sufficient](https://searchivarius.github.io/nmslib/). +The latest **pre**-release is [1.6](https://github.com/searchivarius/nmslib/releases/tag/v1.6). Note that the manual is not updated to reflect 1.6 changes. In particular, we changed the build procedure for Windows. Also note that the manual targets primiarily developers who will extend the library. For most other folks, [Python binding docs should be sufficient](python_bindings). ----------------- Non-Metric Space Library (NMSLIB) is an **efficient** cross-platform similarity search library and a toolkit for evaluation of similarity search methods. The core-library does **not** have any third-party dependencies. From 45d57c897e4616fa44c340e5fc9b0dcc222dbb53 Mon Sep 17 00:00:00 2001 From: Leonid Boytsov Date: Fri, 2 Feb 2018 09:57:08 -0500 Subject: [PATCH 4/5] Update README.md --- python_bindings/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/python_bindings/README.md b/python_bindings/README.md index f8372f2..2016d10 100644 --- a/python_bindings/README.md +++ b/python_bindings/README.md @@ -45,6 +45,10 @@ ids, distances = index.knnQuery(data[0], k=10) neighbours = index.knnQueryBatch(data, k=10, num_threads=4) ``` +#### Additional documentation + +[Even more detailed documentation is also available](https://searchivarius.github.io/nmslib/) (thanks to Ben Frederickson). + #### Installing with Extras To enable extra methods like those provided by FALCONN and LSHKIT you need to follow an extra couple steps. @@ -72,6 +76,3 @@ cd python_bindings pip install -r requirements.txt python setup.py install ``` -#### Additional documentation - -[More detailed documentation is also available](https://searchivarius.github.io/nmslib/) (thanks to Ben Frederickson). From 8b2c606e2218bbc5709be77a3979032322f6ae42 Mon Sep 17 00:00:00 2001 From: Leonid Boytsov Date: Fri, 2 Feb 2018 09:57:51 -0500 Subject: [PATCH 5/5] Update README.md --- python_bindings/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/python_bindings/README.md b/python_bindings/README.md index 2016d10..b2cd762 100644 --- a/python_bindings/README.md +++ b/python_bindings/README.md @@ -45,10 +45,6 @@ ids, distances = index.knnQuery(data[0], k=10) neighbours = index.knnQueryBatch(data, k=10, num_threads=4) ``` -#### Additional documentation - -[Even more detailed documentation is also available](https://searchivarius.github.io/nmslib/) (thanks to Ben Frederickson). - #### Installing with Extras To enable extra methods like those provided by FALCONN and LSHKIT you need to follow an extra couple steps. @@ -76,3 +72,7 @@ cd python_bindings pip install -r requirements.txt python setup.py install ``` + +#### Additional documentation + +[More detailed documentation is also available](https://searchivarius.github.io/nmslib/) (thanks to Ben Frederickson).