# "MLRL-Testbed": Utilities for Evaluating Multi-label Rule Learning Algorithms
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/mlrl-testbed)
[](https://mlrl-boomer.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/mrapp-ke/MLRL-Boomer/actions/workflows/test_build.yml)
[](https://github.com/mrapp-ke/MLRL-Boomer/actions/workflows/test_format.yml)
**Important links:** [Documentation](https://mlrl-boomer.readthedocs.io/en/latest/user_guide/testbed/index.html) | [Issue Tracker](https://github.com/mrapp-ke/MLRL-Boomer/issues) | [Changelog](https://mlrl-boomer.readthedocs.io/en/latest/misc/CHANGELOG.html) | [Contributors](https://mlrl-boomer.readthedocs.io/en/latest/misc/CONTRIBUTORS.html) | [Code of Conduct](https://mlrl-boomer.readthedocs.io/en/latest/misc/CODE_OF_CONDUCT.html) | [License](https://mlrl-boomer.readthedocs.io/en/latest/misc/LICENSE.html)
This software package provides **utilities for training and evaluating single- and multi-label rule learning algorithms** that have been implemented using the "MLRL-Common" library, including the following ones:
* **BOOMER (Gradient Boosted Multi-label Classification Rules)**: A state-of-the art algorithm that uses [gradient boosting](https://en.wikipedia.org/wiki/Gradient_boosting) to learn an ensemble of rules that is built with respect to a given multivariate loss function.
## Functionalities
Most notably, the package includes command line APIs that allow configuring the algorithms mentioned above, applying them to different datasets, and evaluating their predictive performance in terms of commonly used measures (provided by the [scikit-learn](https://scikit-learn.org/) framework). In summary, it provides the following functionalities:
* **Sinle- and multi-label datasets in the [Mulan](http://mulan.sourceforge.net/format.html) and [Meka format](https://waikato.github.io/meka/datasets/)** are supported.
* **Datasets can automatically be split into training and test data, including the possibility to use cross validation.** Alternatively, predefined splits can be used by supplying the data as separate files.
* **One-hot-encoding** can be applied to nominal or binary features.
* **Binary predictions, regression scores, or probability estimates** can be obtained from a model. Evaluation measures that are suited for the respective type of predictions are picked automatically.
* **Evaluation scores can be saved** to output files and printed on the console.
* **Rule models can be evaluated incrementally**, i.e., they can be evaluated repeatedly using a subset of the rules with increasing size.
* **Textual representations of rule models can be saved** to output files and printed on the console. In addition, the **characteristics of models can also be saved** and printed.
* **Characteristics of datasets can be saved** to output files and printed on the console.
* **Unique label vectors contained in a dataset can be saved** to output files and printed on the console.
* **Predictions can be saved** to output files and printed on the console. In addition, **characteristics of binary predictions can also be saved** and printed.
* **Models for the calibration of probabilities can be saved** to output files and printed on the console.
* **Models can be saved on disk** in order to be reused by future experiments.
* **Algorithmic parameters can be read from configuration files** instead of providing them via command line arguments. When providing parameters via the command line, corresponding configuration files can automatically be saved on disk.
## License
This project is open source software licensed under the terms of the [MIT license](https://mlrl-boomer.readthedocs.io/en/latest/misc/LICENSE.html). We welcome contributions to the project to enhance its functionality and make it more accessible to a broader audience. A frequently updated list of contributors is available [here](https://mlrl-boomer.readthedocs.io/en/latest/misc/CONTRIBUTORS.html).
Raw data
{
"_id": null,
"home_page": "https://github.com/mrapp-ke/MLRL-Boomer",
"name": "mlrl-testbed",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "machine learning, scikit-learn, multi-label classification, rule learning, evaluation",
"author": "Michael Rapp",
"author_email": "michael.rapp.ml@gmail.com",
"download_url": "https://github.com/mrapp-ke/MLRL-Boomer/releases",
"platform": "any",
"description": "# \"MLRL-Testbed\": Utilities for Evaluating Multi-label Rule Learning Algorithms\n\n[](https://opensource.org/licenses/MIT)\n[](https://badge.fury.io/py/mlrl-testbed)\n[](https://mlrl-boomer.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/mrapp-ke/MLRL-Boomer/actions/workflows/test_build.yml)\n[](https://github.com/mrapp-ke/MLRL-Boomer/actions/workflows/test_format.yml)\n\n**Important links:** [Documentation](https://mlrl-boomer.readthedocs.io/en/latest/user_guide/testbed/index.html) | [Issue Tracker](https://github.com/mrapp-ke/MLRL-Boomer/issues) | [Changelog](https://mlrl-boomer.readthedocs.io/en/latest/misc/CHANGELOG.html) | [Contributors](https://mlrl-boomer.readthedocs.io/en/latest/misc/CONTRIBUTORS.html) | [Code of Conduct](https://mlrl-boomer.readthedocs.io/en/latest/misc/CODE_OF_CONDUCT.html) | [License](https://mlrl-boomer.readthedocs.io/en/latest/misc/LICENSE.html)\n\nThis software package provides **utilities for training and evaluating single- and multi-label rule learning algorithms** that have been implemented using the \"MLRL-Common\" library, including the following ones:\n\n* **BOOMER (Gradient Boosted Multi-label Classification Rules)**: A state-of-the art algorithm that uses [gradient boosting](https://en.wikipedia.org/wiki/Gradient_boosting) to learn an ensemble of rules that is built with respect to a given multivariate loss function.\n\n## Functionalities\n\nMost notably, the package includes command line APIs that allow configuring the algorithms mentioned above, applying them to different datasets, and evaluating their predictive performance in terms of commonly used measures (provided by the [scikit-learn](https://scikit-learn.org/) framework). In summary, it provides the following functionalities:\n\n* **Sinle- and multi-label datasets in the [Mulan](http://mulan.sourceforge.net/format.html) and [Meka format](https://waikato.github.io/meka/datasets/)** are supported.\n* **Datasets can automatically be split into training and test data, including the possibility to use cross validation.** Alternatively, predefined splits can be used by supplying the data as separate files.\n* **One-hot-encoding** can be applied to nominal or binary features.\n* **Binary predictions, regression scores, or probability estimates** can be obtained from a model. Evaluation measures that are suited for the respective type of predictions are picked automatically.\n* **Evaluation scores can be saved** to output files and printed on the console.\n* **Rule models can be evaluated incrementally**, i.e., they can be evaluated repeatedly using a subset of the rules with increasing size.\n* **Textual representations of rule models can be saved** to output files and printed on the console. In addition, the **characteristics of models can also be saved** and printed.\n* **Characteristics of datasets can be saved** to output files and printed on the console.\n* **Unique label vectors contained in a dataset can be saved** to output files and printed on the console.\n* **Predictions can be saved** to output files and printed on the console. In addition, **characteristics of binary predictions can also be saved** and printed.\n* **Models for the calibration of probabilities can be saved** to output files and printed on the console.\n* **Models can be saved on disk** in order to be reused by future experiments.\n* **Algorithmic parameters can be read from configuration files** instead of providing them via command line arguments. When providing parameters via the command line, corresponding configuration files can automatically be saved on disk.\n\n## License\n\nThis project is open source software licensed under the terms of the [MIT license](https://mlrl-boomer.readthedocs.io/en/latest/misc/LICENSE.html). We welcome contributions to the project to enhance its functionality and make it more accessible to a broader audience. A frequently updated list of contributors is available [here](https://mlrl-boomer.readthedocs.io/en/latest/misc/CONTRIBUTORS.html). \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Provides utilities for the training and evaluation of multi-label rule learning algorithms",
"version": "0.10.0",
"project_urls": {
"Documentation": "https://mlrl-boomer.readthedocs.io/en/latest",
"Download": "https://github.com/mrapp-ke/MLRL-Boomer/releases",
"Homepage": "https://github.com/mrapp-ke/MLRL-Boomer",
"Issue Tracker": "https://github.com/mrapp-ke/MLRL-Boomer/issues"
},
"split_keywords": [
"machine learning",
" scikit-learn",
" multi-label classification",
" rule learning",
" evaluation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc651ec0fa689af0fdfffb2e2cfc5ed64cefd33834c4ccaff8517f15d1ac1248",
"md5": "837450df07d32e47378ee9ec46c97ea5",
"sha256": "94e7230a292c0925378100c9f213eaaaa22fe6c6d2afbde06fdd73616cf07300"
},
"downloads": -1,
"filename": "mlrl_testbed-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "837450df07d32e47378ee9ec46c97ea5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 57116,
"upload_time": "2024-05-05T00:06:13",
"upload_time_iso_8601": "2024-05-05T00:06:13.795068Z",
"url": "https://files.pythonhosted.org/packages/bc/65/1ec0fa689af0fdfffb2e2cfc5ed64cefd33834c4ccaff8517f15d1ac1248/mlrl_testbed-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-05 00:06:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mrapp-ke",
"github_project": "MLRL-Boomer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mlrl-testbed"
}
JSON
