diff options
author | Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> | 2020-05-11 21:24:38 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-11 21:24:38 +0200 |
commit | c232470b7199a284901d7576cb5f7616edd227b9 (patch) | |
tree | 61ed9c01c6e416a69b788e61206f0aaf4da11f7f /src/python/gudhi/point_cloud | |
parent | 2a4a9528aef4c553c3de9544b729c8a3c6f43c26 (diff) | |
parent | 0c64c706fa2c298cac079c00f71ef95061f9e6f8 (diff) |
Merge pull request #311 from VincentRouvreau/improve_dependencies_documentation2
Improve dependencies doc
Diffstat (limited to 'src/python/gudhi/point_cloud')
-rw-r--r-- | src/python/gudhi/point_cloud/knn.py | 4 | ||||
-rw-r--r-- | src/python/gudhi/point_cloud/timedelay.py | 5 |
2 files changed, 6 insertions, 3 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): diff --git a/src/python/gudhi/point_cloud/timedelay.py b/src/python/gudhi/point_cloud/timedelay.py index f01df442..5292e752 100644 --- a/src/python/gudhi/point_cloud/timedelay.py +++ b/src/python/gudhi/point_cloud/timedelay.py @@ -10,9 +10,8 @@ import numpy as np class TimeDelayEmbedding: - """Point cloud transformation class. - Embeds time-series data in the R^d according to [Takens' Embedding Theorem] - (https://en.wikipedia.org/wiki/Takens%27s_theorem) and obtains the + """Point cloud transformation class. Embeds time-series data in the R^d according to + `Takens' Embedding Theorem <https://en.wikipedia.org/wiki/Takens%27s_theorem>`_ and obtains the coordinates of each point. Parameters |