Recent Releases of mlrl-boomer
mlrl-boomer - Version 0.14.0
A feature release that comes with the following changes.
This release comes with API changes. For an updated overview of the available parameters and command line arguments, please refer to the documentation.
API Changes
- In batch mode, the argument
--base-diris now passed to individual experiments by default. - The command line argument
--save-meta-datahas been added. It allows to control if meta-data should be written to output files. - A new package mlrl-testbed-slurm has been added to the project. It is an extension that adds support for the Slurm Workload Manager to the package "mlrl-testbed".
Fixes
- When using the argument
--runnerin batch mode, it is not passed down to the individual experiments anymore.
- C++
Published by boomer-merge-bot[bot] 6 months ago
mlrl-boomer - Version 0.13.1
A bugfix release that comes with the following changes.
Fixes
- Fixed the release of packages for the Windows platform.
- C++
Published by boomer-merge-bot[bot] 7 months ago
mlrl-boomer - Version 0.13.0
A feature release that comes with the following changes.
This release comes with API changes. For an updated overview of the available parameters and command line arguments, please refer to the documentation.
API Changes
- The package MLRL-Testbed does not provide a batch mode for running multiple experiments at once. It can be enabled via the argument
--mode batch. - The command line argument
--sequential-post-optimization truehas been replaced with--post-optimization sequential. - Command line arguments starting with
--store-have been renamed to use the prefix--save-. - The default value of the command line argument
--save-evaluation(previously--store-evaluation) has been changed fromtruetofalse. - The command line arguments
--output-dir,--create-output-dirand--wipe-output-dirhave been renamed to--result-dir,--create-dirsand--wipe-result-dir. - The command line arguments
--result-dir(previously--output-dir),--model-load-dir,--model-save-dir,--parameter-load-dirand--parameter-save-dirdo now come with default values. - The command line arguments
--save-modelsand--save-parametershave been added for specifying whether models or parameter settings should be written to output files. - The command line arguments
--load-modelsand--load-parametershave been added for specifying whether models or parameter settings should be loaded from input files. - The command line argument
--base-dirhas been added. Relative directories given for the arguments--result-dir,--model-load-dir,--model-save-dir,--parameter-load-dirand--parameter-save-dirare considered relative to this directory.
Quality-of-Life Improvements
- Continuous Integration jobs are now used to automatically assign labels and milestones to pull requests.
- C++
Published by boomer-merge-bot[bot] 7 months ago
mlrl-boomer - Version 0.12.3
Creating virtual Python environment... A bugfix release that comes with the following changes.
Fixes
- Fixed another issue that prevented the command line arguments
--print-alland--store-allfrom working properly.
- C++
Published by boomer-merge-bot[bot] 7 months ago
mlrl-boomer - Version 0.12.2
Creating virtual Python environment... A bugfix release that comes with the following changes.
Quality-of-Life Improvements
- The static type checker mypy is now applied to the project's Python code via Continuous Integration.
Fixes
- Fixed an issue that prevented the command line arguments
--print-alland--store-allfrom working properly.
- C++
Published by boomer-merge-bot[bot] 7 months ago
mlrl-boomer - Version 0.12.1
Version 0.12.1 (Jul. 6th, 2025)
A bugfix release that comes with the following changes.
Quality-of-Life Improvements
- For testing Python packages under more realistic conditions, they are now installed into isolated CI jobs, separated from the build jobs.
- pytest is now used for testing the Python code. This enables, among other things, to use parameterized tests.
- Python tests are now divided into blocks that are run in parallel by CI jobs
Fixes
- Fixed an issue that caused the options
first_foldandlast_foldto be swapped when using the command line argument--data-split cross-validation.
- C++
Published by michael-rapp 8 months ago
mlrl-boomer - Version 0.12.0
A feature release that comes with the following changes.
This release comes with API changes. For an updated overview of the available parameters and command line arguments, please refer to the documentation.
API Changes
- The executable
testbedhas been renamed tomlrl-testbed. - The command line argument
--model-dirhas been replaced with the arguments--model-load-dirand--model-save-dir, which enables to save models to a different directory than the one they are loaded from. - The command line argument
--parameter-dirhas been replaced with the arguments--parameter-load-dirand--parameter-save-dir. The former specifies the directory, parameter settings should be loaded from, whereas the latter replaces the argument--store-parameters. - The command line argument
--store-predictionsdoes now write ARFF files where the ground truth is replaced with the predictions of a model. Accordingly, the ARFF files written via the new argument--store-ground-truthcontains the original ground truth. - The command line argument
--evaluate-training-datahas been renamed to--predict-for-training-data. Analogously, a new argument--predict-for-test-datahas been added. - By default, the command line API is not terminated anymore when an error occurs while writing output data. This behavior can be changed via the new argument
--exit-on-error. - When passing the value
cross-validationto the command line argument--data-split, the optionsfirst_foldandlast_foldcan now be used to specify a range of folds to be run. The optioncurrent_foldhas been removed. - Output directories are now automatically created by the command line API. This behavior can be disabled via the newly added argument
--create-output-dir. - The command line argument
--wipe-output-dirhas been added. It allows to prevent existing output files from being deleted before an experiment starts. - The new command line arguments
--store-alland--print-allallow to print all output data on the console or to write it to files. - The options
min_samplesandmax_sampleshave been added to the values of the command line arguments--feature-samplingand--instance-sampling. - The indices of nominal and ordinal features are now provided to a learner's
fit-method via the keyword argumentsnominal_feature_indicesandordinal_feature_indices. - The Python API does now allow to provide custom weights for training examples to a learner's
fit-method via the keyword argumentsample_weights. - The Python API of the class
RuleModeldoes now provide an easy way to access the rules in the model.
Algorithmic Enhancements
- The BOOMER algorithm can now be configured to use either 32- or 64-bit floating point values for gradients and Hessians via the command line argument
--statistic-type. Using lower-precision values might speed up training at the risk of losing training accuracy. - Efficient data types and data structures are now used for storing binary scores calculated by the SeCo algorithm.
- Unnecessary conversions from integer weights to floating point values are now avoided.
Fixes
- Correct data types are now used for ground truth matrices when using the command line argument
--problem-type regression. Previously, the values in these matrices were completely off, rendering any experiments using them invalid. - An issue that caused thresholds and probabilities of isotonic regression models being swapped in output files when using the command line arguments
--store-marginal-probability-calibration-modeland--store-joint-probability-calibration-modelhas been fixed.
Quality-of-Life Improvements
- The Python package "mlrl-util" has been added. It provides common functionalities of the packages "mlrl-common" and "mlrl-testbed".
- The Python package "mlrl-testbed-arff" and "mlrl-testbed-sklearn" have been added as extensions to the package "mlrl-testbed".
- The Python package "mlrl-testbed" has completely been refactored, establishing it as a standalone package, independent of the package "mlrl-common".
- The Python packages "mlrl-common", "mlrl-seco" and "mlrl-boosting" have been restructured by introducing submodules.
- C++ 20 is now required for compiling the project.
- The integration tests do now check the contents of output files.
- The build targets
format_pythonandtest_format_pythonnow employ autoflake to detect and remove unused variables and imports, as well as unnecessarypassstatements from Python and Cython source files. - The build targets
format_cfgandtest_format_cfghave been added. They enforce a consistent style for .cfg files by employing the package config-formatter. - The tool cython-lint is now applied to Cython source files via Continuous Integration.
- C++
Published by michael-rapp 8 months ago
mlrl-boomer - Version 0.11.4
A bugfix release that comes with the following changes.
Fixes
- The parameter
--head-type autocan now be set via the command line API without an error being raised.
- C++
Published by boomer-merge-bot[bot] 12 months ago
mlrl-boomer - Version 0.11.3
A bugfix release that comes with the following changes.
Fixes
- Fixed faulty calculation of gradients and Hessians when using the BOOMER regression algorithm with the command line arguments
--loss squared-error-non-decomposableand--head-type single.
Quality-of-Life Improvements
- Linux ARM64 packages are now build natively instead of using virtualization, which speeds up the build process tremendously.
- Continuous Integration is now used to automatically update the versions of GitHub runners on a regular basis.
- C++
Published by boomer-merge-bot[bot] about 1 year ago
mlrl-boomer - Version 0.11.2
A bugfix release that comes with the following changes.
Fixes
- When building macOS packages, we do now manually compile OpenMP to ensure that the bundled library matches the target platform.
Quality-of-Life Improvements
- The build system now uses a lightweight custom implementation instead of SCons and is better modularized to avoid unnecessary runs of Continuous Integration jobs when only certain parts of it are modified.
- Releases are now automated via Continuous Integration, including the update of the project's changelog.
- The presentation of algorithmic parameters in the documentation has been improved.
- Continuous Integration is now used to automatically update outdated GitHub Actions, outdated Python dependencies, and the Doxygen configuration on a regular basis.
- Continuous Integration is now used to check the documentation for broken links and spelling mistakes.
- The syntax of TOML files is now validated by applying taplo via Continuous Integration.
- C++
Published by boomer-merge-bot[bot] about 1 year ago
mlrl-boomer - Version 0.11.1
A bugfix release that fixes the following issues:
- A crash has been fixed that could occur when using the command line argument
--print-rulesor--store-ruleswith a dataset that contains nominal features.
- C++
Published by michael-rapp over 1 year ago
mlrl-boomer - Version 0.11.0
A major update to the BOOMER algorithm that introduces the following changes.
This release comes with several API changes. For an updated overview of the available parameters and command line arguments, please refer to the documentation.
Algorithmic Enhancements
- The BOOMER algorithm can be used for solving regression problems, including single- and multi-output regression problems.
Additions to the Command Line API
- Custom algorithms can now be easily integrated with the command line API due to the ability to dynamically load code from your own Python modules or source files, as illustrated here
- The value to be used for sparse elements in the feature matrix can be specified via the argument
--sparse-feature-value.
API Changes
- The Python module or source file providing an integration with the machine learning algorithm to be used by the command line API must now be specified as described here.
- Several parameters and their values have been renamed to better reflect the scope of the project, which now includes multi-output regression problems. For an up-to-date list of parameters, please refer to the documentation.
- Rules with complete heads are now learned by default when using a decomposable loss function and a dense format for storing statistics.
- C++
Published by michael-rapp over 1 year ago
mlrl-boomer - Version 0.10.2
Version 0.10.2 (Aug. 9th, 2024)
A bugfix release that fixes the following issues.
- A rare issue that may result in rules with empty heads being learned when using the argument
--head-type partial-dynamichas been fixed.
- C++
Published by michael-rapp over 1 year ago
mlrl-boomer - Version 0.10.1
A bugfix release that comes with the following changes.
- If the sparse value of a feature matrix is provided to the Python API, it is now properly taken into account when converting into a dense matrix.
- The C++ code is now checked for common issues by applying
cpplintvia continuous integration. - The styling of YAML files is now verified by applying
yamlfixvia continuous integration.
- C++
Published by michael-rapp over 1 year ago
mlrl-boomer - Version 0.10.0
A major update to the BOOMER algorithm that introduces the following changes.
This release comes with several API changes. For an updated overview of the available parameters and command line arguments, please refer to the documentation.
Algorithmic Enhancements
- The project does now provide a Separate-and-Conquer (SeCo) algorithm based on traditional rule learning techniques that are particularly well-suited for learning interpretable models.
- Space-efficient data structures are now used for storing feature values, depending on whether the feature is numerical, ordinal, nominal, or binary. This also enables to use optimized code paths for dealing with these different types of features.
- The implementation of feature binning has been reworked in a way that avoids redundant code and results in a reduction of training times due to the use of the data structures mentioned above.
- The value to be used for sparse elements of a feature matrix can now be specified via the C++ or Python API.
- Nominal and ordinal feature values are now represented as integers to avoid issues due to limited floating point precision.
- Safe comparisons of floating point values are now used to avoid issues due to limited floating point precision.
- Fundamental data structures for vectors and matrices have been reworked to ease reusing existing functionality and avoiding redundant code.
Additions to the Command Line API
- Information about the program can now be printed via the argument
-vor--version. - Data characteristics do now include the number of ordinal attributes when printed on the console or written to a file via the command line argument
--print-data-characteristicsor--store-data-characteristics.
Bugfixes
- An issue has been fixed that caused the number of numerical and nominal features to be swapped when using the command line arguments
--print-data-characteristicsor--store-data-characteristics. - The correct directory is now used for loading and saving parameter settings when using the command line arguments
--parameter-dirand--store-parameters.
API Changes
- The option
num_threadsof the parameters--parallel-rule-refinement,--parallel-statistic-updateand--parallel-predictionhas been renamed tonum_preferred_threads.
Quality-of-Life Improvements
- The documentation has been updated to a more modern theme supporting light and dark theme variants.
- A build option that allows disabling multi-threading support via OpenMP at compile-time has been added.
- The groundwork for GPU support was laid. It can be disabled at compile-time via a build option.
- Added support for unit testing the project's C++ code. Compilation of the tests can be disabled via a build option.
- The Python code is now checked for common issues by applying
pylintvia continuous integration. - The Makefile has been replaced with wrapper scripts triggering a SCons build.
- Development versions of wheel packages are now regularly built via continuous integration, uploaded as artifacts, and published on Test-PyPI.
- Continuous integration is now used to maintain separate branches for major, feature, and bugfix releases and keep them up-to-date.
- The runtime of continuous integration jobs has been optimized by running individual steps only if necessary, caching files across subsequent runs, and making use of parallelization.
- When tests are run via continuous integration, a summary of the test results is now added to merge requests and Github workflows.
- Markdown files are now used for writing the documentation.
- A consistent style is now enforced for Markdown files by applying the tool
mdformatvia continuous integration. - C++ 17 or newer is now required for compiling the project.
- C++
Published by michael-rapp almost 2 years ago
mlrl-boomer - Version 0.10.0
A major update to the BOOMER algorithm that introduces the following changes.
{warning}
This release comes with several API changes. For an updated overview of the available parameters and command line arguments, please refer to the [documentation](https://mlrl-boomer.readthedocs.io/en/0.10.0/).
Algorithmic Enhancements
- The project does now provide a Separate-and-Conquer (SeCo) algorithm based on traditional rule learning techniques that are particularly well-suited for learning interpretable models.
- Space-efficient data structures are now used for storing feature values, depending on whether the feature is numerical, ordinal, nominal, or binary. This also enables to use optimized code paths for dealing with these different types of features.
- The implementation of feature binning has been reworked in a way that avoids redundant code and results in a reduction of training times due to the use of the data structures mentioned above.
- The value to be used for sparse elements of a feature matrix can now be specified via the C++ or Python API.
- Nominal and ordinal feature values are now represented as integers to avoid issues due to limited floating point precision.
- Safe comparisons of floating point values are now used to avoid issues due to limited floating point precision.
- Fundamental data structures for vectors and matrices have been reworked to ease reusing existing functionality and avoiding redundant code.
Additions to the Command Line API
- Information about the program can now be printed via the argument
-vor--version. - Data characteristics do now include the number of ordinal attributes when printed on the console or written to a file via the command line argument
--print-data-characteristicsor--store-data-characteristics.
Bugfixes
- An issue has been fixed that caused the number of numerical and nominal features to be swapped when using the command line arguments
--print-data-characteristicsor--store-data-characteristics. - The correct directory is now used for loading and saving parameter settings when using the command line arguments
--parameter-dirand--store-parameters.
API Changes
- The option
num_threadsof the parameters--parallel-rule-refinement,--parallel-statistic-updateand--parallel-predictionhas been renamed tonum_preferred_threads.
Quality-of-Life Improvements
- The documentation has been updated to a more modern theme supporting light and dark theme variants.
- A build option that allows disabling multi-threading support via OpenMP at compile-time has been added.
- The groundwork for GPU support was laid. It can be disabled at compile-time via a build option.
- Added support for unit testing the project's C++ code. Compilation of the tests can be disabled via a build option.
- The Python code is now checked for common issues by applying
pylintvia continuous integration. - The Makefile has been replaced with wrapper scripts triggering a SCons build.
- Development versions of wheel packages are now regularly built via continuous integration, uploaded as artifacts, and published on Test-PyPI.
- Continuous integration is now used to maintain separate branches for major, feature, and bugfix releases and keep them up-to-date.
- The runtime of continuous integration jobs has been optimized by running individual steps only if necessary, caching files across subsequent runs, and making use of parallelization.
- When tests are run via continuous integration, a summary of the test results is now added to merge requests and Github workflows.
- Markdown files are now used for writing the documentation.
- A consistent style is now enforced for Markdown files by applying the tool
mdformatvia continuous integration. - C++ 17 or newer is now required for compiling the project.
- C++
Published by michael-rapp almost 2 years ago
mlrl-boomer - Version 0.9.0
A major update to the BOOMER algorithm that introduces the following changes.
This release comes with several API changes. For an updated overview of the available parameters and command line arguments, please refer to the documentation.
Algorithmic Enhancements
- Sparse matrices can now be used to store gradients and Hessians if supported by the loss function. The desired behavior can be specified via a new parameter
--statistic-format. - Rules with partial heads can now be learned by setting the parameter
--head-typeto the valuepartial-fixed, if the number of predicted labels should be predefined, orpartial-dynamic, if the subset of predicted labels should be determined dynamically. - A beam search can now be used for the induction of individual rules by setting the parameter
--rule-inductionto the valuetop-down-beam-search. - Variants of the squared error loss and squared hinge loss, which take all labels of an example into account at the same time, can now be used by setting the parameter
--lossto the valuesquared-error-example-wiseorsquared-hinge-example-wise. - Probability estimates can be obtained for each label independently or via marginalization over the label vectors encountered in the training data by setting the new parameter
--probability-predictorto the valuelabel-wiseormarginalized. - Predictions that maximize the example-wise F1-measure can now be obtained by setting the parameter
--classification-predictorto the valuegfm. - Binary predictions can now be derived from probability estimates by specifying the new option
based_on_probabilities. - Isotonic regression models can now be used to calibrate marginal and joint probabilities predicted by a model via the new parameters
--marginal-probability-calibrationand--joint-probability-calibration. - The rules in a previously learned model can now be post-optimized by reconstructing each one of them in the context of the other rules via the new parameter
--sequential-post-optimization. - Early stopping or post-pruning can now be used by setting the new parameter
--global-pruningto the valuepre-pruningorpost-pruning. - Single labels can now be sampled in a round-robin fashion by setting the parameter
--feature-samplingto the new valueround-robin. - A fixed number of trailing features can now be retained when the parameter
--feature-samplingis set to the valuewithout-replacementby specifying the optionnum_retained.
Additions to the Command Line API
- Data sets in the MEKA format are now supported.
- Certain characteristics of binary predictions can be printed or written to output files via the new arguments
--print-prediction-characteristicsand--store-prediction-characteristics. - Unique label vectors contained in the training data can be printed or written to output files via the new arguments
--print-label-vectorsand--store-label-vectors. - Models for the calibration of marginal or joint probabilities can be printed or written to output files via the new arguments
--print-marginal-probability-calibration-model,--store-marginal-probability-calibration-model,--print-joint-probability-calibration-modeland--store-joint-probability-calibration-model. - Models can now be evaluated repeatedly, using a subset of their rules with increasing size, by specifying the argument
--incremental-prediction. - More control of how data is split into training and test sets is now provided by the argument
--data-splitthat replaces the arguments--foldsand--current-fold. - Binary labels, regression scores, or probabilities can now be predicted, depending on the value of the new argument
--prediction-type, which can be set to the valuesbinary,scores, orprobabilities. - Individual evaluation measures can now be enabled or disabled via additional options that have been added to the arguments
--print-evaluationand--store-evaluation. - The presentation of values printed on the console has vastly been improved. In addition, options for controlling the presentation of values to be printed or written to output files have been added to various command line arguments.
Bugfixes
- The behavior of the parameter
--label-formathas been fixed when set to the valueauto. - The behavior of the parameters
--holdoutand--instance-samplinghas been fixed when set to the valuestratified-label-wise. - The behavior of the parameter
--binary-predictorhas been fixed when set to the valueexample-wiseand using a model that has been loaded from disk. - Rules are now guaranteed to not cover more examples than specified via the option
min_coverage. The option is now also taken into account when using feature binning. Alternatively, the minimum coverage of rules can now also be specified as a fraction via the optionmin_support.
API Changes
- The parameter
--early-stoppinghas been replaced with a new parameter--global-pruning. - The parameter
--pruninghas been renamed to--rule-pruning. - The parameter
--classification-predictorhas been renamed to--binary-predictor. - The command line argument
--predict-probabilitieshas been replaced with a new argument--prediction-type. - The command line argument
--predicted-label-formathas been renamed to--prediction-format.
Quality-of-Life Improvements
- Continuous integration is now used to test the most common functionalites of the BOOMER algorithm and the corresponding command line API.
- Successful generation of the documentation is now tested via continuous integration.
- Style definitions for Python and C++ code are now enforced by applying the tools
clang-format,yapf, andisortvia continuous integration.
- C++
Published by michael-rapp over 2 years ago
mlrl-boomer - Version 0.8.2
A bugfix release that solves the following issues:
- Fixed prebuilt packages available at PyPI.
- Fixed output of nominal values when using the option
--print-rules true.
- C++
Published by michael-rapp almost 4 years ago
mlrl-boomer - Version 0.8.1
A bugfix release that solves the following issues:
- Missing feature values are now dealt with correctly when using feature binning.
- A rare issue that may cause segmentation faults when using instance sampling has been fixed.
- C++
Published by michael-rapp almost 4 years ago
mlrl-boomer - Version 0.8.0
This release comes with changes to the command line API. For an updated overview of the available parameters, please refer to the documentation.
A major update to the BOOMER algorithm that introduces the following changes:
- The programmatic C++ API was redesigned for a more convenient configuration of algorithms. This does also drastically reduce the amount of wrapper code that is necessary to access the API from other programming languages and therefore facilitates the support of additional languages in the future.
- An issue that may cause segmentation faults when using stratified sampling methods for the creation of holdout sets has been fixed.
- Pre-built packages for Windows systems are now available at PyPI.
- Pre-built packages for Linux aarch64 systems are now provided.
- C++
Published by michael-rapp about 4 years ago
mlrl-boomer - Version 0.7.1
A bugfix release that solves the following issues:
- Fixes an issue preventing the use of dense representations of ground truth label matrices that was introduced in version 0.7.0.
- Pre-built packages for MacOS systems are now available at PyPI.
- Linux and MacOS packages for Python 3.10 are now provided.
- C++
Published by michael-rapp about 4 years ago
mlrl-boomer - Version 0.7.0
A major update to the BOOMER algorithm that introduces the following changes:
- L1 regularization can now be used.
- A more space-efficient data structure is now used for the sparse representation of binary predictions.
- The Python API does now allow to access the rules in a model in a programmatic way.
- It is now possible to output certain characteristics of training datasets and rule models.
- Pre-built packages for the Linux platform are now available at PyPI.
- The documentation has vastly been improved.
- C++
Published by michael-rapp about 4 years ago
mlrl-boomer - Version 0.6.2
A bugfix release that solves the following issues:
- Fixes a segmentation fault when a sparse feature matrix should be used for prediction that was introduced in version 0.6.0.
- C++
Published by michael-rapp over 4 years ago
mlrl-boomer - Version 0.6.1
A bugfix release that solves the following issues:
- Fixes a mathematical problem when calculating the quality of potential single-label rules that was introduced in version 0.6.0.
- C++
Published by michael-rapp over 4 years ago
mlrl-boomer - Version 0.6.0
This release comes with changes to the command line API. For brevity and consistency, some parameters and/or their values have been renamed. Moreover, some parameters have been updated to use more reasonable default values. For an updated overview of the available parameters, please refer to the documentation.
A major update to the BOOMER algorithm that introduces the following changes:
- The parameter
--instance-samplingdoes now allow to use stratified sampling (stratified-label-wiseandstratified-example-wise). - The parameter
--holdoutdoes now allow to use stratified sampling (stratified-label-wiseandstratified-example-wise). - The parameter
--recalculate-predictionsdoes now allow to specify whether the predictions of rules should be recalculated on the entire training data, if instance sampling is used. - An additional parameter (
--prediction-format) that allows to specify whether predictions should be stored using dense or sparse matrices has been added. - The code for the construction of rule heads has been reworked, resulting in minor performance improvements.
- The unnecessary calculation of Hessians is now avoided when used single-label rules for the minimization of a non-decomposable loss function, resulting in a significant performance improvement.
- A programmatic C++ API for configuring algorithms, including the validation of parameters, is now provided.
- A documentation is now available online.
- C++
Published by michael-rapp over 4 years ago