Metadata-Version: 2.1
Name: hipe4ml
Version: 0.0.6
Summary: Minimal heavy ion physics environment for Machine Learning
Home-page: https://github.com/hipe4ml/hipe4ml
Author: hipe4ml-developers
Author-email: hipe4ml@googlegroups.com
License: GPL
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: uproot (>=3.11.1)
Requires-Dist: matplotlib (>=3.1.2)
Requires-Dist: pandas (>=0.25.3)
Requires-Dist: scikit-learn (>=0.22.1)
Requires-Dist: xgboost (<1.0,>=0.90)
Requires-Dist: shap (>=0.34)
Requires-Dist: bayesian-optimization (>=1.0.1)
Provides-Extra: dev
Requires-Dist: pylint (>=2.4.4) ; extra == 'dev'
Requires-Dist: flake8 (>=3.7.9) ; extra == 'dev'
Requires-Dist: pytest (>=5.3.4) ; extra == 'dev'
Requires-Dist: twine (>=1.11.0) ; extra == 'dev'
Requires-Dist: setuptools (>=38.6.0) ; extra == 'dev'
Requires-Dist: wheel (>=0.31.0) ; extra == 'dev'

![hipe4ml](./logo.svg)



![](https://github.com/hipe4ml/hipe4ml/workflows/Test%20package/badge.svg)

![](https://sonarcloud.io/api/project_badges/measure?project=hipe4ml_hipe4ml&metric=alert_status) 

![](https://img.shields.io/github/license/hipe4ml/hipe4ml)



Minimal heavy ion physics environment for Machine Learning



To install:



```bash

pip install hipe4ml

```



# Documentation



https://hipe4ml.github.io/



# Contribute



## Install in-development package



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



```bash

pip install -e .[dev]

```



## Run tests



If you have [Pylint](https://www.pylint.org/#install) and [Flake8](http://flake8.pycqa.org/en/latest/) on your development machine, you can run tests locally by using:



```bash

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 |  [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/hipe4ml/hipe4ml/blob/master/tutorials/hipe4ml_tutorial_binary.ipynb) |


