From 60ecdf61f41a02e14434fbfc7e402146edf689fb Mon Sep 17 00:00:00 2001 From: Ben Frederickson Date: Sat, 2 Sep 2017 14:43:40 +0200 Subject: [PATCH] Minor doc fixes The formatting for knnQueryBatch is messed up because of a missing newline: https://searchivarius.github.io/nmslib/api.html#nmslib.dist.FloatIndex.knnQueryBatch . Also listed out values for the DistType/DataType enums --- python_bindings/docs/api.rst | 13 +++++++++++++ python_bindings/nmslib.cc | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/python_bindings/docs/api.rst b/python_bindings/docs/api.rst index 0de5f9d..ef91ce4 100644 --- a/python_bindings/docs/api.rst +++ b/python_bindings/docs/api.rst @@ -9,6 +9,19 @@ function should be called first before calling any other method. .. autofunction:: nmslib.init + +.. class:: nmslib.DistType + + .. attribute:: FLOAT + .. attribute:: DOUBLE + .. attribute:: INT + +.. class:: nmslib.DataType + + .. attribute:: DENSE_VECTOR + .. attribute:: OBJECT_AS_STRING + .. attribute:: SPARSE_VECTOR + nmslib.FloatIndex ----------------- diff --git a/python_bindings/nmslib.cc b/python_bindings/nmslib.cc index 25e4360..cfe944e 100644 --- a/python_bindings/nmslib.cc +++ b/python_bindings/nmslib.cc @@ -438,7 +438,7 @@ void exportIndex(py::module * m) { .def("knnQueryBatch", &IndexWrapper::knnQueryBatch, py::arg("queries"), py::arg("k") = 10, py::arg("num_threads") = 0, "Performs multiple queries on the index, distributing the work over \n" - "a thread pool\n" + "a thread pool\n\n" "Parameters\n" "----------\n" "input: list\n"