summaryrefslogtreecommitdiff
path: root/src/python/gudhi/point_cloud
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-04-22 13:04:15 +0200
committerMarc Glisse <marc.glisse@inria.fr>2020-04-22 13:04:15 +0200
commitaa90b98bee73ab2aaf39ef91f39f5a750168e5d4 (patch)
tree860477cb0e5154155fc3c335caa0ea0030f7320c /src/python/gudhi/point_cloud
parent2a4fcecfb30ef48e4925c885a9f492d2ef0705e5 (diff)
Document several optional dependencies of knn
Diffstat (limited to 'src/python/gudhi/point_cloud')
-rw-r--r--src/python/gudhi/point_cloud/knn.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/python/gudhi/point_cloud/knn.py b/src/python/gudhi/point_cloud/knn.py
index 4017e498..07553d6d 100644
--- a/src/python/gudhi/point_cloud/knn.py
+++ b/src/python/gudhi/point_cloud/knn.py
@@ -44,7 +44,8 @@ class KNearestNeighbors:
Otherwise, neighbors are returned in an arbitrary order. Defaults to True.
enable_autodiff (bool): if the input is a torch.tensor, jax.numpy.ndarray or tensorflow.Tensor, this
instructs the function to compute distances in a way that works with automatic differentiation.
- This is experimental and not supported for all metrics. Defaults to False.
+ This is experimental, not supported for all metrics, and requires the package EagerPy.
+ Defaults to False.
kwargs: additional parameters are forwarded to the backends.
"""
self.k = k