Skip to main content

LUMIN Unifies Many Improvements for Networks: A PyTorch wrapper to make deep learning more accessable to scientists

Project description

pypi lumin version lumin python compatibility lumin license Documentation Status DOI

LUMIN: Lumin Unifies Many Improvements for Networks

LUMIN is a deep-learning and data-analysis ecosystem for High-Energy Physics. Similar to Keras and fastai it is a wrapper framework for a graph computation library (PyTorch), but includes many useful functions to handle domain-specific requirements and problems. It also intends to provide easy access to state-of-the-art methods, but still be flexible enough for users to inherit from base classes and override methods to meet their own demands.

Online documentation may be found at

For an introduction and motivation for LUMIN, checkout this talk from IML-2019 at CERN: video, slides.

Distinguishing Characteristics

Data objects

  • Use with large datasets: HEP data can become quite large, making training difficult:
    • The FoldYielder class provides on-demand access to data stored in HDF5 format, only loading into memory what is required.
    • Conversion from ROOT and CSV to HDF5 is easy to achieve using (see examples)
    • FoldYielder provides conversion methods to Pandas DataFrame for use with other internal methods and external packages
  • Non-network-specific methods expect Pandas DataFrame allowing their use without having to convert to FoldYielder.

Deep learning

  • PyTorch > 1.0
  • Inclusion of recent deep learning techniques and practices, including:
  • Flexible architecture construction:
  • Configurable initialisations, including LSUV Mishkin, Matas, 2016
  • HEP-specific losses, e.g. Asimov loss Elwood & Krücker, 2018
  • Exotic training schemes, e.g. Learning to Pivot with Adversarial Networks Louppe, Kagan, & Cranmer, 2016
  • Easy training and inference of ensembles of models:
    • Default training method fold_train_ensemble, trains a specified number of models as well as just a single model
    • Ensemble class handles the (metric-weighted) construction of an ensemble, its inference, saving and loading, and interpretation
  • Easy exporting of models to other libraries via Onnx
  • Use with CPU and NVidia GPU
  • Evaluation on domain-specific metrics such as Approximate Median Significance via EvalMetric class
  • fastai-style callbacks and stateful model-fitting, allowing training, models, losses, and data to be accessible and adjustable at any point

Feature selection methods

  • Dendrograms of feature-pair monotonicity
  • Feature importance via auto-optimised SK-Learn random forests
  • Mutual dependence (via RFPImp)
  • Automatic filtering and selection of features


  • Feature importance for models and ensembles
  • Embedding visualisation
  • 1D & 2D partial dependency plots (via PDPbox)


  • Variety of domain-specific plotting functions
  • Unified appearance via PlotSettings class - class accepted by every plot function providing control of plot appearance, titles, colour schemes, et cetera

Universal handling of sample weights

  • HEP events are normally accompanied by weight characterising the acceptance and production cross-section of that particular event, or to flatten some distribution.
  • Relevant methods and classes can take account of these weights.
  • This includes training, interpretation, and plotting
  • Expansion of PyTorch losses to better handle weights

Parameter optimisation

  • Optimal learning rate via cross-validated range tests Smith, 2015
  • Quick, rough optimisation of random forest hyper parameters
  • Generalisable Cut & Count thresholds
  • 1D discriminant binning with respect to bin-fill uncertainty

Statistics and uncertainties

  • Integral to experimental science
  • Quantitative results are accompanied by uncertainties
  • Use of bootstrapping to improve precision of statistics estimated from small samples

Look and feel

  • LUMIN aims to feel fast to use - liberal use of progress bars mean you're able to always know when tasks will finish, and get live updates of training
  • Guaranteed to spark joy (in its current beta state, LUMIN may instead ignite rage, despair, and frustration - dev.)


Several examples are present in the form of Jupyter Notebooks in the examples folder. These can be run also on Google Colab to allow you to quickly try out the package.

  1. Open In Colab examples/Simple_Binary_Classification_of_earnings.ipynb: Very basic binary-classification example
  2. Open In Colab examples/Binary_Classification_Signal_versus_Background.ipynb: Binary-classification example in a high-energy physics context
  3. Open In Colab examples/Multiclass_Classification_Signal_versus_Backgrounds.ipynb: Multiclass-classification example in a high-energy physics context
  4. Open In Colab examples/Single_Target_Regression_Di-Higgs_mass_prediction.ipynb: Single-target regression example in a high-energy physics context
  5. Open In Colab examples/Multi_Target_Regression_Di-tau_momenta.ipynb: Multi-target regression example in a high-energy physics context
  6. Open In Colab examples/Feature_Selection.ipynb: In-depth walkthrough for automated feature-selection
  7. Open In Colab examples/Advanced_Model_Building.ipynb: In-depth look at building more complicated models and a few advanced interpretation techniques
  8. Open In Colab examples/Model_Exporting.ipynb: Walkthough for exporting a trained model to ONNX and TensorFlow
  9. Open In Colab examples/RNNs_CNNs_and_GNNs_for_matrix_data.ipynb: Various examples of applying RNNs, CNNs, and GNNs to matrix data (top-tagging on jet constituents)
  10. Open In Colab examples/Learning_To_Pivot.ipynb: Example of adversarial training for parameter invariance


Due to some strict version requirements on packages, it is recommended to install LUMIN in its own Python environment, e.g conda create -n lumin python=3.6

From PyPI

The main package can be installed via: pip install lumin

Full functionality requires two additional packages as described below.

From source

git clone
cd lumin
pip install .

Optionally, run pip install with -e flag for development installation. Full functionality requires an additional package as described below.

Additional modules

Full use of LUMIN requires the latest version of PDPbox, but this is not released yet on PyPI, so you'll need to install it from source, too:

  • git clone && cd PDPbox && pip install -e . note the -e flag to make sure the version number gets set properly.


Why use LUMIN

TMVA contained in CERN's ROOT system, has been the default choice for BDT training for analysis and reconstruction algorithms due to never having to leave ROOT format. With the gradual move to DNN approaches, more scientists are looking to move their data out of ROOT to use the wider selection of tools which are available. Keras appears to be the first stop due to its ease of use, however implementing recent methods in Keras can be difficult, and sometimes requires dropping back to the tensor library that it aims to abstract. Indeed, the prequel to LUMIN was a similar wrapper for Keras (HEPML_Tools) which involved some pretty ugly hacks. The fastai framework provides access to these recent methods, however doesn't yet support sample weights to the extent that HEP requires. LUMIN aims to provide the best of both, Keras-style sample weighting and fastai training methods, while focussing on columnar data and providing domain-specific metrics, plotting, and statistical treatment of results and uncertainties.

Data types

LUMIN is primarily designed for use on columnar data, and from version 0.5 onwards this also includes matrix data; ordered series and un-ordered groups of objects. With some extra work it can be used on other data formats, but at the moment it has nothing special to offer. Whilst recent work in HEP has made use of jet images and GANs, these normally hijack existing ideas and models. Perhaps once we get established, domain specific approaches which necessitate the use of a specialised framework, then LUMIN could grow to meet those demands, but for now I'd recommend checking out the fastai library, especially for image data.

With just one main developer, I'm simply focussing on the data types and applications I need for my own research and common use cases in HEP. If, however you would like to use LUMIN's other methods for your own work on other data formats, then you are most welcome to contribute and help to grow LUMIN to better meet the needs of the scientific community.


The current priority is to improve the documentation, add unit tests, and expand the examples.

The next step will be to try to increase the user base and number of contributors. I'm aiming to achieve this through presentations, tutorials, blog posts, and papers.

Further improvements will be in the direction of implementing new methods and (HEP-specific) architectures, as well as providing helper functions and data exporters to statistical analysis packages like Combine and PYHF.

Contributing & feedback

Contributions, suggestions, and feedback are most welcome! The issue tracker on this repo is probably the best place to report bugs et cetera.

Code style

Nope, the majority of the code-base does not conform to PEP8. PEP8 has its uses, but my understanding is that it primarily written for developers and maintainers of software whose users never need to read the source code. As a maths-heavy research framework which users are expected to interact with, PEP8 isn't the best style. Instead, I'm aiming to follow more the style of fastai, which emphasises, in particular, reducing vertical space (useful for reading source code in a notebook) naming and abbreviating variables according to their importance and lifetime (easier to recognise which variables have a larger scope and permits easier writing of mathematical operations). A full list of the abbreviations used may be found in

Why is LUMIN called LUMIN?

Aside from being a recursive acronym (and therefore the best kind of acronym) lumin is short for 'luminosity'. In high-energy physics, the integrated luminosity of the data collected by an experiment is the main driver in the results that analyses obtain. With the paradigm shift towards multivariate analyses, however, improved methods can be seen as providing 'artificial luminosity'; e.g. the gain offered by some DNN could be measured in terms of the amount of extra data that would have to be collected to achieve the same result with a more traditional analysis. Luminosity can also be connected to the fact that LUMIN is built around the python version of Torch.

Who develops LUMIN

LUMIN is primarily developed by Giles Strong; a British-born doctor in particle physics, researcher at The University of Padova (Italy), and a member of the CMS collaboration at CERN.

As LUMIN has grown, it has welcomed contributions from members of the scientific and software development community. Check out the contributors page for a complete list.

Certainly more developers and contributors are welcome to join and help out!


If you have used LUMIN in your analysis work and wish to cite it, the preferred reference is: Giles C. Strong, LUMIN, Zenodo (Mar. 2019),, Note: Please check for the full list of contributors

  author       = {Giles Chatham Strong},  
  title        = {LUMIN},  
  month        = mar,  
  year         = 2019,  
  note         = {{Please check for the full list of contributors}},  
  doi          = {10.5281/zenodo.2601857},  
  url          = {}  

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lumin-0.8.0.tar.gz (156.3 kB view hashes)

Uploaded source

Built Distribution

lumin-0.8.0-py3-none-any.whl (172.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page