mlpf-itwinai-plugin

itwinai plugin for Machine-learned Particle Flow

https://github.com/matbun/mlpf-itwinai-plugin

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary

Last synced: 7 months ago · JSON representation ·

Repository

itwinai plugin for Machine-learned Particle Flow

Basic Info

Host: GitHub
Owner: matbun
License: apache-2.0
Language: Python
Default Branch: main
Size: 548 KB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 1

Created about 1 year ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Codeowners Authors

MLPF plugin for itwinai

Acknowledgements

MLPF focuses on developing full event reconstruction based on computationally scalable and flexible end-to-end ML models.

This project incorporates code from particleflow by Joosep Pata, Eric Wulff, Farouk Mokhtar, Javier Duarte, Aadi Tepper, Ka Wa Ho, and Lars Sørlie, which is licensed under the Apache License 2.0. For more details, visit the CHANGELOG.

schematic

How to use this plugin

First of all, install the plugin.

[!NOTE] If you run on an HPC system remember to load the correct modules before.

bash pip install "mlpf-itwinai-plugin @ git+https://github.com/matbun/mlpf-itwinai-plugin"

Now you can import the MLPF trainer in your code using

```python from itwinai.plugins.mlpf.trainer import MLPFTrainer

my_trainer = MLPFTrainer(...) ```

Alternatively, you can launch training using the configuration file in this repository:

bash python -u pipeline.py \ --train \ --ray-train \ --config parameters/pyg-clic-itwinai.yaml \ --data-dir /ceph/hpc/data/d2024d11-083-users/data/tensorflow_datasets/clic \ --ntrain 50 \ --nvalid 50 \ --prefix foo_prefix \ --ray-cpus 8 \ --gpus 1 \ --gpu-batch-multiplier 8 \ --num-workers 8 \ --prefetch-factor 8 \ --experiments-dir $PWD/experiments \ --slurm-nnodes 1 \ --num-epochs 2

You will find more examples under scripts/jsc/interactive.sh and scripts/vega/interactive.sh

Docker containers

This repository provides two examples of Dockerfiles, one for JupyterLab images and the other for simple Docker containers. Both Dockerfiles are based on the itwinai container image, which already provides most of the dependencies.

Owner

Name: Matteo Bunino
Login: matbun
Kind: user

Website: matbun.github.io
Repositories: 1
Profile: https://github.com/matbun

Fellow @ CERN Openlab. Former data Science student @ {EURECOM, Polytechnic University of Turin}

Citation (CITATION.cff)

cff-version: 1.2.0
title: mlpf-itwinai-plugin
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  # Original authors
  - family-names: Pata
    given-names: Joosep
  - family-names: Wulff
    given-names: Eric
  - family-names: Mokhtar
    given-names: Farouk
  - family-names: Duarte
    given-names: Javier
  - family-names: Tepper
    given-names: Aadi
  - family-names: Ho
    given-names: Ka Wa
  - family-names: Sørlie
    given-names: Lars
    
  # New authors
  - given-names: Matteo
    family-names: Bunino
    email: matteo.bunino@cern.ch
    affiliation: CERN
    orcid: 'https://orcid.org/0009-0008-5100-9300'
repository-code: "https://github.com/matbun/mlpf-itwinai-plugin"
license: Apache-2.0
# version: 0.1.0 
# date-released: 2025-03-02  
references:
  - type: software
    authors:
      - family-names: Pata
        given-names: Joosep
      - family-names: Wulff
        given-names: Eric
      - family-names: Mokhtar
        given-names: Farouk
      - family-names: Duarte
        given-names: Javier
      - family-names: Tepper
        given-names: Aadi
      - family-names: Ho
        given-names: Ka Wa
      - family-names: Sørlie
        given-names: Lars
    title: "particleflow"
    repository-code: "https://github.com/jpata/particleflow"
    license: Apache-2.0
  - type: software
    title: "itwinai"
    authors:
      - name: "Matteo Bunino"
    url: "https://github.com/interTwin-eu/itwinai"
    license: "Apache-2.0"

GitHub Events

Total

Release event: 1
Delete event: 1
Push event: 9
Pull request event: 2
Create event: 5

Last Year

Release event: 1
Delete event: 1
Push event: 9
Pull request event: 2
Create event: 5

Dependencies

.github/workflows/check-links.yml actions

actions/checkout v4 composite
gaurav-nelson/github-action-markdown-link-check v1 composite

.github/workflows/lint.yml actions

actions/checkout v4 composite
github/super-linter/slim v7 composite

.github/workflows/pytest.yaml actions

actions/checkout v4 composite

.github/workflows/sqaaas.yaml actions

eosc-synergy/sqaaas-assessment-action v2 composite
eosc-synergy/sqaaas-step-action v1 composite

Dockerfile docker

ghcr.io/intertwin-eu/itwinai torch-slim-latest build

pyproject.toml pypi

itwinai [torch]
pytest >=8.3.4

uv.lock pypi

158 dependencies

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science