rwer 0.1.1

A modern Rust crate for WER, CER, and related ASR evaluation metrics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use clap::Parser;
use rwer::{
    Compose, RemoveMultipleSpaces, RemovePunctuation, Strip, ToLower, Transform, cer,
    process_chars, process_words, visualize_alignment, wer,
};

/// Word Error Rate evaluation tool
#[derive(Parser, Debug)]
#[command(
    name = "rwer",
    version,
    about = "Evaluate WER/CER between reference and hypothesis text"
)]
struct Cli {
    /// Reference text
    reference: Option<String>,

    /// Hypothesis text
    hypothesis: Option<String>,

    /// Use character-level evaluation (CER) instead of word-level (WER)
    #[arg(short, long)]
    character: bool,

    /// Show detailed alignment visualization
    #[arg(short = 'a', long)]
    alignment: bool,

    /// Show all metrics (WER, MER, WIP, WIL)
    #[arg(long)]
    all: bool,

    /// Apply lowercase normalization
    #[arg(short = 'l', long)]
    lowercase: bool,

    /// Remove punctuation before evaluation
    #[arg(short = 'r', long)]
    remove_punctuation: bool,

    /// Use Chinese word segmentation (requires 'chinese-word' feature)
    #[arg(short = 'z', long)]
    #[cfg(feature = "chinese-word")]
    chinese: bool,

    /// Convert to Simplified Chinese before evaluation (requires 'chinese-variant' feature)
    #[arg(short = 's', long)]
    #[cfg(feature = "chinese-variant")]
    simplified: bool,
}

fn build_pipeline(cli: &Cli) -> Option<Box<dyn Transform>> {
    let mut transforms: Vec<Box<dyn Transform>> = Vec::new();

    #[cfg(feature = "chinese-variant")]
    if cli.simplified {
        transforms.push(Box::new(rwer::ToSimplified));
    }

    if cli.lowercase {
        transforms.push(Box::new(Strip));
        transforms.push(Box::new(ToLower));
    }
    if cli.remove_punctuation {
        transforms.push(Box::new(RemovePunctuation));
        transforms.push(Box::new(RemoveMultipleSpaces));
    }

    if transforms.is_empty() {
        None
    } else {
        Some(Box::new(Compose::new(transforms)))
    }
}

fn main() {
    let cli = Cli::parse();

    let ref_text = cli.reference.as_deref().unwrap_or("");
    let hyp_text = cli.hypothesis.as_deref().unwrap_or("");

    let pipeline = build_pipeline(&cli);
    let ref_processed = pipeline
        .as_ref()
        .map(|p| p.transform(ref_text))
        .unwrap_or_else(|| ref_text.to_string());
    let hyp_processed = pipeline
        .as_ref()
        .map(|p| p.transform(hyp_text))
        .unwrap_or_else(|| hyp_text.to_string());

    #[cfg(feature = "chinese-word")]
    let (ref_final, hyp_final) = if cli.chinese && !cli.character {
        let tokenizer = rwer::ChineseTokenizer::new();
        let ref_cut = tokenizer.cut(&ref_processed);
        let hyp_cut = tokenizer.cut(&hyp_processed);
        let ref_words: Vec<&str> = ref_cut.iter().map(String::as_str).collect();
        let hyp_words: Vec<&str> = hyp_cut.iter().map(String::as_str).collect();
        (ref_words.join(" "), hyp_words.join(" "))
    } else {
        (ref_processed, hyp_processed)
    };
    #[cfg(not(feature = "chinese-word"))]
    let (ref_final, hyp_final) = (ref_processed, hyp_processed);

    if cli.character {
        if cli.all || cli.alignment {
            let output = process_chars(&ref_final, &hyp_final);
            println!("{output}");
            if cli.alignment {
                println!("{}", visualize_alignment(&output));
            }
        } else {
            println!("{:.4}", cer(&ref_final, &hyp_final));
        }
    } else if cli.all || cli.alignment {
        let output = process_words(&ref_final, &hyp_final);
        println!("{output}");
        if cli.alignment {
            println!("{}", visualize_alignment(&output));
        }
    } else {
        println!("{:.4}", wer(&ref_final, &hyp_final));
    }
}