https://github.com/openml/pyevaluationengine

A python library to do OpenML evaluation (mainly focussing on MFE meta-features)
https://github.com/openml/pyevaluationengine

Last synced: 12 months ago
JSON representation

A python library to do OpenML evaluation (mainly focussing on MFE meta-features)

• Host: GitHub
• URL: https://github.com/openml/pyevaluationengine
• Owner: openml
• License: other
• Created: 2021-12-13T09:48:51.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-17T11:45:47.000Z (over 4 years ago)
• Last Synced: 2025-06-07T11:07:57.571Z (about 1 year ago)
• Language: Python
• Size: 867 KB
• Stars: 0
• Watchers: 7
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
===============================

OpenML Python Evaluation Engine

===============================

.. image:: https://github.com/openml/pyEvaluationEngine/actions/workflows/tox.yml/badge.svg

    :target: https://github.com/openml/pyEvaluationEngine/actions/workflows/tox.yml

Python port of the OpenML `Evaluation Engine`_

Installation

=================================

Preferably you want to setup a virtual environment first to prevent the package from being installed to your global python installation. You can install the package with the CLI interface by using the provided setuptools.

.. code:: bash

    python setup.py install

After installation, the scripts can be ran with the following command: ``pyevaluationengine``. For more specific information about parameters, add the `-h` flag. The entrypoint for scripts is configured to be the ``cli.py`` file.

To see more specific instructions on how to install this package as a development dependency, we recommend looking the the CONTRIBURING file and follow some of the steps under the "Code Contributions" header.

Usage

=====

The CLI has the following modes:

config

    Used to set the API key and URL. This command needs to be run before you can use any of the other scripts.

all

    Processes and analyzes all of the unprocessed datasets once.

print

    Prints all of the unprocessed datasets to the terminal.

singular

    Processes the specified dataset by name.

amount

    Processes a specified amount of datasets

repeat

    Processes all unprocessed datasets and repeats this after a specified timeout

Further information

===================

* `OpenML documentation `_

* `OpenML client APIs `_

* `OpenML developer guide `_

* `Contact information `_

* `Citation request `_

* `OpenML blog `_

* `OpenML twitter account `_

.. _Evaluation Engine: https://github.com/ludev-nl/2021-01-pyEvaluationEngine