rouge-rust 0.1.2

High-performance Rust-backed ROUGE scoring for Python

rouge-rust

rouge-rust is a Rust-powered replacement for Google's rouge-score Python package. It provides matching ROUGE-1, ROUGE-2, and ROUGE-L metrics through a PyO3 extension module, with fast batch APIs for large-scale evaluation workloads.

Features

• ROUGE-1, ROUGE-2, and ROUGE-L scoring
• score() for drop-in per-pair scoring
• score_batch() for list-of-dicts batch scoring
• score_batch_flat() for high-throughput struct-of-arrays batch scoring
• Rust core optimized for large datasets

Installation

pip install rouge-rust

Usage

import fast_rouge

single = fast_rouge.score("the cat sat", "the cat sat")
print(single["rouge1"].fmeasure)

batch = fast_rouge.score_batch(
    ["the cat sat", "hello world"],
    ["the dog sat", "hello there"],
)
print(batch[0]["rougeL"].precision)

flat = fast_rouge.score_batch_flat(
    ["the cat sat", "hello world"],
    ["the dog sat", "hello there"],
)
print(flat.rouge1_fmeasure[0])

Development

Build the extension into the active virtual environment:

source "$HOME/.cargo/env"
.venv/bin/maturin develop --release

Run tests:

source "$HOME/.cargo/env"
cargo test
.venv/bin/pytest -q

Run the benchmark:

PAIR_COUNT=100000 REPEATS=3 .venv/bin/python benchmark.py

Contributing

See CONTRIBUTING.md.

License

This project is released under the MIT License. See LICENSE.

Release

Build a source distribution and wheel:

source "$HOME/.cargo/env"
.venv/bin/maturin build --release --sdist -o dist

Validate the distributions:

.venv/bin/python -m twine check dist/*

Upload to PyPI:

source "$HOME/.cargo/env"
.venv/bin/maturin upload dist/*

GitHub Actions release flow

This repo includes a GitHub Actions pipeline in .github/workflows/release.yml.

• pushes and pull requests to main and develop build and test wheels
• tags matching v* build release artifacts
• tag builds publish to PyPI and create a GitHub Release

One-time PyPI setup

Configure PyPI trusted publishing for:

• owner: kyle-mirich
• repository: rouge-rust
• workflow: release.yml
• environment: pypi

After that, creating and pushing a tag such as v0.1.0 will trigger publishing.