text-utils/n-gram

PHP Helpers to get n-grams

PHP NGram

Generate n-grams for your string., _(*1)

, _(*2)

N-grams?

Why does this project exist? Come on, don't delete this part. Fill it. Yes it's hard, but it's perhaps the most important part of the README., _(*3)

As to why this project exist, it's to serve as a template for future open source PHP projects. Of course, feel free to fork it and make your own recipe., _(*4)

Installation

composer install text-utils/n-gram

Usage

You can start using the n-gram generator by instantiating a new NGram class:, _(*5)

$n = 1;
$generator = new TextUtils\NGram($n, 'Foo');
$nGram = $generator->get(); // array ('F', 'o', 'o')

We also provide a static wrapper (the for method) and two helper functions (bigram and trigram) for quick usage, _(*6)

$nGram = TextUtils\NGram::for('string', 3); // array ('str', 'tri', 'rin', 'ing')
...
$biGram = bigram('foo'); // array ('fo', 'oo')
$triGram = trigram('foobar'); // array ('foo', 'oob', 'oba', 'bar')

Contributing

See the CONTRIBUTING file., _(*7)

License

MIT. Please refer to the LICENSE file in this repository., _(*8)