NaiveText 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c77da3eeff67ccae563debe023d1b7381b270098
-  data.tar.gz: 818c857fbb2366d14bc599e2a074eead39d840b7
+  metadata.gz: 99c7ed0d2ea0ab00ce13e284e537474e1bd48b5a
+  data.tar.gz: 1feb4b6118ccfde5c54daca91c1386fbdcfe8e1b
 SHA512:
-  metadata.gz: ebf2a4a647463099cc87d1ce3266765a4fcb2f6a770a604ca5293755851ac43dc938d13bc000f7604ee7892ca9974a36659985f433b5e1c29adf5494d36b1c70
-  data.tar.gz: 48f1e633ff228d192dfad74bc8f0c1cb4ada96fdac94a1979ef491d63613ab6b484f30079b2256d5c178b398b1d16b9779231b6ccfa33343b6404b20f7d2ea7f
+  metadata.gz: 810c0f40cdd3852010a8bdbc831c6b8591ea47ddb0ea7154e64899c682cbbf875a7b17b4d0676a809a080f14f9d69810cbe4798c2540b57c2ae0851224458365
+  data.tar.gz: a28bd4c31239537888d85cca8020ceca2506886a0e4d6bf6f57e78ed383e89bf5adebfebf56bdeda39649c4b5dfd01e8f43d6833101659c6cbc06921a0cd6480

data/CHANGELOG.md

@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+-Fixed a typo in the interface of TextClassifier propabilities --> probabilities. Deprecated the old version. 
 
 ## [0.4.1] - 2015-10-29
 ### Added

data/README.md

@@ -2,8 +2,8 @@
 
 NaiveText is a text classifier gem written in ruby and made to be easily integratable in your Rails app.
 
-1. What does it do?
-----
+## What is it good for?
+
 Text classifier are used in many areas of IT. The filter spam, predict what a user wants to buy, detect which language a text is written in, ...
 
 The kind of classifier included in NaiveText, uses existing text examples (junk-makrde e-mails, allready bought products, texts in different languages, ...) to calculate in which category (spam/e-mail, interesting_product/not_interesting_product, ...) a unknown text belongs.
@@ -35,13 +35,10 @@ You can also use local files as examples (via ExamplesFactory.from_files('path/t
 
 Lets pretend you write some kind of forum. A user can write posts and can vote them up or down.
 
-
 We will build a system which predicts if a new post is interesting to the user or if this post will bore him a sleep.
 
 In your system (an rails app of course) you haven a *Post* model with a text attribute containing the posts content. There are also two scopes on Post: *up_voted* and *down_voted*, which return all up/down voted posts.
 
-
-
 ```ruby
 require 'NaiveText'
 

data/lib/NaiveText.rb

@@ -2,8 +2,8 @@ require "NaiveText/version"
 require "NaiveText/Example"
 require "NaiveText/ExamplesFactory"
 require "NaiveText/ExamplesGroup"
-require "NaiveText/PropabilityCollection"
-require "NaiveText/PropabilityCalculator"
+require "NaiveText/ProbabilityCollection"
+require "NaiveText/ProbabilityCalculator"
 require "NaiveText/TextClassifier"
 require "NaiveText/Category"
 require "NaiveText/Categories"

data/lib/NaiveText/{PropabilityCalculator.rb → ProbabilityCalculator.rb}

@@ -1,13 +1,13 @@
-class PropabilityCalculator
+class ProbabilityCalculator
   def initialize(args)
     @categories = args[:categories] || []
-    @propabilities = PropabilityCollection.new(categories: @categories)
+    @probabilities = ProbabilityCollection.new(categories: @categories)
   end
 
-  def get_propabilities_for(text)
+  def get_probabilities_for(text)
     calculateProbabilities(text)
-    normalize unless @propabilities.sum <= 0
-    @propabilities
+    normalize unless @probabilities.sum <= 0
+    @probabilities
   end
 
 
@@ -21,30 +21,30 @@ class PropabilityCalculator
     end
 
     def calculateProbabilities(text)
-      set_apriori_propabilities
+      set_apriori_probabilities
       list_of_words = text.split(/\W+/)
       list_of_words.each do |word|
         @categories.each do |category|
-          @propabilities.multiply(category: category, factor: protect_factor(category.p(word)) )
+          @probabilities.multiply(category: category, factor: protect_factor(category.p(word)) )
         end
       end
       remove_minimum(text)
     end
 
-    def set_apriori_propabilities
+    def set_apriori_probabilities
       @categories.each do |category|
-        @propabilities.set(category: category, value: p_apriori(category))
+        @probabilities.set(category: category, value: p_apriori(category))
       end
     end
 
     def remove_minimum(text)
       times = text.split(/\W+/).length
-      @propabilities.greater_then(minimum**times)
+      @probabilities.greater_then(minimum**times)
     end
 
     def normalize
-      normalization_factor = 1.to_f / @propabilities.sum
-      @propabilities.multiply(factor: normalization_factor)
+      normalization_factor = 1.to_f / @probabilities.sum
+      @probabilities.multiply(factor: normalization_factor)
     end
 
     def p_apriori(category)

data/lib/NaiveText/{PropabilityCollection.rb → ProbabilityCollection.rb}

@@ -1,35 +1,35 @@
-class PropabilityCollection
+class ProbabilityCollection
   def initialize(args)
     @categories  =  args[:categories] || []
     initialize_ids
-    @propabilities = []
-    initalize_propabilities(@ids)
+    @probabilities = []
+    initalize_probabilities(@ids)
   end
 
   def find(category)
-    return @propabilities[category.id]
+    return @probabilities[category.id]
   end
 
 
   def set(args)
     category  = args[:category]
     value = args[:value]
-   @propabilities[category.id] = value
+   @probabilities[category.id] = value
   end
 
   def multiply(args)
     category = args[:category]
     factor = args[:factor]
     if category
-      @propabilities[category.id] *= factor
+      @probabilities[category.id] *= factor
     else
-      @propabilities.map! {|el| el*factor}
+      @probabilities.map! {|el| el*factor}
     end
   end
 
   def category_with_max
-    if @propabilities.max > 0
-      id = @propabilities.find_index(@propabilities.max)
+    if @probabilities.max > 0
+      id = @probabilities.find_index(@probabilities.max)
       @categories.find {|category| category.id == id}
     else
       NullCategory.new
@@ -37,11 +37,11 @@ class PropabilityCollection
   end
 
   def max
-    @propabilities.max
+    @probabilities.max
   end
 
   def greater_then(value)
-    @propabilities.map! do |p|
+    @probabilities.map! do |p|
        if p > value
          p
        else
@@ -51,7 +51,7 @@ class PropabilityCollection
   end
 
   def sum
-    @propabilities.reduce(:+)
+    @probabilities.reduce(:+)
   end
 
   def to_s
@@ -70,9 +70,9 @@ class PropabilityCollection
     @ids =  @categories.map { |category| category.id }
   end
 
-  def initalize_propabilities(ids)
+  def initalize_probabilities(ids)
     ids.max.times do
-      @propabilities << 0
+      @probabilities << 0
     end
   end
 end

data/lib/NaiveText/TextClassifier.rb

@@ -2,20 +2,25 @@ class TextClassifier
   attr_reader :categories
   def initialize( args )
     @categories = args[:categories]
-    @calculator = args[:calculator] || PropabilityCalculator.new(categories: @categories)
+    @calculator = args[:calculator] || ProbabilityCalculator.new(categories: @categories)
   end
 
   def classify(text)
     get_category_for(text)
   end
 
+  def probabilities(text)
+    @calculator.get_probabilities_for(text)
+  end
+
   def propabilities(text)
-    @calculator.get_propabilities_for(text)
+    puts "This notation is deprecated in will be removed in later versions. Please use probabilities (4th character b instead of p)"
+    probabilities(text)
   end
 
 private
   def get_category_for(text)
-    propabilities = @calculator.get_propabilities_for(text)
-    propabilities.category_with_max
+    probabilities = @calculator.get_probabilities_for(text)
+    probabilities.category_with_max
   end
 end

data/lib/NaiveText/version.rb

@@ -1,3 +1,3 @@
 module NaiveText
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: NaiveText
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - RicciFlowing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,8 +107,8 @@ files:
 - lib/NaiveText/Example.rb
 - lib/NaiveText/ExamplesFactory.rb
 - lib/NaiveText/ExamplesGroup.rb
-- lib/NaiveText/PropabilityCalculator.rb
-- lib/NaiveText/PropabilityCollection.rb
+- lib/NaiveText/ProbabilityCalculator.rb
+- lib/NaiveText/ProbabilityCollection.rb
 - lib/NaiveText/TextClassifier.rb
 - lib/NaiveText/version.rb
 homepage: https://github.com/RicciFlowing/NaiveText