summaryrefslogtreecommitdiff
path: root/src/python/gudhi/point_cloud/knn.py
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-05-12 23:00:30 +0200
committerMarc Glisse <marc.glisse@inria.fr>2020-05-12 23:00:30 +0200
commit5631b0d1d9f7cc7e033e40fb9b94c8fe473f6082 (patch)
tree5e52bb5b52b41a1b27053ad51bd72f8274d4c27a /src/python/gudhi/point_cloud/knn.py
parentc5fca5477cc6fff77acedf7b5324eb5f8b417ed3 (diff)
parent1efd71c502bacce375e1950e10a8112208acd0cf (diff)
Merge remote-tracking branch 'origin/master' into dtmdensity
Diffstat (limited to 'src/python/gudhi/point_cloud/knn.py')
-rw-r--r--src/python/gudhi/point_cloud/knn.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/python/gudhi/point_cloud/knn.py b/src/python/gudhi/point_cloud/knn.py
index 65896847..4652fe80 100644
--- a/src/python/gudhi/point_cloud/knn.py
+++ b/src/python/gudhi/point_cloud/knn.py
@@ -19,6 +19,10 @@ __license__ = "MIT"
class KNearestNeighbors:
"""
Class wrapping several implementations for computing the k nearest neighbors in a point set.
+
+ :Requires: `PyKeOps <installation.html#pykeops>`_, `SciPy <installation.html#scipy>`_,
+ `Scikit-learn <installation.html#scikit-learn>`_, and/or `Hnswlib <installation.html#hnswlib>`_
+ in function of the selected `implementation`.
"""
def __init__(self, k, return_index=True, return_distance=False, metric="euclidean", **kwargs):