| Name | jiwer JSON |
| Version |
3.0.5
JSON |
| download |
| home_page | https://github.com/jitsi/jiwer |
| Summary | Evaluate your speech-to-text system with similarity measures such as word error rate (WER) |
| upload_time | 2024-11-01 16:18:57 |
| maintainer | None |
| docs_url | None |
| author | Nik Vaessen |
| requires_python | <4.0,>=3.7 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JiWER
JiWER is a simple and fast python package to evaluate an automatic speech recognition system.
It supports the following measures:
1. word error rate (WER)
2. match error rate (MER)
3. word information lost (WIL)
4. word information preserved (WIP)
5. character error rate (CER)
These measures are computed with the use of the minimum-edit distance between one or more reference and hypothesis sentences.
The minimum-edit distance is calculated using [RapidFuzz](https://github.com/maxbachmann/RapidFuzz), which uses C++ under the hood, and is therefore faster than a pure python implementation.
## Documentation
For further info, see the documentation at [jitsi.github.io/jiwer](https://jitsi.github.io/jiwer).
## Installation
You should be able to install this package using [poetry](https://python-poetry.org/docs/):
```
$ poetry add jiwer
```
Or, if you prefer old-fashioned pip and you're using Python >= `3.7`:
```bash
$ pip install jiwer
```
## Usage
The most simple use-case is computing the word error rate between two strings:
```python
from jiwer import wer
reference = "hello world"
hypothesis = "hello duck"
error = wer(reference, hypothesis)
```
## Licence
The jiwer package is released under the `Apache License, Version 2.0` licence by [8x8](https://www.8x8.com/).
For further information, see [`LICENCE`](./LICENSE).
## Reference
_For a comparison between WER, MER and WIL, see: \
Morris, Andrew & Maier, Viktoria & Green, Phil. (2004). [From WER and RIL to MER and WIL: improved evaluation measures for connected speech recognition.](https://www.researchgate.net/publication/221478089_From_WER_and_RIL_to_MER_and_WIL_improved_evaluation_measures_for_connected_speech_recognition)_
Raw data
{
"_id": null,
"home_page": "https://github.com/jitsi/jiwer",
"name": "jiwer",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Nik Vaessen",
"author_email": "nikvaes@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/37/99f800e78b9cff2b6c404812e33641b6b6b5b94088081e6a28548094e46f/jiwer-3.0.5.tar.gz",
"platform": null,
"description": "# JiWER\n\nJiWER is a simple and fast python package to evaluate an automatic speech recognition system.\nIt supports the following measures:\n\n1. word error rate (WER)\n2. match error rate (MER)\n3. word information lost (WIL) \n4. word information preserved (WIP) \n5. character error rate (CER)\n\nThese measures are computed with the use of the minimum-edit distance between one or more reference and hypothesis sentences.\nThe minimum-edit distance is calculated using [RapidFuzz](https://github.com/maxbachmann/RapidFuzz), which uses C++ under the hood, and is therefore faster than a pure python implementation.\n\n## Documentation\n\nFor further info, see the documentation at [jitsi.github.io/jiwer](https://jitsi.github.io/jiwer).\n\n## Installation\n\nYou should be able to install this package using [poetry](https://python-poetry.org/docs/): \n\n```\n$ poetry add jiwer\n```\n\nOr, if you prefer old-fashioned pip and you're using Python >= `3.7`:\n\n```bash\n$ pip install jiwer\n```\n\n## Usage\n\nThe most simple use-case is computing the word error rate between two strings:\n\n```python\nfrom jiwer import wer\n\nreference = \"hello world\"\nhypothesis = \"hello duck\"\n\nerror = wer(reference, hypothesis)\n```\n\n## Licence\n\nThe jiwer package is released under the `Apache License, Version 2.0` licence by [8x8](https://www.8x8.com/).\n\nFor further information, see [`LICENCE`](./LICENSE).\n\n## Reference\n\n_For a comparison between WER, MER and WIL, see: \\\nMorris, Andrew & Maier, Viktoria & Green, Phil. (2004). [From WER and RIL to MER and WIL: improved evaluation measures for connected speech recognition.](https://www.researchgate.net/publication/221478089_From_WER_and_RIL_to_MER_and_WIL_improved_evaluation_measures_for_connected_speech_recognition)_\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Evaluate your speech-to-text system with similarity measures such as word error rate (WER)",
"version": "3.0.5",
"project_urls": {
"Homepage": "https://github.com/jitsi/jiwer",
"Repository": "https://github.com/jitsi/jiwer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc7f00bec152973661ea89628490367fa3058d7f56d51d2c1ad02a44589d12cd",
"md5": "99bc013406b0ea0763b871150069e1b0",
"sha256": "5a55758fd1ed0b46a04e51eae6325ad77810511d1372dcbb2333ec8d5850f7b2"
},
"downloads": -1,
"filename": "jiwer-3.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99bc013406b0ea0763b871150069e1b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 21990,
"upload_time": "2024-11-01T16:18:55",
"upload_time_iso_8601": "2024-11-01T16:18:55.928326Z",
"url": "https://files.pythonhosted.org/packages/dc/7f/00bec152973661ea89628490367fa3058d7f56d51d2c1ad02a44589d12cd/jiwer-3.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "423799f800e78b9cff2b6c404812e33641b6b6b5b94088081e6a28548094e46f",
"md5": "dd05a960689dd53b7866d5aa427b2bb2",
"sha256": "4a215a774b6a2ad92838bfc9f64f072709557af48e3eb9d6bdbcee6819535b2d"
},
"downloads": -1,
"filename": "jiwer-3.0.5.tar.gz",
"has_sig": false,
"md5_digest": "dd05a960689dd53b7866d5aa427b2bb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 17537,
"upload_time": "2024-11-01T16:18:57",
"upload_time_iso_8601": "2024-11-01T16:18:57.337529Z",
"url": "https://files.pythonhosted.org/packages/42/37/99f800e78b9cff2b6c404812e33641b6b6b5b94088081e6a28548094e46f/jiwer-3.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 16:18:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jitsi",
"github_project": "jiwer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jiwer"
}
