libgrammstein 0.1.0

Hybrid language model (N-gram + Embeddings) for WFST text correction
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
//! Query command implementations.

use std::path::Path;

use console::style;

use crate::cli::args::{QueryCommands, QueryCompletionsArgs, QueryScoreArgs, QuerySimilarArgs};
use crate::cli::error::{CliError, CliResult};
use crate::cli::output;

/// Run the query command.
pub fn run(cmd: QueryCommands, verbose: bool) -> CliResult<()> {
    match cmd {
        QueryCommands::Score(args) => query_score(args, verbose),
        QueryCommands::Similar(args) => query_similar(args, verbose),
        QueryCommands::Completions(args) => query_completions(args, verbose),
    }
}

/// Trait for models that can score sequences.
trait ScoringModel {
    /// Compute log probability for a sentence (list of tokens).
    fn sentence_log_prob(&self, tokens: &[&str]) -> f64;

    /// Compute log probability of a word given context.
    fn log_prob(&self, word: &str, context: &[&str]) -> f64;

    /// Get model description.
    fn description(&self) -> String;
}

/// N-gram model wrapper for scoring.
struct NgramScoringModel {
    model: crate::ngram::NgramModel<
        liblevenshtein::dictionary::dynamic_dawg_char::DynamicDawgChar<crate::ngram::NgramEntry>,
    >,
}

impl ScoringModel for NgramScoringModel {
    fn sentence_log_prob(&self, tokens: &[&str]) -> f64 {
        self.model.sentence_log_prob(tokens)
    }

    fn log_prob(&self, word: &str, context: &[&str]) -> f64 {
        self.model.log_prob(word, context)
    }

    fn description(&self) -> String {
        format!(
            "N-gram (order={}, vocab={})",
            self.model.order(),
            self.model.vocab_size()
        )
    }
}

/// Hybrid model wrapper for scoring.
struct HybridScoringModel {
    model: crate::hybrid::HybridLanguageModel<
        liblevenshtein::dictionary::dynamic_dawg_char::DynamicDawgChar<crate::ngram::NgramEntry>,
    >,
}

impl ScoringModel for HybridScoringModel {
    fn sentence_log_prob(&self, tokens: &[&str]) -> f64 {
        self.model.sentence_log_prob(tokens)
    }

    fn log_prob(&self, word: &str, context: &[&str]) -> f64 {
        // HybridLanguageModel uses `score` instead of `log_prob`
        self.model.score(word, context)
    }

    fn description(&self) -> String {
        format!(
            "Hybrid (order={}, ngram_vocab={}, emb_vocab={})",
            self.model.ngram_model().order(),
            self.model.ngram_model().vocab_size(),
            self.model.embedding_model().vocab_size()
        )
    }
}

/// Load a model for scoring.
fn load_model_for_scoring(path: &Path) -> CliResult<Box<dyn ScoringModel>> {
    use crate::hybrid::HybridLanguageModel;
    use crate::ngram::NgramModel;
    use liblevenshtein::dictionary::dynamic_dawg_char::DynamicDawgChar;

    // Try to load as hybrid model first (more complex)
    if let Ok(model) = HybridLanguageModel::load_portable(path, DynamicDawgChar::new) {
        return Ok(Box::new(HybridScoringModel { model }));
    }

    // Try to load as N-gram model
    if let Ok(model) = NgramModel::load_portable(path, DynamicDawgChar::new) {
        return Ok(Box::new(NgramScoringModel { model }));
    }

    Err(CliError::model_load(
        path.to_path_buf(),
        "Failed to load model (unknown format or corrupted file)".to_string(),
    ))
}

/// Trait for models that can find similar words.
trait SimilarityModel {
    /// Find most similar words to a query word.
    fn most_similar(&self, word: &str, k: usize) -> Vec<(String, f32)>;

    /// Check if word is in vocabulary.
    fn contains(&self, word: &str) -> bool;

    /// Get model description.
    fn description(&self) -> String;
}

/// Embedding model wrapper for similarity.
struct EmbeddingSimilarityModel {
    model: crate::embedding::SubwordEmbedding,
}

impl SimilarityModel for EmbeddingSimilarityModel {
    fn most_similar(&self, word: &str, k: usize) -> Vec<(String, f32)> {
        self.model.most_similar(word, k)
    }

    fn contains(&self, word: &str) -> bool {
        self.model.contains(word)
    }

    fn description(&self) -> String {
        format!(
            "Embedding (dim={}, vocab={})",
            self.model.dim(),
            self.model.vocab_size()
        )
    }
}

/// Hybrid model wrapper for similarity (uses embedding component).
struct HybridSimilarityModel {
    model: crate::hybrid::HybridLanguageModel<
        liblevenshtein::dictionary::dynamic_dawg_char::DynamicDawgChar<crate::ngram::NgramEntry>,
    >,
}

impl SimilarityModel for HybridSimilarityModel {
    fn most_similar(&self, word: &str, k: usize) -> Vec<(String, f32)> {
        self.model.embedding_model().most_similar(word, k)
    }

    fn contains(&self, word: &str) -> bool {
        self.model.embedding_model().contains(word)
    }

    fn description(&self) -> String {
        format!(
            "Hybrid embedding (dim={}, vocab={})",
            self.model.embedding_model().dim(),
            self.model.embedding_model().vocab_size()
        )
    }
}

/// Load a model for similarity queries.
fn load_model_for_similarity(path: &Path) -> CliResult<Box<dyn SimilarityModel>> {
    use crate::embedding::SubwordEmbedding;
    use crate::hybrid::HybridLanguageModel;
    use liblevenshtein::dictionary::dynamic_dawg_char::DynamicDawgChar;

    // Try to load as hybrid model first
    if let Ok(model) = HybridLanguageModel::load_portable(path, DynamicDawgChar::new) {
        return Ok(Box::new(HybridSimilarityModel { model }));
    }

    // Try to load as embedding model
    if let Ok(model) = SubwordEmbedding::load(path) {
        return Ok(Box::new(EmbeddingSimilarityModel { model }));
    }

    Err(CliError::model_load(
        path.to_path_buf(),
        "Failed to load model (must be embedding or hybrid model)".to_string(),
    ))
}

/// Trait for models that can provide completions.
trait CompletionModel {
    /// Get top completions for context.
    /// Returns (word, log_probability) pairs sorted by probability.
    fn top_completions(&self, context: &[&str], k: usize) -> Vec<(String, f64)>;

    /// Get model description.
    fn description(&self) -> String;
}

/// Hybrid model wrapper for completions (can iterate vocabulary).
struct HybridCompletionModel {
    model: crate::hybrid::HybridLanguageModel<
        liblevenshtein::dictionary::dynamic_dawg_char::DynamicDawgChar<crate::ngram::NgramEntry>,
    >,
}

impl CompletionModel for HybridCompletionModel {
    fn top_completions(&self, context: &[&str], k: usize) -> Vec<(String, f64)> {
        // Use embedding vocabulary to get candidate words
        let embedding = self.model.embedding_model();
        let vocab_size = embedding.vocab_size();

        // Score each word in vocabulary
        let mut scored: Vec<(String, f64)> = (0..vocab_size)
            .filter_map(|idx| {
                embedding.index_to_word(idx).map(|word| {
                    // HybridLanguageModel uses `score` instead of `log_prob`
                    let log_prob = self.model.score(word, context);
                    (word.to_string(), log_prob)
                })
            })
            .collect();

        // Sort by log probability (descending)
        scored.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));

        // Return top k
        scored.truncate(k);
        scored
    }

    fn description(&self) -> String {
        format!(
            "Hybrid (order={}, ngram_vocab={}, emb_vocab={})",
            self.model.ngram_model().order(),
            self.model.ngram_model().vocab_size(),
            self.model.embedding_model().vocab_size()
        )
    }
}

/// N-gram model wrapper for completions.
/// Note: This is slower because we need to iterate the trie.
struct NgramCompletionModel {
    model: crate::ngram::NgramModel<
        liblevenshtein::dictionary::dynamic_dawg_char::DynamicDawgChar<crate::ngram::NgramEntry>,
    >,
}

impl CompletionModel for NgramCompletionModel {
    fn top_completions(&self, context: &[&str], k: usize) -> Vec<(String, f64)> {
        // Get unique unigrams from the trie
        let mut unigrams: std::collections::HashSet<String> = std::collections::HashSet::new();

        for (key, _) in self.model.trie().iter_entries() {
            // Extract the first/only token from unigram keys (no separator)
            if !key.contains('|') {
                unigrams.insert(key);
            }
        }

        // Score each unigram
        let mut scored: Vec<(String, f64)> = unigrams
            .into_iter()
            .map(|word| {
                let log_prob = self.model.log_prob(&word, context);
                (word, log_prob)
            })
            .collect();

        // Sort by log probability (descending)
        scored.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));

        // Return top k
        scored.truncate(k);
        scored
    }

    fn description(&self) -> String {
        format!(
            "N-gram (order={}, vocab={})",
            self.model.order(),
            self.model.vocab_size()
        )
    }
}

/// Load a model for completion queries.
fn load_model_for_completions(path: &Path) -> CliResult<Box<dyn CompletionModel>> {
    use crate::hybrid::HybridLanguageModel;
    use crate::ngram::NgramModel;
    use liblevenshtein::dictionary::dynamic_dawg_char::DynamicDawgChar;

    // Try to load as hybrid model first (preferred - has vocabulary from embedding)
    if let Ok(model) = HybridLanguageModel::load_portable(path, DynamicDawgChar::new) {
        return Ok(Box::new(HybridCompletionModel { model }));
    }

    // Try to load as N-gram model
    if let Ok(model) = NgramModel::load_portable(path, DynamicDawgChar::new) {
        return Ok(Box::new(NgramCompletionModel { model }));
    }

    Err(CliError::model_load(
        path.to_path_buf(),
        "Failed to load model (unknown format or corrupted file)".to_string(),
    ))
}

/// Score a sentence or continuation.
fn query_score(args: QueryScoreArgs, verbose: bool) -> CliResult<()> {
    if verbose {
        eprintln!("Scoring tokens");
        eprintln!("  Model: {}", args.model.display());
    }

    // Check that model exists
    if !args.model.exists() {
        return Err(CliError::file_not_found(&args.model));
    }

    // Get tokens from args or stdin
    let tokens = if args.tokens.is_empty() {
        // Read from stdin
        let mut input = String::new();
        std::io::stdin()
            .read_line(&mut input)
            .map_err(CliError::Io)?;
        input.split_whitespace().map(String::from).collect()
    } else {
        args.tokens.clone()
    };

    if tokens.is_empty() {
        return Err(CliError::invalid_argument("No tokens provided"));
    }

    // Load model
    let model = load_model_for_scoring(&args.model)?;

    if verbose {
        eprintln!("  Model type: {}", model.description());
    }

    // Convert to &str slice
    let token_refs: Vec<&str> = tokens.iter().map(|s| s.as_str()).collect();

    // Compute score based on mode
    let (log_prob, mode) = if args.continuation {
        // Score last token given preceding context
        if token_refs.len() < 2 {
            return Err(CliError::invalid_argument(
                "Continuation mode requires at least 2 tokens (context + word)",
            ));
        }
        let word = token_refs[token_refs.len() - 1];
        let context = &token_refs[..token_refs.len() - 1];
        (model.log_prob(word, context), "continuation")
    } else {
        // Score as complete sentence
        (model.sentence_log_prob(&token_refs), "sentence")
    };

    // Compute perplexity
    let perplexity = if args.sentence || !args.continuation {
        let n = token_refs.len() as f64;
        (-log_prob / n).exp()
    } else {
        // For continuation, perplexity is just exp(-log_prob)
        (-log_prob).exp()
    };

    if args.json {
        let result = serde_json::json!({
            "tokens": tokens,
            "log_probability": log_prob,
            "perplexity": perplexity,
            "mode": mode
        });
        output::print_json(&result)?;
    } else {
        println!();
        println!("Tokens: {}", style(tokens.join(" ")).cyan());
        println!("Mode:   {}", mode);
        println!();
        println!(
            "Log probability: {}",
            style(format!("{:.4}", log_prob)).green()
        );
        println!(
            "Perplexity:      {}",
            style(format!("{:.2}", perplexity)).green()
        );
    }

    Ok(())
}

/// Find similar words.
fn query_similar(args: QuerySimilarArgs, verbose: bool) -> CliResult<()> {
    if verbose {
        eprintln!("Finding similar words");
        eprintln!("  Model: {}", args.model.display());
        eprintln!("  Word:  {}", args.word);
    }

    // Check that model exists
    if !args.model.exists() {
        return Err(CliError::file_not_found(&args.model));
    }

    // Load model
    let model = load_model_for_similarity(&args.model)?;

    if verbose {
        eprintln!("  Model type: {}", model.description());
    }

    // Check if word is in vocabulary
    let in_vocab = model.contains(&args.word);
    if !in_vocab && verbose {
        eprintln!(
            "  {} Word '{}' not in vocabulary (using subword representation)",
            style("note:").yellow(),
            args.word
        );
    }

    // Find similar words
    let similar: Vec<(String, f64)> = model
        .most_similar(&args.word, args.top)
        .into_iter()
        .map(|(w, s)| (w, s as f64))
        .collect();

    if args.json {
        let result = serde_json::json!({
            "query": args.word,
            "in_vocabulary": in_vocab,
            "similar": similar.iter().map(|(w, s)| {
                serde_json::json!({"word": w, "similarity": s})
            }).collect::<Vec<_>>()
        });
        output::print_json(&result)?;
    } else {
        output::print_similar_words(&args.word, &similar);
    }

    Ok(())
}

/// Get top completions for context.
fn query_completions(args: QueryCompletionsArgs, verbose: bool) -> CliResult<()> {
    if verbose {
        eprintln!("Getting completions");
        eprintln!("  Model:   {}", args.model.display());
        eprintln!("  Context: {}", args.context.join(" "));
    }

    // Check that model exists
    if !args.model.exists() {
        return Err(CliError::file_not_found(&args.model));
    }

    // Load model
    let model = load_model_for_completions(&args.model)?;

    if verbose {
        eprintln!("  Model type: {}", model.description());
        eprintln!("  Computing top {} completions...", args.top);
    }

    // Convert context to &str slice
    let context_refs: Vec<&str> = args.context.iter().map(|s| s.as_str()).collect();

    // Get completions
    let completions = model.top_completions(&context_refs, args.top);

    if args.json {
        let result = serde_json::json!({
            "context": args.context,
            "completions": completions.iter().map(|(w, lp)| {
                serde_json::json!({
                    "word": w,
                    "log_probability": lp,
                    "probability": lp.exp()
                })
            }).collect::<Vec<_>>()
        });
        output::print_json(&result)?;
    } else {
        output::print_completions(&args.context, &completions);
    }

    Ok(())
}