README.rdoc

December 16, 2009 ยท View on GitHub

= NGram

A simple NGram generator - http://en.wikipedia.org/wiki/N-gram.

== Install

gem sources -a http://gemcutter.org sudo gem install n_gram

== How To Use

A single N-Gram

require 'rubygems' require 'n_gram'

data = ['here is some text', 'here is more text']

n_gram = NGram.new(data, :n => 2)

To see the N-Gram of the collection

ngram.ngrams_of_all_data #=> {2 => {'here is' => 2 etc...}}

To see the N-Grams of individual inputs

If we want the N-Gram of data[0]

ngram.ngrams_of_inputs[0] #=> {2 => {'here is' => 1 etc...}}

Multiple N-Grams

require 'rubygems' require 'n_gram'

data = ['here is some text', 'here is more text']

n_gram = NGram.new(data, :n => [2,3])

To see the N-Gram of the collection

ngram.ngrams_of_all_data #=> {2 => {'here is' => 2 etc...}, 3 => {'here is some' => 1 etc...}}

To see the N-Grams of individual inputs

If we want the N-Gram of data[0]

ngram.ngrams_of_inputs[0] #=> {2 => {'here is' => 1 etc...}, 3 => {'here is some' => 1 etc...}}

== Copyright

Copyright (c) 2009 Red Davis. See LICENSE for details.