https://github.com/ynop/evalmate
Tools for evaluating audio related machine learning tasks.
https://github.com/ynop/evalmate
Last synced: 3 months ago
JSON representation
Tools for evaluating audio related machine learning tasks.
- Host: GitHub
- URL: https://github.com/ynop/evalmate
- Owner: ynop
- License: mit
- Created: 2018-08-08T14:02:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-21T21:23:50.000Z (almost 4 years ago)
- Last Synced: 2025-09-23T22:53:00.285Z (7 months ago)
- Language: Python
- Homepage: http://evalmate.readthedocs.io/
- Size: 154 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# EVALMATE
[](https://pypi.python.org/pypi/evalmate)
[](https://app.shippable.com/github/ynop/evalmate)
[](https://app.shippable.com/github/ynop/evalmate)
[](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
* [A supported version of Python 3](https://docs.python.org/devguide/index.html#status-of-python-branches)
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/).
* [Syntax reference reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
* [Sphinx-specific additions to reStructuredText](http://www.sphinx-doc.org/en/stable/markup/index.html)
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]
```