README.md in bow_tfidf-0.1.0 vs README.md in bow_tfidf-0.1.1
- old
+ new
@@ -34,15 +34,41 @@
## Usage
First of all bag of words with computed tfidf for each word should be created. For this add labeled words as a hash to bag of words:
```ruby
-bow = Tfidf::BagOfWords.new
+bow = BowTfidf::BagOfWords.new
bow.add_labeled_data!({
category1: ['word', 'word1'],
category2: ['word', 'word2']
category3: ['word', 'word2', 'word3']
})
+```
+Instance of `BowTfidf::BagOfWords` responds to `words` and `categories` methods:
+```ruby
+bow.words
+#{
+# 'word1' => {
+# categories: {
+# 1 => {
+# tf: 0.3010299956639812,
+# tfidf: 0.14362780923945326
+# }
+# },
+# idf: 0.47712125471966244
+# },
+# ...
+#}
+
+bow.categories
+#{
+# category1: {
+# id: 1,
+# key: :category1,
+# words: Set['word', 'word1']
+# },
+# ...
+#}
```
To identify category of text pass array of words as argument to category classifier:
```ruby
classifier = BowTfidf::Classifier.new(bow)