Skip to main content

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

Reason this release was yanked:

Project renamed to pelican-lite

Project description

Efficient PELICAN

Tests codecov PyPI version pytorch black

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, we find 8x reduced memory usage for batch size 100, and 2x training speedup for batch size 1 compared to the original implementation. PELICAN can be used as the Frames-Net in Lorentz Local Canonicalization (LLoCa).

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

Installation

You can either install the latest release using pip

pip install pelican-hep

or clone the repository and install the package in dev mode

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

How to use PELICAN

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

Examples

  • https://github.com/heidelberg-hepml/lorentz-frames: PELICAN 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 as the Frames-Net.

Let us know if you use pelican, 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_hep-1.0.1.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

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

pelican_hep-1.0.1-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file pelican_hep-1.0.1.tar.gz.

File metadata

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

File hashes

Hashes for pelican_hep-1.0.1.tar.gz
Algorithm Hash digest
SHA256 8e679b2b0cbcdf16cfea9221e479369925689498cd9c363cfda495ebaf678343
MD5 3a5a973eba1980bcfcc13ba274a49569
BLAKE2b-256 cb4c9fe4ed2dd2655c5b909376bd3bef9ef2a99ab87d404538e227ca1a7637fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for pelican_hep-1.0.1.tar.gz:

Publisher: release.yaml on heidelberg-hepml/pelican

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_hep-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pelican_hep-1.0.1-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_hep-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 705a1a6a976af38cf280f4decf0b1f20b1c5a3be45aa18d4aa1908467c435dcf
MD5 a6b34757eb5c182d0b9917133f25ac0a
BLAKE2b-256 6fab26c1da9755d12abba0ef73c1042b59d801da0b33851e5c51a956719d3f3b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pelican_hep-1.0.1-py3-none-any.whl:

Publisher: release.yaml on heidelberg-hepml/pelican

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