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:
import raredecay as rd
mc_data = rd.data.HEPDataStorage(df, weights=*pd.Series weights*, target=0)
real_data = rd.data.HEPDataStorage(df, weights=*pd.Series weights*, target=1)
score = rd.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
Anaconda
Easiest way: use conda to install everything (except of the rep, which has to be upgraded with pip for some functionalities)
conda install raredecay -c mayou36
PyPI
The package with all extras requires root_numpy as well as rootpy (and therefore a ROOT installation with python-bindings) to be installed on your system. If that is not the case, some functions won’t work.
If you want to install all the extra, first install the very newest version of REP (may also needed with conda install) (the -U can be omitted, but is recommended to have the newest dependencies):
pip install -U https://github.com/yandex/rep/archive/stratifiedkfold.zip
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*
or, instead of root/additionally (comma separated) reweight or reweight for the specific functionalities.
In order to have all functionalities, use
pip install raredecay[all]
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.2.tar.gz.
File metadata
- Download URL: raredecay-2.0.2.tar.gz
- Upload date:
- Size: 93.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 51674a4b092b00d49ff930dc31f58c5cb11e845af384b6aa999ab56c1c886a82 |
|
| MD5 | 937fe2f4a93de94605d17a4144e42c01 |
|
| BLAKE2b-256 | d8f04d819d40dc0c200290f555d85f91ad612730a8f7ce9d9b1de913b97f9a0f |
File details
Details for the file raredecay-2.0.2-py3-none-any.whl.
File metadata
- Download URL: raredecay-2.0.2-py3-none-any.whl
- Upload date:
- Size: 112.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 969047c4bc8543eb2203aa8dd2b1a9b117a4237825c92556a776a436134ed4a7 |
|
| MD5 | 7a4a5aff8ec2c1ccc5e926fe7828e5c6 |
|
| BLAKE2b-256 | 9b81de44f8dbe9911c50c1c8465da9fc9a0cb3c1a4af6e716762d35d0df300d9 |
