GeomFuM is a Modular Python Package for Machine Learning with Functional Maps. Have a look at our Software Paper Preprint.
Installation
We have a pipl package that you can install with the following command from your terminal
pip install geomfum
Or directly from the GitHub repository
pip install geomfum@git+https://github.com/3diglab/geomfum.git@main
Or
pip install geomfum pip install geomstats@git+https://github.com/geomstats/geomstats.git@main
Or the classic pipeline: clone + pip install.
Make sure you have installed the most recent version of Geomstats to correctly handle the backend.
- ::
pip install geomstats@git+https://github.com/geomstats/geomstats.git@main
⚠️ ISSUES
Installation issues may arise from dependencies relying on C++ (particularly robust_laplacian).
Make sure all their requirements are installed.
Some functionality requires packages that are not published on PyPI and must be installed manually:
Rematching:
pip install git+https://github.com/filthynobleman/rematching.git@python-binding
Polpo:
pip install git+https://github.com/geometric-intelligence/polpo.git@main
How to use
The how-to notebooks are designed to safely let you dive in the package.
Why not starting from the beginning and simply follow the links that inspire you the most?
Choose the backend
GeomFuM can run seamlessly with numpy and pytorch. By default, the numpy backend is used. The visualizations are only available with this backend.
The backend is based on the Geomstats backend, which is installed automatically. The GeomFuM backend add functionality, especially regarding sparse matrices and device handling.
You can choose your backend by setting the environment variable GEOMSTATS_BACKEND to numpy, or pytorch, and importing the backend module. From the command line:
export GEOMSTATS_BACKEND=<backend_name>
and in the Python3 code:
import gsops.backend as gs
Contributions
We welcome contributions from the community! If you have suggestions, bug reports, or want to improve the code or documentation, feel free to:
Open an issue
Submit a pull request
Improve or add new examples/notebooks
Please follow our contribution guidelines and adhere to best practices for clean, modular, and well-documented code.
Community
Join our Discord Server! https://discord.gg/THHku2ckJs
List of Implemented Papers
Functional Maps: A Flexible Representation of Maps Between Shapes
Rematching: Low-resolution representations for scalable shape correspondence
ZoomOut: Spectral Upsampling for Efficient Shape Correspondence
Fast Sinkhorn Filters: Using Matrix Scaling for Non-Rigid Shape Correspondence with Functional Maps
Bijective upsampling and learned embedding for point clouds correspondences
Deep Geometric Functional Maps: Robust Feature Learning for Shape Correspondence
Laplace-Beltrami Eigenfunctions Towards an Algorithm That “Understands” Geometry
A Concise and Provably Informative Multi-Scale Signature Based on Heat Diffusion
The Wave Kernel Signature: A Quantum Mechanical Approach To Shape Analysis
Informative Descriptor Preservation via Commutativity for Shape Matching
PointNet: Deep Learning on Point Sets for 3D Classification and Segmentation
Acknowledgement
We thank the geometry processing and functional maps community for their foundational research and ongoing contributions that inspired this work, particularly open-source libraries on functional maps such as pyFM (RobinMagnet), FMNet (pvnieo), and Unsupervised-Learning-of-Robust-Spectral-Shape-Matching (dongliangcao), which provided valuable implementations and examples. We tried our best, referencing all relevant works in the library to give credit to researchers and developers; however, we acknowledge that we could have missed some! Please contact us and propose a change if you want recognition and think something is missing!
If you use Geomfum, please cite the Software to give recognition to any contributor of the project.
This work was partially supported by the European Union (Next Generation EU), MUR (REGAINS), NVIDIA Academic Hardware Grant, and the NSF (MRSEC and CAREER awards).
Have FuM!
Metadata
Release files for geomfum 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| geomfum-1.0.0.tar.gz | 72.3 kB | Without provenance | Details for geomfum-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| geomfum-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for geomfum-1.0.0-py3-none-any.whl |
Total release size: 160.6 kB
Release files / geomfum-1.0.0.tar.gz
| Download URL | geomfum-1.0.0.tar.gz |
|---|---|
| Size | 72.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3a29701090dbc9145002eb87913531fe040639a05991157c3e1e222cca4dae78
|
|
BLAKE2b-256 checksum How to use checksums |
d6d8ddd5551e1a076b1aa3953c5ebd16999c25fe6d63fcf9b90062accd7983a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / geomfum-1.0.0-py3-none-any.whl
| Download URL | geomfum-1.0.0-py3-none-any.whl |
|---|---|
| Size | 88.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0bc7b0e976d0fe7951390813fde268e676a2553eda6d4c34ce231e320e11a8a7
|
|
BLAKE2b-256 checksum How to use checksums |
87b229656cd26a5043fcae4f013138af3052508614958645a22b7b3cda3b627f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Security for geomfum 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.