mlrl-testbed


Namemlrl-testbed JSON
Version 0.11.1 PyPI version JSON
download
home_pagehttps://github.com/mrapp-ke/MLRL-Boomer
SummaryProvides utilities for the training and evaluation of machine learning algorithms
upload_time2024-09-24 21:20:01
maintainerNone
docs_urlNone
authorMichael Rapp
requires_python>=3.10
licenseMIT
keywords machine learning scikit-learn multi-label classification rule learning evaluation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # "MLRL-Testbed": Utilities for Evaluating Multi-label Rule Learning Algorithms

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![PyPI version](https://badge.fury.io/py/mlrl-testbed.svg)](https://badge.fury.io/py/mlrl-testbed) [![Documentation Status](https://readthedocs.org/projects/mlrl-boomer/badge/?version=latest)](https://mlrl-boomer.readthedocs.io/en/latest/?badge=latest)

**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 machine learning algorithms**, including classification and regression problems.

## Functionalities

Most notably, the package includes a command line API that allows configuring and running machine learning algorithms. For example, the [BOOMER algorithm](https://mlrl-boomer.readthedocs.io/en/stable/user_guide/boosting/index.html) integrates with the command line API out-of-the-box. For [using other algorithms](https://mlrl-boomer.readthedocs.io/en/latest/user_guide/testbed/runnables.html) only a few lines of Python code are necessary.

The command line API allows applying machine learning algorithms 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 detail, it supports the following functionalities:

- **Single- and multi-output 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, scores, or probability estimates** can be obtained from a machine learning algorithm, including **classification** and regression algorithms. 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.
- **Ensemble models can be evaluated incrementally**, i.e., they can be evaluated repeatedly using only a subset of their members with increasing size.
- **Textual representations of 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 classification 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 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.10",
    "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[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![PyPI version](https://badge.fury.io/py/mlrl-testbed.svg)](https://badge.fury.io/py/mlrl-testbed) [![Documentation Status](https://readthedocs.org/projects/mlrl-boomer/badge/?version=latest)](https://mlrl-boomer.readthedocs.io/en/latest/?badge=latest)\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 machine learning algorithms**, including classification and regression problems.\n\n## Functionalities\n\nMost notably, the package includes a command line API that allows configuring and running machine learning algorithms. For example, the [BOOMER algorithm](https://mlrl-boomer.readthedocs.io/en/stable/user_guide/boosting/index.html) integrates with the command line API out-of-the-box. For [using other algorithms](https://mlrl-boomer.readthedocs.io/en/latest/user_guide/testbed/runnables.html) only a few lines of Python code are necessary.\n\nThe command line API allows applying machine learning algorithms 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 detail, it supports the following functionalities:\n\n- **Single- and multi-output 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, scores, or probability estimates** can be obtained from a machine learning algorithm, including **classification** and regression algorithms. 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- **Ensemble models can be evaluated incrementally**, i.e., they can be evaluated repeatedly using only a subset of their members with increasing size.\n- **Textual representations of 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 classification 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 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 machine learning algorithms",
    "version": "0.11.1",
    "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": "c03736059129d94cee9eca47cb590ad18642e2ff159657a9290df0829fc842b3",
                "md5": "b2390211f44ceca48189a9a96e558a08",
                "sha256": "c0c1f5f8fdde4431fa0c28b71fee7e97835b926929d3fd7ecb23e7e79849eb8a"
            },
            "downloads": -1,
            "filename": "mlrl_testbed-0.11.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b2390211f44ceca48189a9a96e558a08",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 60563,
            "upload_time": "2024-09-24T21:20:01",
            "upload_time_iso_8601": "2024-09-24T21:20:01.401256Z",
            "url": "https://files.pythonhosted.org/packages/c0/37/36059129d94cee9eca47cb590ad18642e2ff159657a9290df0829fc842b3/mlrl_testbed-0.11.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-24 21:20:01",
    "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"
}
        
Elapsed time: 9.19744s