Skip to main content

Lorentz Local Canonicalization

Project description

Lorentz Local Canonicalization

Tests codecov PyPI version pytorch black

LLoCa-CS LLoCa-HEP

This repository contains a standalone implementation of Lorentz Local Canonicalization (LLoCa) by Jonas Spinner, Luigi Favaro, Peter Lippmann, Sebastian Pitz, Gerrit Gerhartz, Huilin Qu, Tilman Plehn, and Fred A. Hamprecht. LLoCa uses equivariantly predicted local reference frames and geometric message passing between these frames to make any architecture Lorentz-equivariant. You can read more about LLoCa in the following two papers and in the LLoCa documentation:

Installation

You can either install the latest release using pip

pip install lloca

or clone the repository and install the package in dev mode

git clone https://github.com/heidelberg-hepml/lloca.git
cd lloca
pip install -e .

How to use LLoCa

Please have a look at the LLoCa documentation (WIP) and our example notebook for the LLoCa-Transformer.

Features

  • Backbone architectures in lloca/backbone: Transformer, ParticleTransformer, ParticleNet, GraphNet, MLP
  • The Transformer backbone supports several attention kernels that can be installed optionally with e.g. pip install lloca[xformers_attention]
  • LLoCaMessagePassing as blueprint for generic LLoCa graph network backbones
  • Equivariant vector predictors in lloca/equivectors: EquiMLP
  • Local frames for equivariant architectures on several symmetry groups: $SO(1,3)$ (LearnedPDFrames, LearnedSO13Frames, LearnedRestFrames), $SO(3)$ (LearnedSO3Frames) and $SO(2)$ (LearnedSO2Frames); as well as the corresponding random global frames for data augmentation
  • Support for arbitrary higher-order representations with the TensorReps class

Coming soon:

  • More equivectors options
  • Parity-odd representations
  • Support for cross-attention

Examples

  • https://github.com/heidelberg-hepml/lorentz-frames: Codebase for the original papers; will eventually be based on the lloca repository. For now, development takes place in lorentz-frames and lloca serves as a stable version for others to work with.

Let us know if you use lloca, so we can add your repo to the list!

Citation

If you find this code useful in your research, please cite our papers

@article{Favaro:2025pgz,
    author = "Favaro, Luigi and Gerhartz, Gerrit and Hamprecht, Fred A. and Lippmann, Peter and Pitz, Sebastian and Plehn, Tilman and Qu, Huilin and Spinner, Jonas",
    title = "{Lorentz-Equivariance without Limitations}",
    eprint = "2508.14898",
    archivePrefix = "arXiv",
    primaryClass = "hep-ph",
    month = "8",
    year = "2025"
}
@article{Spinner:2025prg,
    author = "Spinner, Jonas and Favaro, Luigi and Lippmann, Peter and Pitz, Sebastian and Gerhartz, Gerrit and Plehn, Tilman and Hamprecht, Fred A.",
    title = "{Lorentz Local Canonicalization: How to Make Any Network Lorentz-Equivariant}",
    eprint = "2505.20280",
    archivePrefix = "arXiv",
    primaryClass = "stat.ML",
    month = "5",
    year = "2025"
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lloca-1.1.0.tar.gz (220.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lloca-1.1.0-py3-none-any.whl (55.8 kB view details)

Uploaded Python 3

File details

Details for the file lloca-1.1.0.tar.gz.

File metadata

  • Download URL: lloca-1.1.0.tar.gz
  • Upload date:
  • Size: 220.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lloca-1.1.0.tar.gz
Algorithm Hash digest
SHA256 917c232b5bfbdbcbce25e01c173005d2956f37297b59c69622fb6a22a3906a91
MD5 19e9bdbf99744bcbe1868917a82c06c6
BLAKE2b-256 ea9193f844aa5b33035b1b4cf03f0d457dd6e2c9d28bac648d91f99a8f85f035

See more details on using hashes here.

Provenance

The following attestation bundles were made for lloca-1.1.0.tar.gz:

Publisher: release.yaml on heidelberg-hepml/lloca

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lloca-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: lloca-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 55.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lloca-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 90ace521bdb3de9e61e6e0af993bd3a55e52f9ac147f86d700c5ee58432fd33d
MD5 39c86fac7cef8de90c4b0494aab81ef8
BLAKE2b-256 bb363219d917c645989a773c5fbac3ba678b87a47bf0bbf4ab8ec71bac4d23be

See more details on using hashes here.

Provenance

The following attestation bundles were made for lloca-1.1.0-py3-none-any.whl:

Publisher: release.yaml on heidelberg-hepml/lloca

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page