Fast English word segmentation in Rust
Go to file
Nicholas Rempel be2e1ad72f Add brief examples 2021-04-22 13:41:03 -07:00
.cargo py: initial version of Python bindings 2021-03-24 11:57:29 +01:00
.github/workflows Tweak CI to avoid testing bindings for now 2021-03-24 11:57:29 +01:00
data Initial version 2020-05-26 20:07:00 +02:00
instant-segment Bump version number to 0.8.1 2021-04-22 15:08:23 +02:00
instant-segment-py Rename sentence_score() to score_sentence() 2021-04-22 15:04:48 +02:00
.gitignore py: initial version of Python bindings 2021-03-24 11:57:29 +01:00
Cargo.toml py: initial version of Python bindings 2021-03-24 11:57:29 +01:00
Makefile py: initial version of Python bindings 2021-03-24 11:57:29 +01:00
README.md Add brief examples 2021-04-22 13:41:03 -07:00
cover.svg Add files via upload 2021-04-20 11:06:47 -07:00
deny.toml Allow MPL licenses 2020-11-25 17:34:03 +01:00

README.md

Cover logo

Instant Segment: fast English word segmentation in Rust

Documentation Crates.io Build status License: Apache 2.0

Partial examples

In Python

segmenter = instant_segment.Segmenter(unigrams(), bigrams())
search = instant_segment.Search()
segmenter.segment("instantdomainsearch", search)
print([word for word in search])
> ['instant', 'domain', 'search']

In Rust

let segmenter = segmenter();
let mut search = Search::default();
let words = segmenter
    .segment("instantdomainsearch", &mut search)
    .unwrap();
println!("{:?}", words.collect::<Vec<&str>>())

Instant Segment is a fast Apache-2.0 library for English word segmentation. It is based on the Python wordsegment project written by Grant Jenkins, which is in turn based on code from Peter Norvig's chapter Natural Language Corpus Data from the book Beautiful Data (Segaran and Hammerbacher, 2009).

The data files in this repository are derived from the Google Web Trillion Word Corpus, as described by Thorsten Brants and Alex Franz, and distributed by the Linguistic Data Consortium. Note that this data "may only be used for linguistic education and research", so for any other usage you should acquire a different data set.

For the microbenchmark included in this repository, Instant Segment is ~17x faster than the Python implementation. Further optimizations are planned -- see the issues. The API has been carefully constructed so that multiple segmentations can share the underlying state to allow parallel usage.