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.3.tar.gz (22.8 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.3-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pelican_lite-1.1.3.tar.gz
  • Upload date:
  • Size: 22.8 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.3.tar.gz
Algorithm Hash digest
SHA256 ebd5f543b5b10a6388fc07396d7e4fdd26fd52f90edbe5831f63febbf4e1e5ff
MD5 002dcdb720e09be45fe15f5b9697a173
BLAKE2b-256 549d507a9c59413b503e223c6399f53cf46935da13eed0d5990f7bb8ab16d8b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pelican_lite-1.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: pelican_lite-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.5 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1cbee897d4ffc3d2d8625450772e2f1425725c21e83bc743d640f2efd73d3f18
MD5 92913bf433113d57538309e9ea3b55ab
BLAKE2b-256 41b830b3bf58fc1240d0436227a2c74b8e8440a8e7fc0711ff79f9f9160a8ce5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pelican_lite-1.1.3-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