From 908679b72c215d1914d8e3956126fa44367b937f Mon Sep 17 00:00:00 2001 From: Marc Glisse Date: Fri, 15 Nov 2019 22:45:15 +0100 Subject: The big rename: sktda -> representations --- src/python/doc/index.rst | 2 +- src/python/doc/representations.rst | 35 ++++++++++++++++++++++++++++++++++ src/python/doc/representations_sum.inc | 14 ++++++++++++++ src/python/doc/sktda.rst | 35 ---------------------------------- src/python/doc/sktda_sum.inc | 14 -------------- 5 files changed, 50 insertions(+), 50 deletions(-) create mode 100644 src/python/doc/representations.rst create mode 100644 src/python/doc/representations_sum.inc delete mode 100644 src/python/doc/sktda.rst delete mode 100644 src/python/doc/sktda_sum.inc (limited to 'src/python/doc') diff --git a/src/python/doc/index.rst b/src/python/doc/index.rst index f8dd3c2f..1ef08096 100644 --- a/src/python/doc/index.rst +++ b/src/python/doc/index.rst @@ -81,7 +81,7 @@ Wasserstein distance Persistence representations =========================== -.. include:: sktda_sum.inc +.. include:: representations_sum.inc Persistence graphical tools =========================== diff --git a/src/python/doc/representations.rst b/src/python/doc/representations.rst new file mode 100644 index 00000000..3db1c95a --- /dev/null +++ b/src/python/doc/representations.rst @@ -0,0 +1,35 @@ +:orphan: + +.. To get rid of WARNING: document isn't included in any toctree + +=================================== +Representations reference manual +=================================== + +Preprocessing +------------- +.. automodule:: gudhi.representations.preprocessing + :members: + :special-members: + :show-inheritance: + +Vector methods +-------------- +.. automodule:: gudhi.representations.vector_methods + :members: + :special-members: + :show-inheritance: + +Kernel methods +-------------- +.. automodule:: gudhi.representations.kernel_methods + :members: + :special-members: + :show-inheritance: + +Metrics +------- +.. automodule:: gudhi.representations.metrics + :members: + :special-members: + :show-inheritance: diff --git a/src/python/doc/representations_sum.inc b/src/python/doc/representations_sum.inc new file mode 100644 index 00000000..7b167a17 --- /dev/null +++ b/src/python/doc/representations_sum.inc @@ -0,0 +1,14 @@ +.. table:: + :widths: 30 50 20 + + +------------------------------------------------------------------+----------------------------------------------------------------+-----------------------------------------------+ + | .. figure:: | Vectorizations, distances and kernels that work on persistence | :Author: Mathieu Carrière | + | ../../doc/Persistence_representations/average_landscape.png | diagrams, compatible with scikit-learn. | | + | | | :Introduced in: GUDHI 3.1.0 | + | | | | + | | | :Copyright: MIT | + | | | | + | | | :Requires: scikit-learn | + +------------------------------------------------------------------+----------------------------------------------------------------+-----------------------------------------------+ + | * :doc:`representations` | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ diff --git a/src/python/doc/sktda.rst b/src/python/doc/sktda.rst deleted file mode 100644 index 9acec616..00000000 --- a/src/python/doc/sktda.rst +++ /dev/null @@ -1,35 +0,0 @@ -:orphan: - -.. To get rid of WARNING: document isn't included in any toctree - -=================================== -sktda reference manual -=================================== - -Preprocessing -------------- -.. automodule:: gudhi.sktda.preprocessing - :members: - :special-members: - :show-inheritance: - -Vector methods --------------- -.. automodule:: gudhi.sktda.vector_methods - :members: - :special-members: - :show-inheritance: - -Kernel methods --------------- -.. automodule:: gudhi.sktda.kernel_methods - :members: - :special-members: - :show-inheritance: - -Metrics -------- -.. automodule:: gudhi.sktda.metrics - :members: - :special-members: - :show-inheritance: diff --git a/src/python/doc/sktda_sum.inc b/src/python/doc/sktda_sum.inc deleted file mode 100644 index a0f77e7e..00000000 --- a/src/python/doc/sktda_sum.inc +++ /dev/null @@ -1,14 +0,0 @@ -.. table:: - :widths: 30 50 20 - - +------------------------------------------------------------------+----------------------------------------------------------------+-----------------------------------------------+ - | .. figure:: | Vectorizations, distances and kernels that work on persistence | :Author: Mathieu Carrière | - | ../../doc/Persistence_representations/average_landscape.png | diagrams, compatible with scikit-learn. | | - | | | :Introduced in: GUDHI 3.1.0 | - | | | | - | | | :Copyright: MIT | - | | | | - | | | :Requires: scikit-learn | - +------------------------------------------------------------------+----------------------------------------------------------------+-----------------------------------------------+ - | * :doc:`sktda` | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -- cgit v1.2.3