Documentation
Scikit-style PyTorch-autodiff multiparameter persistent homology python library.
This library aims to provide easy to use and performant strategies for applied multiparameter topology.
Meant to be integrated in the Gudhi library.
This library allows computing several representations from "geometrical datasets", e.g., point clouds, images, graphs, that have multiple scales. A well known example is the following one.
Pick a point cloud that has diffuse noise, or on which the sampling measure has some interesting properties, e.g., in the following example the measure has three modes.
Now define a two parameter grid (filtration) of topological spaces (on the left) from a point cloud
The green shape on the left represents the lifetime of the biggest annulus. On the right, each cycle appearing on the left gets a colored shape (the color is only a label) and the shape of this colored shape represents the lifetime of this cycle.
In our case, the big green shape on the left corresponds to the largest green shape appearing on the right, recovering the structure of the annulus here.
The magic part is that we never had to choose any parameter to remove the noise in this construction, but the annulus still naturally appears!
A more striking example is the following one.
Using the same constructions, we can identify topological structure, and their size, in a parameter free approach, even though the majority of the sampling measure's mass is noise.
In this example, the lifetime shape associated to each cycle can be identified from
- Their radius : the smaller cycle will naturally live more this shape will appear on the "left" (smaller radius)
- Their concentration : Cycles having more concentration will appear lower than others (smaller co-density)
Notice that this construction is also very stable w.r.t. the noise. The more noise is added the smaller the "rainbow strip" is, and the more the "large shape" are visible. We also provide several other descriptors, as well as associated Machine Learning technics and pipelines. In the following example from the same dataset, the Hilbert decomposition signed measure, the Euler decomposition signed measure and the rank decomposition signed measure.
A non-exhaustive list of features can be found in the Features section, and in the documentation.
This library is available on PyPI for Linux and macOS, via
pip install multipers
We recommend Windows user to use WSL.
A documentation and building instructions are available here.
This library features a bunch of different functions and helpers. See below for a non-exhaustive list.
Filled box refers to implemented or interfaced code.
- [Multiparameter Module Approximation] provides the multiparameter simplicial structure, as well as technics for approximating modules, via interval-decomposable modules. It is also very useful for visualization.
- [Stable Vectorization of Multiparameter Persistent Homology using Signed Barcodes as Measures, NeurIPS2023] provides fast representations of multiparameter persistence modules, by using their signed barcodes decompositions encoded into signed measures. Implemented decompositions : Euler surfaces, Hilbert function, rank invariant (i.e. rectangles). It also provides representation technics for Machine Learning, i.e., Sliced Wasserstein kernels, and Vectorizations.
- [A Framework for Fast and Stable Representations of Multiparameter Persistent Homology Decompositions, NeurIPS2023] Provides a vectorization framework for interval decomposable modules, for Machine Learning. Currently implemented as an extension of MMA.
- [Differentiability and Optimization of Multiparameter Persistent Homology, ICML2024] An approach to compute a (clarke) gradient for any reasonable multiparameter persistent invariant. Currently, any
multipers
computation is auto-differentiable using this strategy, provided that the input are pytorch gradient capable tensor. - [Multiparameter Persistence Landscapes, JMLR] A vectorization technic for multiparameter persistence modules.
- [Filtration-Domination in Bifiltered Graphs, ALENEX2023] Allows for 2-parameter edge collapses for 1-critical clique complexes. Very useful to speed up, e.g., Rips-Codensity bifiltrations.
- [Chunk Reduction for Multi-Parameter Persistent Homology, SOCG2019] Multi-filtration preprocessing algorithm for homology computations.
- [Computing Minimal Presentations and Bigraded Betti Numbers of 2-Parameter Persistent Homology, JAAG] Minimal presentation of multiparameter persistence modules, using mpfree. Hilbert, Rank Decomposition Signed Measures, and MMA decompositions can be computed using the mpfree backend.
- [Delaunay Bifiltrations of Functions on Point Clouds, SODA2024] Provides an alternative to function rips bifiltrations, using Delaunay complexes. Very good alternative to Rips-Density like bifiltrations.
- [Rivet] Interactive two parameter persistence
- [Kernel Operations on the GPU, with Autodiff, without Memory Overflows, JMLR] Although not linked, at first glance, to persistence in any way, this library allows computing blazingly fast signed measures convolutions (and more!) with custom kernels.
- [Backend only] [Projected distances for multi-parameter persistence modules] Provides a strategy to estimate the convolution distance between multiparameter persistence module using projected barcodes. Implementation is a WIP.
- [Partial, and experimental] [Efficient Two-Parameter Persistence Computation via Cohomology, SoCG2023] Minimal presentations for 2-parameter persistence algorithm.
If I missed something, or you want to add something, feel free to open an issue.
David Loiseaux,
Hannah Schreiber (Persistence backend code),
Luis Scoccola
(Möbius inversion in python, degree-rips using persistable and RIVET),
Mathieu Carrière (Sliced Wasserstein)
Feel free to contribute, report a bug on a pipeline, or ask for documentation by opening an issue.
In particular, if you have a nice example or application that is not taken care in the documentation (see the ./docs/notebooks/ folder), please contact me to add it there.