werx 0.3.0

A high-performance Python package for calculating Word Error Rate (WER), powered by Rust.

⚡Lightning fast Word Error Rate Calculations

Meta

What is WERx?

WERx is a high-performance Python package for calculating Word Error Rate (WER), built with Rust for unmatched speed, memory efficiency, and stability. WERx delivers accurate results with exceptional performance, making it ideal for large-scale evaluation tasks.

🚀 Why Use WERx?

⚡ Blazing Fast: Rust-powered core delivers outstanding performance, optimized for large datasets

🧩 Robust: Designed to handle edge cases gracefully, including empty strings and mismatched sequences

📐 Insightful: Provides rich word-level error breakdowns, including substitutions, insertions, deletions, and weighted error rates

🛡️ Production-Ready: Minimal dependencies, memory-efficient, and engineered for stability

⚙️ Installation

You can install WERx either with 'uv' or 'pip'.

Using uv (recommended):

uv pip install werx

Using pip:

pip install werx

✨ Usage

Import the WERx package

Python Code:

import werx

Examples:

1. Single sentence comparison

Python Code:

wer = werx.wer('i love cold pizza', 'i love pizza')
print(wer)

Results Output:

0.25

2. Corpus level Word Error Rate Calculation

Python Code:

ref = ['i love cold pizza','the sugar bear character was popular']
hyp = ['i love pizza','the sugar bare character was popular']
wer = werx.wer(ref, hyp)
print(wer)

Results Output:

0.2

3. Weighted Word Error Rate Calculation

Python Code:

ref = ['i love cold pizza', 'the sugar bear character was popular']
hyp = ['i love pizza', 'the sugar bare character was popular']

# Apply lower weight to insertions and deletions, standard weight for substitutions
wer = werx.weighted_wer(
    ref, 
    hyp, 
    insertion_weight=0.5, 
    deletion_weight=0.5, 
    substitution_weight=1.0
)
print(wer)

Results Output:

0.15

4. Complete Word Error Rate Breakdown

The analysis() function provides a complete breakdown of word error rates, supporting both standard WER and weighted WER calculations.

It delivers detailed, per-sentence metrics—including insertions, deletions, substitutions, and word-level error tracking, with the flexibility to customize error weights.

Results are easily accessible through standard Python objects or can be conveniently converted into Pandas and Polars DataFrames for further analysis and reporting.

4a. Getting Started

Python Code:

ref = ["the quick brown fox"]
hyp = ["the quick brown dog"]

results = werx.analysis(ref, hyp)

print("Inserted:", results[0].inserted_words)
print("Deleted:", results[0].deleted_words)
print("Substituted:", results[0].substituted_words)

Results Output:

Inserted Words   : []
Deleted Words    : []
Substituted Words: [('fox', 'dog')]

4b. Converting Analysis Results to a DataFrame

Note: To use this module, you must have either pandas or polars (or both) installed.

Install Pandas / Polars for DataFrame Conversion

uv pip install pandas
uv pip install polars

Python Code:

ref = ["i love cold pizza", "the sugar bear character was popular"]
hyp = ["i love pizza", "the sugar bare character was popular"]
results = werx.analysis(
    ref, hyp,
    insertion_weight=2,
    deletion_weight=2,
    substitution_weight=1
)

We’ve created a special utility to make working with DataFrames seamless. Just import the following helper:

import werx
from werx.utils import to_polars, to_pandas

You can then easily convert analysis results to get output using Polars:

# Convert to Polars DataFrame
df_polars = to_polars(results)
print(df_polars)

Alternatively, you can also use Pandas depending on your preference:

# Convert to Pandas DataFrame
df_pandas = to_pandas(results)
print(df_pandas)

Results Output:

wer	wwer	ld	n_ref	insertions	deletions	substitutions	inserted_words	deleted_words	substituted_words
0.25	0.50	1	4	0	1	0	[]	['cold']	[]
0.1667	0.1667	1	6	0	0	1	[]	[]	[('bear', 'bare')]

📄 License

This project is licensed under the Apache License 2.0.