Skip to main content

A modern machine learning library for high-energy physics data analysis

Project description

ColliderML

Tests Coverage Python 3.10+ License: MIT

A modern machine learning library for high-energy physics data analysis.

Installation

pip install colliderml

For development: pip install -e ".[dev]"

Getting the data

Option 1 — CLI (download to local cache, then load with the library):

colliderml download --channels ttbar --pileup pu0 --objects particles,tracker_hits,calo_hits,tracks --max-events 200

Cache location: default ~/.cache/colliderml, or set COLLIDERML_DATA_DIR. List downloaded configs: colliderml list-configs.

Option 2 — HuggingFace only:

from datasets import load_dataset
dataset = load_dataset("CERN/ColliderML-Release-1", "ttbar_pu0_particles", split="train")

Using the library

The notebook notebooks/colliderml_loader_exploration.ipynb shows how to use the convenience functions: loading local Parquet with load_tables, exploding event tables, pileup subsampling, calibration, and plotting.

Full docs: https://opendatadetector.github.io/ColliderML

Development

pytest -v -m "not integration"

Docs are built with VitePress: npm ci --prefix docs && npm run --prefix docs docs:build.

License

MIT License

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

colliderml-0.3.1.tar.gz (505.2 kB view details)

Uploaded Source

Built Distribution

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

colliderml-0.3.1-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file colliderml-0.3.1.tar.gz.

File metadata

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

File hashes

Hashes for colliderml-0.3.1.tar.gz
Algorithm Hash digest
SHA256 651d836590fba8a881e45f83c84f0a0bf4d13dcc2ed6695606e3fdc8435a7208
MD5 cb19db53c853c2501263c100ff9b2d54
BLAKE2b-256 b2605212cf1a4dc97178f60328cd19ab2754160467995425858e4c12f052a0cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for colliderml-0.3.1.tar.gz:

Publisher: publish-pypi.yml on OpenDataDetector/ColliderML

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

File details

Details for the file colliderml-0.3.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for colliderml-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cac36080dddee5cdec09f246c7c258b5ec902ce1bb47fc65f30800c9102d26f0
MD5 8d5e09e872d0d6908c2b3196b1f81b7c
BLAKE2b-256 f225af4641f28644299d035e372a7623167464ae138f3c8c163c2ca137ee5be0

See more details on using hashes here.

Provenance

The following attestation bundles were made for colliderml-0.3.1-py3-none-any.whl:

Publisher: publish-pypi.yml on OpenDataDetector/ColliderML

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