Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/analyticsinmotion/werpy
🐍📦 Rapidly calculate and analyze the Word Error Rate (WER) with this powerful yet lightweight Python package.
https://github.com/analyticsinmotion/werpy
asr asr-evaluation automatic-speech-recognition levenshtein-distance metrics nlp pandas python python-package speech-to-text stt stt-benchmark wer word-error-rate
Last synced: 15 days ago
JSON representation
🐍📦 Rapidly calculate and analyze the Word Error Rate (WER) with this powerful yet lightweight Python package.
- Host: GitHub
- URL: https://github.com/analyticsinmotion/werpy
- Owner: analyticsinmotion
- License: bsd-3-clause
- Created: 2023-04-26T04:51:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-12T23:25:03.000Z (3 months ago)
- Last Synced: 2024-09-14T16:25:26.460Z (2 months ago)
- Topics: asr, asr-evaluation, automatic-speech-recognition, levenshtein-distance, metrics, nlp, pandas, python, python-package, speech-to-text, stt, stt-benchmark, wer, word-error-rate
- Language: Python
- Homepage: https://www.analyticsinmotion.com
- Size: 430 KB
- Stars: 11
- Watchers: 4
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
Word Error Rate for Python
| | |
| --- | --- |
| Meta | [](https://www.python.org/downloads/) [](https://github.com/analyticsinmotion/werpy/blob/main/LICENSE) [](https://github.com/psf/black) [](https://www.analyticsinmotion.com) |
| Testing | [](https://github.com/analyticsinmotion/werpy/actions/workflows/codeql.yml) [](https://github.com/analyticsinmotion/werpy/actions/workflows/codacy.yml) [](https://www.codefactor.io/repository/github/analyticsinmotion/werpy) [](https://dl.circleci.com/status-badge/redirect/gh/analyticsinmotion/werpy/tree/main) [](https://codecov.io/gh/analyticsinmotion/werpy) [](https://app.fossa.com/projects/git%2Bgithub.com%2Fanalyticsinmotion%2Fwerpy?ref=badge_shield&issueType=license)|
| Package | [](https://pypi.org/project/werpy/) [](https://pypi.org/project/werpy/) [](https://pepy.tech/project/werpy) [](https://werpy.readthedocs.io/en/latest/?badge=latest) |
## What is werpy?
**werpy** is a powerful yet lightweight Python package that rapidly calculates and analyzes the Word Error Rate (WER) between two sets of text.
It has been designed with the flexibility to handle multiple input data types such as strings, lists and NumPy arrays.
The package also includes a full set of features such as normalizing the input text to account for data collection variability and the capability to easily assign different weights/penalties to specific error classifications (insertions, deletions, and substitutions).
Additionally, the summary function provides a comprehensive breakdown of the calculated results to assist in analyzing the specific errors quickly and in more detail.
## Functions available in werpy
The following table provides an overview of the functions that can be used in werpy.
| Function | Description |
| ------------- | ------------- |
| normalize(text) | Preprocess input text to remove punctuation, remove duplicated spaces, leading/trailing blanks and convert all words to lowercase. |
| wer(reference, hypothesis) | Calculate the overall Word Error Rate for the entire reference and hypothesis texts. |
| wers(reference, hypothesis) | Calculates a list of the Word Error Rates for each of the reference and hypothesis texts. |
| werp(reference, hypothesis) | Calculates a weighted Word Error Rate for the entire reference and hypothesis texts. |
| werps(reference, hypothesis) | Calculates a list of weighted Word Error Rates for each of the reference and hypothesis texts. |
| summary(reference, hypothesis) | Provides a comprehensive breakdown of the calculated results including the WER, Levenshtein Distance and all the insertion, deletion and substitution errors. |
| summaryp(reference, hypothesis) | Delivers an in-depth breakdown of the results, covering metrics like WER, Levenshtein Distance, and a detailed account of insertion, deletion, and substitution errors, inclusive of the weighted WER. |
## Installation
You can install the latest **werpy** release with Python's pip package manager:
```python
# Install werpy from PyPi
pip install werpy
```
## Usage
**Import the werpy package**
*Python Code:*
```python
import werpy
```
**Example 1 - Normalize a list of text**
*Python Code:*
```python
input_data = ["It's very popular in Antarctica.","The Sugar Bear character"]
reference = werpy.normalize(input_data)
print(reference)
```
*Results Output:*
```
['its very popular in antarctica', 'the sugar bear character']
```
**Example 2 - Calculate the overall Word Error Rate on a set of strings**
*Python Code:*
```python
wer = werpy.wer('i love cold pizza', 'i love pizza')
print(wer)
```
*Results Output:*
```
0.25
```
**Example 3 - Calculate the overall Word Error Rate on a set of lists**
*Python Code:*
```python
ref = ['i love cold pizza','the sugar bear character was popular']
hyp = ['i love pizza','the sugar bare character was popular']
wer = werpy.wer(ref, hyp)
print(wer)
```
*Results Output:*
```
0.2
```
**Example 4 - Calculate the Word Error Rates for each set of texts**
*Python Code:*
```python
ref = ['no one else could claim that','she cited multiple reasons why']
hyp = ['no one else could claim that','she sighted multiple reasons why']
wers = werpy.wers(ref, hyp)
print(wers)
```
*Results Output:*
```
[0.0, 0.2]
```
**Example 5 - Calculate the weighted Word Error Rates for the entire set of text**
*Python Code:*
```python
ref = ['it was beautiful and sunny today']
hyp = ['it was a beautiful and sunny day']
werp = werpy.werp(ref, hyp, insertions_weight=0.5, deletions_weight=0.5, substitutions_weight=1)
print(werp)
```
*Results Output:*
```
0.25
```
**Example 6 - Calculate a list of weighted Word Error Rates for each of the reference and hypothesis texts**
*Python Code:*
```python
ref = ['it blocked sight lines of central park', 'her father was an alderman in the city government']
hyp = ['it blocked sightlines of central park', 'our father was an elder man in the city government']
werps = werpy.werps(ref, hyp, insertions_weight = 0.5, deletions_weight = 0.5, substitutions_weight = 1)
print(werps)
```
*Results Output:*
```
[0.21428571428571427, 0.2777777777777778]
```
**Example 7 - Provide a complete breakdown of the Word Error Rate calculations for each of the reference and hypothesis texts**
*Python Code:*
```python
ref = ['it is consumed domestically and exported to other countries', 'rufino street in makati right inside the makati central business district', 'its estuary is considered to have abnormally low rates of dissolved oxygen', 'he later cited his first wife anita as the inspiration for the song', 'no one else could claim that']
hyp = ['it is consumed domestically and exported to other countries', 'rofino street in mccauti right inside the macasi central business district', 'its estiary is considered to have a normally low rates of dissolved oxygen', 'he later sighted his first wife anita as the inspiration for the song', 'no one else could claim that']
summary = werpy.summary(ref, hyp)
print(summary)
```
*Results Output:*
**Example 8 - Provide a complete breakdown of the Weighted Word Error Rate for each of the input texts**
*Python Code:*
```python
ref = ['the tower caused minor discontent because it blocked sight lines of central park', 'her father was an alderman in the city government', 'he was commonly referred to as the blacksmith of ballinalee']
hyp = ['the tower caused minor discontent because it blocked sightlines of central park', 'our father was an alderman in the city government', 'he was commonly referred to as the blacksmith of balen alley']
weighted_summary = werpy.summaryp(ref, hyp, insertions_weight = 0.5, deletions_weight = 0.5, substitutions_weight = 1)
print(weighted_summary)
```
*Results Output:*
## Dependencies
- NumPy - Provides an assortment of routines for fast operations on arrays
- Pandas - Powerful data structures for data analysis, time series, and statistics
## Licensing
``werpy`` is released under the terms of the BSD 3-Clause License. Please refer to the LICENSE file for full details.
This project also includes third-party packages distributed under the BSD-3-Clause license (NumPy, Pandas) and the Apache License 2.0 (Cython).
The full NumPy, Pandas and Cython licenses can be found in the LICENSES directory in this repository.
They can also be found directly in the following source codes:
- NumPy - https://github.com/numpy/numpy/blob/main/LICENSE.txt
- Pandas - https://github.com/pandas-dev/pandas/blob/main/LICENSE
- Cython - https://github.com/cython/cython/blob/master/LICENSE.txt