A package for analysis of rare particle decays with machine-learning algorithms
Project description
raredecay
This package consists of several tools for the event selection of particle decays, mostly built on machine learning techniques. It contains:
a data-container holding data, weights, labels and more and implemented root-to-python data conversion as well as plots and KFold-data splitting
reweighting tools from the hep_ml-repository wrapped in a KFolding structure and with metrics to evaluate the reweighting quality
classifier optimization tools for hyper-parameters as well as feature selection involving a backward-elimination
an output handler which makes it easy to add text as well as figures into your code and automatically save them to a file
… and more
HowTo examples
To get an idea of the package, have a look at the howto notebooks: HTML version or the IPython Notebooks
Minimal example
Want to test whether your reweighting did overfit? Use train_similar:
from raredecay.data import HEPDataStorage
from raredecay.score import train_similar
mc_data = HEPDataStorage(df, weights=*pd.Series weights*, target=0)
real_data = HEPDataStorage(df, weights=*pd.Series weights*, target=1)
score = train_similar(mc_data, real_data, old_mc_weights=1 *or whatever weights the mc had before*)Getting started right now
If you want it the easy, fast way, have a look at the Ready-to-use scripts. All you need to do is to have a look at every “TODO” task and probably change them. Then you can run the script without the need of coding at all.
Documentation and API
The API as well as the documentation: Documentation
Setup and installation
Depending on which functionality you want to use, you may consider different installations.
Everything (reweighting incl. scoring, machine learning, ROOT bindings)
Follow the instructions for each dependency separately and then install raredecay via
pip install raredecay[all]
Machine learning, advanced scores
First install the following version of REP (the -U can be omitted, but is recommended to have the newest dependencies, on the other hand may crashes REPs reproducibility):
pip install -U https://github.com/yandex/rep/archive/stratifiedkfold.zip
Then install the package via
pip install -U raredecay[ml]
Reweighting (without scoring)
To install the newest version of hep_ml containing the loss-regularization (recommended, but optional).
pip install -U git+https://github.com/arogozhnikov/hep_ml.git
Then, install the raredecay package (without ROOT-support) via
pip install raredecay
To make sure you can convert ROOT-NTuples, use
pip install raredecay[root] # *use raredecay\[root\] in a zsh-console*
As it is a young package still under developement, it may receive regular updates and improvements and it is probably a good idea to regularly download the newest package.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file raredecay-2.0.0.tar.gz.
File metadata
- Download URL: raredecay-2.0.0.tar.gz
- Upload date:
- Size: 93.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c8351fb60be12f80ace7bfcb8ab273bc00258d90f3b32f6427d72f8111f1a1d2 |
|
| MD5 | 46a3395ae18787052a7c5052c956414c |
|
| BLAKE2b-256 | 7729081c244f564ab95d1a45c59f746b6ed498c6c8d16540680541bc93ec0ecd |
File details
Details for the file raredecay-2.0.0-py3-none-any.whl.
File metadata
- Download URL: raredecay-2.0.0-py3-none-any.whl
- Upload date:
- Size: 111.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 89bc04826897e31269a49cdc6249b30b75dd17dfd64d7a575c5896c7bc609847 |
|
| MD5 | d0afdd5de3e73c9fe638c1bb3a56c52c |
|
| BLAKE2b-256 | 606fab257fd10380e2f1c5a12b5ccb9e6f4b4c2fc8c2be13c04c9a06f1c0b143 |
