zerobench_eval/test_references.py

"""Regression tests for the WER reference policy.

    pytest zerobench_eval/test_references.py -q

Two invariants, and they pull in opposite directions:

  ARTIFACTS  a correct reading transcribed in an unexpected FORMAT must score
             0.00 — otherwise the benchmark measures the ASR's formatting
             policy instead of the TTS model.
  DEFECTS    a genuinely wrong reading must still cost WER — otherwise the
             reference set has been loosened into uselessness.

Every case below is a real transcript observed in https://github.com/zeroweight-ai/ZeroTTS/blob/main/evaluation/HIGH_WER_ANALYSIS.md.
"""

from __future__ import annotations

import sys
from pathlib import Path

import pytest

sys.path.insert(0, str(Path(__file__).resolve().parent.parent))

from zerobench_eval.references import best_wer, expand, n_variants, vi_int  # noqa: E402

_TP_HCM = ("Hà Nội, TP. HCM và Đà Nẵng chiếm khoảng 35% GDP cả nước, nhưng chỉ có 12% "
           "diện tích cây xanh trên đầu người đạt chuẩn, theo báo cáo được công bố "
           "ngày 18/04 vừa qua.")

# (text, transcript) pairs that MUST score 0.00 — correct audio, unexpected format.
ARTIFACTS = [
    # intra-word spacing: both ASRs write "chat GPT", the text says "ChatGPT"
    ("Tôi dùng ChatGPT mỗi ngày.", "tôi dùng chat gpt mỗi ngày."),
    # hybrid: acronym kept as letters WHILE numbers are spelled out
    ("GDP quý III tăng 6,8%.", "gdp quý ba tăng sáu phẩy tám phần trăm."),
    # whisper-large-v3 writes dates as digits, PhoWhisper spells them out
    ("Hạn cuối là ngày 31/12/2025.", "Hạn cuối là ngày 31 tháng 12, 2025."),
    ("Hạn cuối là ngày 31/12/2025.",
     "hạn cuối là ngày ba mốt tháng mười hai hai ngàn không trăm hai mươi lăm."),
    # "không trăm" year padding and bốn/tư are both standard
    ("Từ năm 2020 đến năm 2024, số người dùng ví điện tử đã tăng gấp 3 lần.",
     "từ năm hai nghìn không trăm hai mươi đến năm hai nghìn không trăm hai mươi tư "
     "số người dùng ví điện tử đã tăng gấp ba lần."),
    # năm/lăm for the digit 5
    ("Chuyến bay VN-215 khởi hành lúc 6h.",
     "chuyến bay vê en hai một lăm khởi hành lúc sáu giờ."),
    # bare vs "mùng" day, nghìn/ngàn
    ("Ngày 2/9/1945, Chủ tịch Hồ Chí Minh đọc Tuyên ngôn Độc lập tại Hà Nội.",
     "ngày hai tháng chín một ngàn chín trăm bốn mươi lăm chủ tịch hồ chí minh "
     "đọc tuyên ngôn độc lập tại hà nội."),
    # acronym read with Vietnamese letter names instead of translated
    ("Tỷ giá USD/VND đang ở mức cao.", "tỷ giá u ét đê trên vê en đê đang ở mức cao."),
    # roman-numeral quarter spoken, adjacent number left as digits
    ("Doanh thu quý I đạt 1.250 tỷ đồng, tăng 12,7% so với cùng kỳ năm trước.",
     "doanh thu quý một đạt 1.250 tỷ đồng tăng mười hai phẩy bảy phần trăm "
     "so với cùng kỳ năm trước."),
    # every span left in written form == the source text
    (_TP_HCM, _TP_HCM),
]

# (text, transcript, why) that MUST still cost WER — real mispronunciations.
DEFECTS = [
    (_TP_HCM,
     "hà nội thành phố hồ chí minh và đà nẵng chiếm khoảng ba mươi lăm phần trăm gdp "
     "cả nước nhưng chỉ có mười hai phần trăm diện tích cây xanh trên đầu người đạt "
     "chuẩn theo báo cáo được công bố ngày mười tám tháng không bốn vừa qua.",
     "voiced the leading zero of 18/04"),
    ("Giá vàng hôm nay là 92.000.000 đồng một lượng.",
     "giá vàng hôm nay là chín mươi hai nghìn nghìn đồng một lượng.",
     "magnitude collapse: 'nghìn nghìn' instead of 'triệu'"),
    ("Mã đơn hàng của bạn là AB-1234; vui lòng giữ lại để tra cứu khi cần.",
     "mã đơn hàng của bạn là ab một hai ba bê bốn vui lòng giữ lại để trả cứu khi cần.",
     "stray letter re-emitted before the final digit"),
    ("WHO vừa đưa ra khuyến cáo mới.",
     "bách thách hắc ô vừa đưa ra khuyến cáo mới.",
     "acronym garbled"),
    # The zero-padded numeral must NOT be an accepted half-spoken reading:
    # "18 tháng 04" is what whisper-large-v3 writes for BOTH "tháng tư" and the
    # defective "tháng không tư", so admitting it would excuse the defect above.
    (_TP_HCM,
     "hà nội thành phố hồ chí minh và đà nẵng chiếm khoảng 35% gdp cả nước nhưng chỉ "
     "có 12% diện tích cây xanh trên đầu người đạt chuẩn theo báo cáo được công bố "
     "ngày 18 tháng 04 vừa qua.",
     "zero-padded month is ambiguous with the voiced-leading-zero defect"),
    ("Tôi sống ở Hà Nội.", "tôi ở hà nội.", "dropped a word"),
    ("Hôm nay trời đẹp quá.", "hôm nay trời xấu quá.", "wrong word"),
    # Tone-only pairs are MISPRONUNCIATIONS, never spelling variants. Vietnamese
    # tone is phonemic, so admitting one of these would blind the benchmark to
    # the most common way a TTS model gets a Vietnamese word wrong.
    ("Chương trình khuyến mãi áp dụng từ 0h ngày 20/11 đến 23h59 ngày 30/11, giảm tới "
     "50% cho đơn hàng trên 1.000.000 đồng, và tặng thêm 10% cho khách thanh toán "
     "bằng thẻ tín dụng.",
     "chương trình khuyến mại áp dụng từ 0h ngày 20 tháng 11 đến 23h59 ngày 30 tháng 11 "
     "giảm tới 50% cho đơn hàng trên 1.000.000 đồng và tặng thêm 10% cho khách thanh "
     "toán bằng thẻ tín dụng.",
     "tone error: khuyến mãi (ngã) -> khuyến mại (nặng)"),
    ("Trưa nay mình order pizza về công ty ăn cho nhanh, khỏi phải xuống dưới sảnh "
     "xếp hàng.",
     "trưa nay mình order pizza về công ty ăn cho nhanh khỏi phải xuống dưới sành "
     "xếp hàng.",
     "tone error: sảnh (hỏi) -> sành (ngang)"),
]


@pytest.mark.parametrize("text,hyp", ARTIFACTS)
def test_format_artifacts_score_zero(text, hyp):
    wer, ref = best_wer(hyp, text)
    assert wer == 0.0, f"format artifact charged {wer:.3f} WER; best reference was {ref!r}"


@pytest.mark.parametrize("text,hyp,why", DEFECTS)
def test_real_defects_still_cost(text, hyp, why):
    wer, _ = best_wer(hyp, text)
    assert wer > 0.0, f"real defect ({why}) scored 0.00 — reference set is too loose"


def test_source_text_is_always_a_reference():
    """Index 0 of every span is the verbatim written form, so the unmodified
    text must round-trip to 0.00 for every benchmark item."""
    import json
    meta = Path(__file__).resolve().parent.parent / "metadata.jsonl"
    if not meta.exists():
        pytest.skip("benchmark not built locally")
    for line in meta.read_text(encoding="utf-8").splitlines():
        text = json.loads(line)["text"]
        assert best_wer(text, text)[0] == 0.0, text


def test_curated_normalization_is_admitted():
    """text_normalized must be reachable from the span expansion, otherwise the
    hand-curated spoken form and the generated variants disagree."""
    import json
    meta = Path(__file__).resolve().parent.parent / "metadata.jsonl"
    if not meta.exists():
        pytest.skip("benchmark not built locally")
    bad = []
    for line in meta.read_text(encoding="utf-8").splitlines():
        row = json.loads(line)
        if not row.get("has_normalization"):
            continue
        wer, _ = best_wer(row["text_normalized"], row["text"])
        if wer > 0.0:
            bad.append((round(wer, 3), row["text"][:60]))
    assert not bad, f"curated normalization not covered by SPANS: {bad}"


@pytest.mark.parametrize("n,expected", [
    (5, "năm"), (15, "mười lăm"), (21, "hai mươi mốt"), (24, "hai mươi tư"),
    (1945, "một nghìn chín trăm bốn mươi lăm"), (2025, "hai nghìn không trăm hai mươi lăm"),
    (92_000_000, "chín mươi hai triệu"), (1_100_000, "một triệu một trăm nghìn"),
    (5_310_000, "năm triệu ba trăm mười nghìn"), (1_250, "một nghìn hai trăm năm mươi"),
    (350_000, "ba trăm năm mươi nghìn"), (105, "một trăm lẻ năm"),
])
def test_vi_int_produces_the_standard_reading(n, expected):
    assert expected in vi_int(n), f"{n} -> {vi_int(n)}"


def test_variant_count_stays_bounded():
    """Guards against a span edit blowing the cross-product up."""
    assert n_variants(_TP_HCM) < 50_000
    assert len(expand("Tôi dùng ChatGPT mỗi ngày.")) == 7