Skip to main content

Evalmate is a set of tools for evaluating audio related machine learning tasks.

Project description

# EVALMATE

[![PyPI](https://img.shields.io/pypi/v/evalmate.svg)](https://pypi.python.org/pypi/evalmate) [![Run Status](https://api.shippable.com/projects/5b6c0016c767f20700d1d2e0/badge?branch=master)](https://app.shippable.com/github/ynop/evalmate) [![Coverage Badge](https://api.shippable.com/projects/5b6c0016c767f20700d1d2e0/coverageBadge?branch=master)](https://app.shippable.com/github/ynop/evalmate) [![Documentation Status](https://readthedocs.org/projects/evalmate/badge/?version=latest)](https://evalmate.readthedocs.io/en/latest/?badge=latest)

Evalmate is a set of tools for evaluating audio related machine learning tasks.

[Documentation](https://evalmate.readthedocs.io/) [Examples](https://github.com/ynop/evalmate/tree/master/examples) [Changelog](https://evalmate.readthedocs.io/en/latest/notes/changelog.html)

## Installation

`sh pip install evalmate `

Install the latest development version:

`sh pip install git+https://github.com/ynop/evalmate.git `

## Development

### Prerequisites

It’s recommended to use a virtual environment when developing audiomate. To create one, execute the following command in the project’s root directory:

` python -m venv . `

To install evalmate and all it’s dependencies, execute:

` pip install -e . `

### Running the test suite

` pip install -e .[dev] python setup.py test `

With PyCharm you might have to change the default test runner. Otherwise, it might only suggest to use nose. To do so, go to File > Settings > Tools > Python Integrated Tools (on the Mac it’s PyCharm > Preferences > Settings > Tools > Python Integrated Tools) and change the test runner to py.test.

### Editing the Documentation

The documentation is written in [reStructuredText](http://docutils.sourceforge.net/rst.html) and transformed into various output formats with the help of [Sphinx](http://www.sphinx-doc.org/).

To generate the documentation, execute:

` pip install -e .[dev] cd docs make html `

The generated files are written to docs/_build/html.

### Versions

Versions is handled using [bump2version](https://github.com/c4urself/bump2version). To bump the version:

` bump2version [major,minor,patch,release,num] `

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for evalmate, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size evalmate-0.3.0-py3-none-any.whl (43.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size evalmate-0.3.0.tar.gz (27.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page