Merge pull request #48 from catanzaromj/master

Implement Persistence Landscapes
scikit-tda · Mar 15, 2021 · fe5af88 · fe5af88
2 parents 822c9ca + a94b328
commit fe5af88
Show file tree

Hide file tree

Showing 18 changed files with 3,377 additions and 9 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,3 @@
 include *.txt
 include *.md
+include persim/landscapes/*
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@
 Persim is a Python package for many tools used in analyzing Persistence Diagrams.  It currently houses implementations of 
 
 - Persistence Images
+- Persistence Landscapes
 - Bottleneck distance
 - Modified Gromov&ndash;Hausdorff distance
 - Sliced Wasserstein Kernel

diff --git a/RELEASE.txt b/RELEASE.txt
@@ -1,3 +1,6 @@
+0.3.0
+    - Add implementations of Persistence Landscapes, including plotting methods, a transformer, and additional notebooks.
+
 0.2.1
     - Allowed for more than 9 diagram labels in plot_persistence_diagrams.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,9 @@
 |PyPI version| |Downloads| |Build Status| |Codecov| |License: MIT|
 
-Persim is a Python package for many tools used in analyzing Persistence Diagrams.  It currently houses implementations of 
+Persim is a Python package for many tools used in analyzing Persistence Diagrams.  It currently includes implementations of most of the popular methods of working with persistence diagrams, including
 
 - Persistence Images
+- Persistence Landscapes
 - Bottleneck distance
 - Modified Gromov--Hausdorff distance
 - Sliced Wasserstein Kernel
@@ -26,11 +27,11 @@ We welcome contributions of all shapes and sizes. There are lots of opportunitie
 
 To contribute please fork the project make your changes and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.
 
-
+Documentation
+--------------
 
 .. toctree::
     :maxdepth: 1
-    :hidden:
     :caption: User Guide
 
     notebooks/Persistence images
@@ -40,11 +41,12 @@ To contribute please fork the project make your changes and submit a pull reques
 
 .. toctree::
     :maxdepth: 1
-    :hidden:
     :caption: Tutorials
 
     notebooks/Classification with persistence images
     notebooks/Persistence barcode measure
+    notebooks/Differentiation with Persistence Landscapes
+    notebooks/Persistence Landscapes and Machine Learning
 
 
 .. |Downloads| image:: https://pypip.in/download/persim/badge.svg

diff --git a/docs/notebooks/Differentiation with Persistence Landscapes.ipynb b/docs/notebooks/Differentiation with Persistence Landscapes.ipynb
diff --git a/docs/notebooks/Persistence Landscapes and Machine Learning.ipynb b/docs/notebooks/Persistence Landscapes and Machine Learning.ipynb
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -27,7 +27,26 @@ Persistence Images
     persim.PersistenceImager
     persim.PersImage
 
+Persistence Landscapes
+========================
+.. autosummary::
+    :toctree: stubs
+    :recursive:
+    :nosignatures:
+
+    persim.PersLandscapeExact
+    persim.PersLandscapeApprox
+    persim.PersistenceLandscaper
+
+.. autosummary::
+    :toctree: stubs
+    :recursive:
+    :nosignatures:
 
+    persim.average_approx
+    persim.snap_PL
+    persim.plot_landscape
+    persim.plot_landscape_simple
 
 
 Diagram Visualization
@@ -40,8 +59,8 @@ Diagram Visualization
     persim.plot_diagrams
     persim.bottleneck_matching
     persim.wasserstein_matching
-
-
+    persim.plot_landscape
+    persim.plot_landscape_simple
 
 
 Persistence barcode measure

diff --git a/persim/_version.py b/persim/_version.py
@@ -1 +1 @@
-__version__ = "0.2.1"
+__version__ = "0.3.0"
diff --git a/persim/landscapes/__init__.py b/persim/landscapes/__init__.py
@@ -0,0 +1,5 @@
+from .exact import PersLandscapeExact
+from .approximate import PersLandscapeApprox
+from .transformer import PersistenceLandscaper
+from .visuals import plot_landscape, plot_landscape_simple
+from .tools import *