Notes regarding the released versions of EnergyFlow will be published here.

0.13.x

0.13.2

  • Keras 2.2.5 fixes a bug in their batch_dot function that is used by their Dot layer which is used by the EFN and PFN classes. This necessitates adjusting our code to account for the new behavior.

0.13.1

  • When loading MOD HDF5 files, jets are now made from copies of the particle arrays rather than from views, enabling the large arrays to be freed and only the selected jets to remain in memory (which can have substantial memory savings).

0.13.0

  • Added support for downloading and reading MOD datasets containing CMS Open Data and Simulation from Zenodo.
  • EMD module now has support for spherical measure.
  • Added particle utility functions to map PDG IDs to electric charges.
  • Added sum_ptyphims and sum_ptyphipids functions to sum four-vectors given in hadronic coordinates.
  • Added scheme choices for summing four-vectors of particles.
  • Added preprocessing functions to particle utilities, including center_ptyphims, rotate_ptyphims and reflect_ptyphims.
  • A ~ is now expanded to the user's home directory properly in the filepath option to architectures.
  • Added h5py install dependency for MOD Datasets.
  • Improved binder environment with fastjet, latex, and default matplotlib settings.
  • Added observables submodule which currently includes image_activity and zg.
  • EMD module now imported when importing toplevel energyflow.

0.12.x

0.12.3

  • Set allow_pickle to True explicitly in Generator (recently changed default in NumPy).
  • Added Herwig7.1 dataset to qg_jets. A big thanks to Aditya Pathak for generating these Herwig samples!
  • Quark and gluon dataset files can now be obtained from Zenodo in addition to Dropbox.
  • Changed internals of EFN to use standalone functions for easier use of subnetwork components.
  • Added some particle utility functions to deal with PDG IDs.
  • Added particle utilities to deal with pseudorapidities.
  • Changed gen_random_events_mcom to have positive energies (momenta still sum to zero).
  • Added l2 regularization to layers in EFN and PFN architectures. Thanks to Anders Andreassen for submiting this pull request!
  • Added tests for particle utils.
  • Particle utilities now accept arrays of events.

0.12.2

  • Added another periodic phi test for event EMD.
  • Changed gdim default to None (to reduce potentially unexpected behavior).
  • Increased numerical stability of EMD computation by including an internal change of units.
  • Added verbosity functionality to EFP Generator.

0.12.1

  • Named lambda functions inside EFNs and PFNs (necessary for saving models).
  • Fixed typo in archbase code.
  • Added tests for architecture code.

0.12.0

  • Fixed potential issue involving the Keras Masking layer not functioning as documented. This is not expected to affect any EFN models that were padded with zeros, nor any PFN models for which the padding was consistent across training and testing sets. Thanks to Anders Andreassen for pointing this out!
  • Added arbitrary attribute lookup in the underlying model for all EnergyFlow architectures.
  • Deprecated old EFN/PFN parameter names.
  • Built-in support for ModelCheckpoint and EarlyStopping callbacks for neural network models.
  • Made naming of neural network layers optional, allowing pieces to be reused more easily.
  • Support for periodic phi values in EMD module.
  • Added support for passing arbitrary compilation options to Keras models.
  • Added EMD Demo notebook

0.11.x

0.11.2

  • Added advanced activations support for neural network architectures. Thanks to Kevin Bauer for this suggestion!

0.11.1

  • Fixed issue when using Python 2 caused by not importing division in dataset loading code. Thanks to Matt LeBlanc for pointing this out!
  • Added n_iter_max option to EMD functions.

0.11.0

  • Added emd module to EnergyFlow. This new module is not imported by default and relies on the Python Optimal Transport library and SciPy.
  • Included binder support for the jupyter notebook demos. Thanks to Matthew Feickert for contributing this feature!

0.10.x

0.10.5

  • Minor improvement and fixes. Thanks to Preksha Naik for pointing out a typo!

0.10.4

  • Updates to the documentation and enhanced examples provided.

0.10.3

  • Finalized initial documentation pages.
  • Minor improvement and fixes.

0.10.2

  • Minor improvement and fixes.

0.10.1

  • Minor improvement and fixes.

0.10.0

  • Added archs module containing EFN, PFN, DNN, CNN, and Linear models.

<0.9.x

  • Rapid development of EFP code.