summaryrefslogtreecommitdiff
path: root/src/python/gudhi/point_cloud/knn.py
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-03-28 11:48:43 +0100
committerMarc Glisse <marc.glisse@inria.fr>2020-03-28 11:48:43 +0100
commit35a12b553c85af8ce31629b90a27a7071b0cc379 (patch)
tree795fbe61b893a88cd0ac64c249dad276bcf36de2 /src/python/gudhi/point_cloud/knn.py
parent68839b95e7751afd04155cd2565cc53362f01fa2 (diff)
Doc tweaks, default DTM exponent
Diffstat (limited to 'src/python/gudhi/point_cloud/knn.py')
-rw-r--r--src/python/gudhi/point_cloud/knn.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/python/gudhi/point_cloud/knn.py b/src/python/gudhi/point_cloud/knn.py
index 02448530..31e4fc9f 100644
--- a/src/python/gudhi/point_cloud/knn.py
+++ b/src/python/gudhi/point_cloud/knn.py
@@ -18,7 +18,7 @@ class KNN:
def __init__(self, k, return_index=True, return_distance=False, metric="euclidean", **kwargs):
"""
Args:
- k (int): number of neighbors (including the point itself).
+ k (int): number of neighbors (possibly including the point itself).
return_index (bool): if True, return the index of each neighbor.
return_distance (bool): if True, return the distance to each neighbor.
implementation (str): Choice of the library that does the real work.
@@ -68,7 +68,7 @@ class KNN:
def fit(self, X, y=None):
"""
Args:
- X (numpy.array): coordinates for reference points
+ X (numpy.array): coordinates for reference points.
"""
self.ref_points = X
if self.params["implementation"] == "ckdtree":
@@ -105,7 +105,7 @@ class KNN:
def transform(self, X):
"""
Args:
- X (numpy.array): coordinates for query points, or distance matrix if metric is "precomputed"
+ X (numpy.array): coordinates for query points, or distance matrix if metric is "precomputed".
"""
metric = self.metric
k = self.k