stefanopolitano / hipe4ml

Minimal heavy ion physics environment for Machine Learning

Minimal heavy ion physics environment for Machine Learning

To install:

pip install hipe4ml

Mac OS X users: the latest XGBoost version will require OpenMP installed. One easy way of getting it is using brew:

brew install libomp

Documentation

https://hipe4ml.github.io/

Cite

If you use this package for your analysis please consider citing it! You can use the following reference.

https://doi.org/10.5281/zenodo.5070131

Contribute

Install in-development package

To install the in-development package, from the repository base directory:

pip install -e .[dev]

Run tests

If you have Pylint and Flake8 on your development machine, you can run tests locally by using:

tests/run_tests.sh

in the repository base directory.

Tutorials

If you want to get familiar with hipe4ml, the following tutorials are available:

Type	Link
Binary classifier
Multiclass classifier