A flexible toolkit to enable replicable subjective evaluations
Project description
Replikant
Replikant is a python toolkit which aims to enable researcher to develop their own subjective evaluation recipes. It relies on Flask, Jinja2 and SQLite, and is a refactoring of FlexEval.
I am currently doing some final important cleaning part which I thought would be done by now, but requires a bit more time.
How to install
Replikant has been tested on python 3.11.
To install the current stable version, run the following command:
pip install replikant
To install the current unstable version, run the following command:
pip install git+https://github.com/seblemaguer/replikant.git
Developping and running a recipe
Defining an recipe
The easiest is to start with one of the available recipes and adapt it to your needs.
Here is a list of already available recipes of published studies:
- https://github.com/sigmedia/bc_2013_extension/tree/master/evaluation/2013-EH2_EXT (MOS - naturalness, similarity; Intelligibility)
- https://github.com/sigmedia/bc_2013_extension/tree/master/evaluation/mushra (MUSHRA test)
- https://github.com/sigmedia/bc_2013_extension/tree/master/evaluation/ranked-choice-voting (Ranked Choice Voting)
Launching a recipe
Simply run :
replikant <path_configuration_recipe.yaml>
By default, the evaluation will be available at: http://127.0.0.1:8080.
The overall behaviour of replikant can be controlled from the command call. Here are the options:
usage: replikant [-h] [-d] [-i IP] [-p PORT] [-P] [-t] [-u URL] [-l LOG_FILE] [-v] RECIPE_CONFIGURATION
Replikant
positional arguments:
RECIPE_CONFIGURATION Recipe's configuration file
options:
-h, --help show this help message and exit
-d, --debug Start the server in debugging mode
-i IP, --ip IP IP's server
-p PORT, --port PORT port
-P, --production Start the server in production mode
-t, --threaded Enable threads.
-u URL, --url URL URL of the server (needed for flask redirections!) if different from http://<ip>:<port>/
-l LOG_FILE, --log_file LOG_FILE
Logger file
-v, --verbosity increase output verbosity
Contributing
If you want to participate to the development, you can install the necessary packages using:
pip install -e .[dev]
You then need to activate the pre-commit git hooks:
pre-commit install
Citing
@inproceedings{lemaguer25_interspeech,
title = {Enabling the replicability of speech synthesis perceptual evaluations},
author = {Sébastien {Le Maguer} and Gwénolé Lecorvé and Damien Lolive and Naomi Harte and Juraj Šimko},
year = {2025},
booktitle = {Interspeech 2025},
pages = {2545--2549},
doi = {10.21437/Interspeech.2025-401},
issn = {2958-1796},
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file replikant-0.0.2.tar.gz.
File metadata
- Download URL: replikant-0.0.2.tar.gz
- Upload date:
- Size: 67.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a2fb7cd735f5f3bb8f9edc31ecbec7d27050a7d238828a51d7b0c413c71408de
|
|
| MD5 |
718e614f189bd888dedbf3477786bac3
|
|
| BLAKE2b-256 |
e90461e8a46d6c7cfbcd6a71bbe8a76da277b0b0d317f601f454feaaedb335ff
|
File details
Details for the file replikant-0.0.2-py3-none-any.whl.
File metadata
- Download URL: replikant-0.0.2-py3-none-any.whl
- Upload date:
- Size: 91.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1216d26245a73a7ced6673319b02aae79802da263ff923c5a9120b1b3f0f8ee2
|
|
| MD5 |
eca0a23c0599b3cf0d4ec626cdeb259e
|
|
| BLAKE2b-256 |
dd3cda9108355ee946de1ac3ce120df45853b6afcdc435a063677fd09c5db64a
|