summaryrefslogtreecommitdiff
path: root/src/python/gudhi/point_cloud/knn.py
diff options
context:
space:
mode:
authorVincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com>2020-05-11 21:24:38 +0200
committerGitHub <noreply@github.com>2020-05-11 21:24:38 +0200
commitc232470b7199a284901d7576cb5f7616edd227b9 (patch)
tree61ed9c01c6e416a69b788e61206f0aaf4da11f7f /src/python/gudhi/point_cloud/knn.py
parent2a4a9528aef4c553c3de9544b729c8a3c6f43c26 (diff)
parent0c64c706fa2c298cac079c00f71ef95061f9e6f8 (diff)
Merge pull request #311 from VincentRouvreau/improve_dependencies_documentation2
Improve dependencies doc
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..86008bc3 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):