Skip to main content

Efficient reimplementation of PELICAN (Permutation-Equivariant and Lorentz-Invariant or Covariant Aggregator Network for Particle Physics)

Project description

PELICAN-lite

Tests codecov PyPI version pytorch

This is an efficient reimplementation of the PELICAN architecture. PELICAN was first published at the ML4PS workshop 2022 and on JHEP. The official implementation is available on https://github.com/abogatskiy/PELICAN.

This implementation aims to improve efficiency and ease of use. For toptagging with batch size 100, we find 8x reduced memory usage and a 3x training speedup compared to the original implementation. PELICAN-lite can be used as the Frames-Net in Lorentz Local Canonicalization (LLoCa).

You can read more about this implementation in the PELICAN-lite documentation.

Installation

You can either install the latest release using pip

pip install pelican-lite

or clone the repository and install the package in dev mode

git clone https://github.com/heidelberg-hepml/pelican-lite.git
cd pelican
pip install -e .
pip install -r requirements.txt
pre-commit install

How to use PELICAN-lite

Please have a look at the PELICAN-lite documentation and our example notebook in examples/demo.ipynb.

Examples

  • https://github.com/heidelberg-hepml/lorentz-frames: PELICAN-lite jet taggers and amplitude regressors. A PELICAN tagger based on the official implementation is also included, allowing a fair comparison. Within the LLoCa framework, one can also use PELICAN-lite as the Frames-Net.

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

Citation

If you find this code useful in your research, please cite these 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{Bogatskiy:2023nnw,
   author = "Bogatskiy, Alexander and Hoffman, Timothy and Miller, David W. and Offermann, Jan T. and Liu, Xiaoyang",
   title = "{Explainable equivariant neural networks for particle physics: PELICAN}",
   eprint = "2307.16506",
   archivePrefix = "arXiv",
   primaryClass = "hep-ph",
   doi = "10.1007/JHEP03(2024)113",
   journal = "JHEP",
   volume = "03",
   pages = "113",
   year = "2024"
}
@article{Bogatskiy:2022czk,
   author = "Bogatskiy, Alexander and Hoffman, Timothy and Miller, David W. and Offermann, Jan T.",
   title = "{PELICAN: Permutation Equivariant and Lorentz Invariant or Covariant Aggregator Network for Particle Physics}",
   eprint = "2211.00454",
   archivePrefix = "arXiv",
   primaryClass = "hep-ph",
   month = "11",
   year = "2022"
}

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

pelican_lite-1.1.0.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

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

pelican_lite-1.1.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pelican_lite-1.1.0.tar.gz
Algorithm Hash digest
SHA256 1c00f59a61fd2a5977cd75194e8e6bbd886d4d1a6c156f11fbcee3c318cc6ef9
MD5 3495674196450d3ebc776c2dc1d72764
BLAKE2b-256 9f80b3af7e075b31a141affbc70399f07898ed3b117588d5f02ac597b9e6fbe1

See more details on using hashes here.

Provenance

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

Publisher: release.yaml on heidelberg-hepml/pelican-lite

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

File details

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

File metadata

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

File hashes

Hashes for pelican_lite-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4cee153ee9ab1594c6f7e009fd0c696eb0e237c788bb66486bdfeb3455f8d1b2
MD5 05754fa7dbcca35d9caece4c8e1c3d9d
BLAKE2b-256 2ef6966cda91c355c1e35a88fcbefd83dfc67eca6c4e3a3a68a5146769a1cee6

See more details on using hashes here.

Provenance

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

Publisher: release.yaml on heidelberg-hepml/pelican-lite

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