| # SimulEval |
| [](https://github.com/facebookresearch/SimulEval/actions) |
|
|
| SimulEval is a general evaluation framework for simultaneous translation on text and speech. Full documentation can be found [here](https://simuleval.readthedocs.io/en/v1.1.0/). |
|
|
| ## Installation |
| ``` |
| git clone https://github.com/facebookresearch/SimulEval.git |
| cd SimulEval |
| pip install -e . |
| ``` |
|
|
| ## Quick Start |
| Following is the evaluation of a [dummy agent](examples/quick_start) which operates wait-k (k = 3) policy and generates random words until the length of the generated words is the same as the number of all the source words. |
| ```shell |
| cd examples/quick_start |
| simuleval --source source.txt --target target.txt --agent first_agent.py |
| ``` |
|
|
| # License |
|
|
| SimulEval is licensed under Creative Commons BY-SA 4.0. |
|
|
| # Citation |
|
|
| Please cite as: |
|
|
| ```bibtex |
| @inproceedings{simuleval2020, |
| title = {Simuleval: An evaluation toolkit for simultaneous translation}, |
| author = {Xutai Ma, Mohammad Javad Dousti, Changhan Wang, Jiatao Gu, Juan Pino}, |
| booktitle = {Proceedings of the EMNLP}, |
| year = {2020}, |
| } |
| ``` |
|
|
