summaryrefslogtreecommitdiff
path: root/src/python/gudhi/point_cloud/knn.py
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-05-11 08:39:11 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-05-11 08:39:11 +0200
commit0ed4c3bba47d1375acb49596db2c863c38e9a090 (patch)
treea24404d9fc68ed769816afc2aff136a542a38a01 /src/python/gudhi/point_cloud/knn.py
parentb91fa852b141a5f8b4a4915849b35fbdb6993772 (diff)
Fix #299
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 34e80b5d..19363097 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):