scikit-tda / persim

Distances and representations of persistence diagrams
https://persim.scikit-tda.org
MIT License
126 stars 52 forks source link

Persistent entropy implementation #10

Closed EduPH closed 5 years ago

EduPH commented 5 years ago

Hi scikit-tda developers!

I am a PhD student from the Combinatorial Image Analysis research group (University of Seville) and I was wondering if we could add persistent entropy, which is a topological data analysis tool with information theory inspiration, to the Scikit-tda library. It has been used in several papers such as [1], [2] or [3], among others.

[1] Atienza, N., González-Díaz, R., & Rucco, M. (2017). Persistent entropy for separating topological features from noise in vietoris-rips complexes. Journal of Intelligent Information Systems, 1-19. [2] Atienza, N., González-Díaz, R., & Soriano-Trigueros, M. (2018). A new entropy based summary function for topological data analysis. Electronic Notes in Discrete Mathematics, 68: 113-118. [3] Rucco, M., González-Díaz, R., Jimenez, M.J., Atienza, N., Cristalli, C., Concettoni, E., Ferrante,A., & Merelli, A. (2017)A new topological entropy-based approach for measuring similarities among piecewise linear functions. Signal Processing, 130-138.

Greetings

sauln commented 5 years ago

Sounds great!

Is the API for the other distances appropriate? Hopefully you can use one of those such as bottleneck.py as a template.

Then make sure to add it to the docs (maybe here) and everything should be good to go.

If you'd like to add a notebook or example to provide users with a brief explanation of how it works and how it should be used, that would be great also!

EduPH commented 5 years ago

Just done a pull request. I will do another with a notebook and examples as soon as possible.

sauln commented 5 years ago

Thanks for your contribution! I've merged the PR to master. The next steps will be for me to deploy updated documentation and release the code to Pypi. I'll get on that shortly.

EduPH commented 5 years ago

Thank you for your patience and great corrections. It has been a pleasure. I wish you the best with this project.

sauln commented 5 years ago

Thank you for your contribution! I'm glad we were able to incorporate the addition.