MCPcopy Index your code
hub / github.com/djc/instant-segment

github.com/djc/instant-segment @0.11.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release 0.11.1 ↗ · + Follow
52 symbols 115 edges 10 files 15 documented · 29%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Cover logo

Instant Segment: fast English word segmentation in Rust

Documentation Crates.io PyPI Build status License: Apache 2.0

Instant Segment is a fast Apache-2.0 library for English word segmentation. It is based on the Python wordsegment project written by Grant Jenks, 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).

For the microbenchmark included in this repository, Instant Segment is ~500x faster than the Python implementation. The API was carefully constructed so that multiple segmentations can share the underlying state to allow parallel usage.

How it works

Instant Segment works by segmenting a string into words by selecting the splits with the highest probability given a corpus of words and their occurrences.

For instance, provided that choose and spain occur more frequently than chooses and pain, and that the pair choose spain occurs more frequently than chooses pain, Instant Segment can help identify the domain choosespain.com as ChooseSpain.com which more likely matches user intent.

Read about how we built and improved Instant Segment for use in production at Instant Domain Search to help our users find relevant domains they can register.

Using the library

Python (>= 3.9)

pip install instant-segment

Rust

[dependencies]
instant-segment = "0.8.1"

Examples

The following examples expect unigrams and bigrams to exist. See the examples (Rust, Python) to see how to construct these objects.

import instant_segment

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

--> ['instant', 'domain', 'search']
use instant_segment::{Search, Segmenter};
use std::collections::HashMap;

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

--> ["instant", "domain", "search"]

Check out the tests for more thorough examples: Rust, Python

Testing

To run the tests run the following:

cargo t -p instant-segment --all-features

You can also test the Python bindings with:

make test-python

Core symbols most depended-on inside this repo

next
called by 9
instant-segment/src/lib.rs
segment
called by 7
instant-segment/src/lib.rs
clear
called by 6
instant-segment/src/lib.rs
get
called by 5
instant-segment/src/lib.rs
score
called by 4
instant-segment/src/lib.rs
len
called by 4
instant-segment/src/lib.rs
normalize
called by 3
instant-segment/examples/merge.rs
download
called by 2
data/grab.py

Shape

Function 24
Method 19
Class 9

Languages

Rust87%
Python13%

Modules by API surface

instant-segment/src/lib.rs20 symbols
instant-segment-py/src/lib.rs10 symbols
instant-segment/examples/merge.rs5 symbols
instant-segment/src/test_data.rs3 symbols
instant-segment/src/test_cases.rs3 symbols
instant-segment/benches/bench.rs3 symbols
instant-segment-py/test/test.py3 symbols
data/grab.py3 symbols
instant-segment/examples/contrived.rs1 symbols
instant-segment-py/examples/contrived.py1 symbols

For agents

$ claude mcp add instant-segment \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact