#nlp #sentence #statistical #restore #letter #model #casing

bin+lib truecase

Restore correct letter casings in arbitrary text using a statistical model

4 releases (2 breaking)

0.3.1 Sep 29, 2023
0.3.0 Nov 17, 2021
0.2.0 May 12, 2018
0.1.0 Jan 13, 2018

#630 in Machine learning

MIT/Apache

27KB
523 lines

truecase.rs

Latest Version docs

truecase.rs is a simple statistical truecaser written in Rust.

Truecasing is restoration of original letter cases in text: for example, turning all-uppercase, or all-lowercase text into one that has proper sentence casing (capital first letter, capitalized names etc).

This crate attempts to solve this problem by gathering statistics from a set of training sentences, then using those statistics to restore correct casings in broken sentences. It comes with a command-line utility that makes training the statistical model easy.

Quick usage example

use truecase::{Model, ModelTrainer};

// build a statistical model from sample sentences
let mut trainer = ModelTrainer::new();
trainer.add_sentence("There are very few writers as good as Shakespeare");
trainer.add_sentence("You and I will have to disagree about this");
trainer.add_sentence("She never came back from USSR");
let model = trainer.into_model();

// use gathered statistics to restore case in caseless text
let truecased_text = model.truecase("i don't think shakespeare was born in ussr");
assert_eq!(truecased_text, "I don't think Shakespeare was born in USSR");

See documentation for more details.

License

truecase.rs is licensed under the terms of the MIT License or the Apache License 2.0, at your choosing.

Dependencies

~4–6MB
~109K SLoC