# 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},
}
```
Raw data
{
"_id": null,
"home_page": "",
"name": "simuleval",
"maintainer": "",
"docs_url": null,
"requires_python": ">3.7.0",
"maintainer_email": "",
"keywords": "SimulEval,Machine Translation,Evaluation,Metrics,BLEU,TER,METEOR,chrF,RIBES,WMD,Embedding Average,Embedding Extrema,Embedding Greedy,Embedding Average,SimulEval,SimulEval_Testing_Package_1,facebookresearch,facebook,Meta-Evaluation",
"author": "Xutai Ma",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ba/11/ddaec370a420450589334a5ad3f2804823ec537100e540d58eb5e50886d3/simuleval-1.1.4.tar.gz",
"platform": null,
"description": "# SimulEval\n[](https://github.com/facebookresearch/SimulEval/actions)\n\nSimulEval 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/).\n\n## Installation\n```\ngit clone https://github.com/facebookresearch/SimulEval.git\ncd SimulEval\npip install -e .\n```\n\n## Quick Start\nFollowing 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.\n```shell\ncd examples/quick_start\nsimuleval --source source.txt --target target.txt --agent first_agent.py\n```\n\n# License\n\nSimulEval is licensed under Creative Commons BY-SA 4.0.\n\n# Citation\n\nPlease cite as:\n\n```bibtex\n@inproceedings{simuleval2020,\n title = {Simuleval: An evaluation toolkit for simultaneous translation},\n author = {Xutai Ma, Mohammad Javad Dousti, Changhan Wang, Jiatao Gu, Juan Pino},\n booktitle = {Proceedings of the EMNLP},\n year = {2020},\n}\n```\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "SimulEval: A Flexible Toolkit for Automated Machine Translation Evaluation",
"version": "1.1.4",
"project_urls": null,
"split_keywords": [
"simuleval",
"machine translation",
"evaluation",
"metrics",
"bleu",
"ter",
"meteor",
"chrf",
"ribes",
"wmd",
"embedding average",
"embedding extrema",
"embedding greedy",
"embedding average",
"simuleval",
"simuleval_testing_package_1",
"facebookresearch",
"facebook",
"meta-evaluation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "040ef04e3cbc4542f4527848e2f77875af9f62b6cab0626eb7814caa89e8ec0a",
"md5": "4863a0d9b50755e354a1e7a58a890a5c",
"sha256": "6cdfae20a5cd2a7a1ca5879a23a448ee4c54aeee442fa30ad6e41f5313a36808"
},
"downloads": -1,
"filename": "simuleval-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4863a0d9b50755e354a1e7a58a890a5c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.7.0",
"size": 47281,
"upload_time": "2023-11-30T19:50:56",
"upload_time_iso_8601": "2023-11-30T19:50:56.757652Z",
"url": "https://files.pythonhosted.org/packages/04/0e/f04e3cbc4542f4527848e2f77875af9f62b6cab0626eb7814caa89e8ec0a/simuleval-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba11ddaec370a420450589334a5ad3f2804823ec537100e540d58eb5e50886d3",
"md5": "9397641ef8a074839b3586af9026f905",
"sha256": "e8fc17c217cf61044d6190e8f9b88d9b35f59edb4d2309a7a253c6cf32a78e08"
},
"downloads": -1,
"filename": "simuleval-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "9397641ef8a074839b3586af9026f905",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.7.0",
"size": 582642,
"upload_time": "2023-11-30T19:50:58",
"upload_time_iso_8601": "2023-11-30T19:50:58.282884Z",
"url": "https://files.pythonhosted.org/packages/ba/11/ddaec370a420450589334a5ad3f2804823ec537100e540d58eb5e50886d3/simuleval-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-30 19:50:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "simuleval"
}
JSON