Skip to content

Latest commit

 

History

History
174 lines (137 loc) · 14.4 KB

CHANGELOG.md

File metadata and controls

174 lines (137 loc) · 14.4 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

2.4.1

Highlights

2.4.1 is a small patch release of the EMAworkbench, primarily resolving issues #276 and #277 in the workbench itself, and a bug introduced by #241 in the docs. The EMAworkbench now also raise exception when sampling scenarios or policies while no uncertainties or levers are defined (#282).

What's Changed

🛠 Enhancements made

  • Enhancement for #271: raise exception by @quaquel in quaquel#282

🐛 Bugs fixed

  • bugfix to rebuild_platypus_population by @quaquel in quaquel#276
  • Fixed dtype handling in load_results function. The dtype metadata is now correctly applied, resolving issue #277.
  • Fixed the documentation bug introduced by #241 in the general introduction section, which now accurately reflects the handling of categorical uncertainties in the experiment dataframe.

📜 Documentation improvements

  • readthedocs: Add search ranking and use latest Python version by @EwoutH in quaquel#242
  • docs/examples: Always use n_processes=-1 in MultiprocessingEvaluator by @EwoutH in quaquel#278

2.4.0

Highlights

The latest release of the EMAworkbench introduces significant performance improvements and quality of life updates. The performance of _store_outcomes has been enhanced by approximately 35x in pull request #232, while the combine function has seen a 8x speedup in pull request #233. This results in the overhead of the EMAworkbench being reduced by over 70%. In a benchmark, a very simple Python model now performs approximately 40.000 iterations per second, compared to 15.000 in 2.3.0.

In addition to these performance upgrades, the examples have been added to the ReadTheDocs documentation, more documentation improvements have been made and many bugs and deprecations have been fixed.

The 2.4.x release series requires Python 3.8 and is tested on 3.8 to 3.11. It's the last release series supporting Python 3.8. It can be installed as usual via PyPI, with:

pip install --upgrade ema-workbench

What's Changed

🎉 New features added

  • optional preallocation in callback based on outcome shape and type by @quaquel in quaquel#229

🛠 Enhancements made

  • util: Speed up combine by ~8x by @EwoutH in quaquel#233
  • callbacks: Improve performance of _store_outcomes by ~35x by @EwoutH in quaquel#232

🐛 Bugs fixed

  • fixes broken link to installation instructions by @quaquel in quaquel#224
  • Docs: Fix developer installation commands by removing a space by @EwoutH in quaquel#220
  • fixes a bug where Prim modifies the experiments array by @quaquel in quaquel#228
  • bugfix for warning on number of processes and max_processes by @quaquel in quaquel#234
  • Fix deprecation warning and dtype issue in flu_example.py by @quaquel in quaquel#235
  • test for get_results and categorical fix by @quaquel in quaquel#241
  • Fix pynetlogo imports by decapitalizing pyNetLogo by @quaquel in quaquel#248
  • change default value of um_p to be consistent with Borg documentation by @irene-sophia in quaquel#250
  • Fix pretty print for RealParameter and IntegerParameter by @quaquel in quaquel#255
  • Fix bug in AutoadaptiveOutputSpaceExploration with wrong default probabilities by @quaquel in quaquel#252

📜 Documentation improvements

🔧 Maintenance

  • clusterer: Update AgglomerativeClustering keyword to fix deprecation by @EwoutH in quaquel#218
  • Fix Matplotlib and SciPy deprecations by @EwoutH in quaquel#227
  • CI: Add job that runs tests with pre-release dependencies by @EwoutH in quaquel#217
  • Fix for stalling tests by @quaquel in quaquel#247

Other changes

  • add metric argument to allow for other linkages by @mikhailsirenko in quaquel#222

New Contributors

  • @mikhailsirenko made their first contribution in quaquel#222
  • @irene-sophia made their first contribution in quaquel#250

Full Changelog: https://github.com/quaquel/EMAworkbench/compare/2.3.0...2.4.0

2.3.0

Highlights

This release adds a new algorithm for output space exploration. The way in which convergence tracking for optimization is supported has been overhauled completely, see the updated directed search user guide for full details. The documentation has moreover been expanded with a comparison to Rhodium.

With this new release, the installation process has been improved by reducing the number of required dependencies. Recommended packages and connectors can now be installed as extras using pip, for example pip install -U ema-workbench[recommended,netlogo]. See the updated installation instructions for all options and details.

The 2.3.x release series supports Python 3.8 to 3.11. It can be installed as usual via PyPI, with:

pip install --upgrade ema-workbench

What's Changed

🎉 New features added

🛠 Enhancements made

  • Switch to using format string in prim logging by @quaquel in quaquel#161
  • Replace setup.py with pyproject.toml and implement optional dependencies by @EwoutH in quaquel#166

🐛 Bugs fixed

  • use masked arrays for storing outcomes by @quaquel in quaquel#176
  • Fix error for negative n_processes input in MultiprocessingEvaluator by @EwoutH in quaquel#189
  • optimization.py: Fix "epsilons" keyword argument in _optimize() by @EwoutH in quaquel#150

📜 Documentation improvements

  • Create initial CONTRIBUTING.md documentation by @EwoutH in quaquel#162
  • Create Read the Docs yaml configuration by @EwoutH in quaquel#173
  • update to outcomes documentation by @quaquel in quaquel#183
  • Improved directed search tutorial by @quaquel in quaquel#194
  • Update Contributing.md with instructions how to merge PRs by @EwoutH in quaquel#200
  • Update Readme with an introduction and documentation, installation and contribution sections by @EwoutH in quaquel#199
  • Rhodium docs by @quaquel in quaquel#184
  • Fix spelling mistakes by @EwoutH in quaquel#195

🔧 Maintenance

  • Replace depreciated shade keyword in Seaborn kdeplot with fill by @EwoutH in quaquel#169
  • CI: Add pip depencency caching, don't run on doc changes, update setup-python to v4 by @EwoutH in quaquel#174
  • Formatting: Format with Black, increase max line length to 100, combine multi-line blocks by @EwoutH in quaquel#178
  • Add pre-commit configuration and auto update CI by @EwoutH in quaquel#181
  • Fix Matplotlib, ipyparallel and dict deprecation warnings by @EwoutH in quaquel#202
  • CI: Start testing on Python 3.11 by @EwoutH in quaquel#156
  • Replace deprecated saltelli with sobol SALib 1.4.6+. by @quaquel in quaquel#211

Other changes

Full Changelog: https://github.com/quaquel/EMAworkbench/compare/2.2.0...2.3

2.2.0

Highlights

With the 2.2 release, the EMAworkbench can now connect to Vadere models on pedestrian dynamics. When inspecting a Prim Box peeling trajectory, multiple points on the peeling trajectory can be inspected simultaneously by inputting a list of integers into PrimBox.inspect().

When running experiments with multiprocessing using the MultiprocessingEvaluator, the number of processes can now be controlled using a negative integer as input for n_processes (for example, -2 on a 12-thread CPU results in 10 threads used). Also, it will now default to max. 61 processes on windows machines due to limitations inherent in Windows in dealing with higher processor counts. Code quality, CI, and error reporting also have been improved. And finally, generating these release notes is now automated.

What's Changed

🎉 New features added

  • Vadere model connector by @floristevito in quaquel#145

🛠 Enhancements made

🐛 Bugs fixed

  • fixed typo in lake_model.py by @JeffreyDillonLyons in quaquel#136

📜 Documentation improvements

🔧 Maintenance

New Contributors

  • @JeffreyDillonLyons made their first contribution in quaquel#136
  • @rhysits made their first contribution in quaquel#144
  • @floristevito made their first contribution in quaquel#145

Full Changelog: https://github.com/quaquel/EMAworkbench/compare/2.1.2...2.2.0