reclassifier 0.4.6 → 0.4.7

data/lib/reclassifier/bayes.rb

@@ -3,7 +3,7 @@
 #
 # Implementation is translated from
 # <em>Introduction to Information Retrieval</em> by Christopher D. Manning,
-# Prabhakar Raghavan and Hinrich Schütze, # Cambridge University Press. 2008,
+# Prabhakar Raghavan and Hinrich Schütze, Cambridge University Press. 2008,
 # ISBN 0521865719.
 #
 # Derived quantities are cached to improve performance of repeated #classify calls.
@@ -19,6 +19,7 @@ class Reclassifier::Bayes
   # * :clean - If false, punctuation will be included in the classifier.  Otherwise, punctuation will be omitted.  Default is true.
   #
   #      b = Reclassifier::Bayes.new([:interesting, :uninteresting, :spam], :clean => true)
+  #
   def initialize(classifications = [], options = {})
     @classifications = {}
     @docs_in_classification_count = {}
@@ -29,10 +30,11 @@ class Reclassifier::Bayes
 
   #
   # Provides a general training method for all classifications specified in Bayes#new
-  # For example:
-  #     b = Reclassifier::Bayes.new :this, :that
-  #     b.train :this, "This text"
-  #     b.train :that, "That text"
+  #
+  #     b = Reclassifier::Bayes.new([:this, :that])
+  #     b.train(:this, "This text")
+  #     b.train(:that, "That text")
+  #
   def train(classification, text)
     ensure_classification_exists(classification)
 
@@ -49,10 +51,10 @@ class Reclassifier::Bayes
   # Untrain a (classification, text) pair.
   # Be very careful with this method.
   #
-  # For example:
-  #     b = Reclassifier::Bayes.new :this, :that, :the_other
-  #     b.train :this, "This text"
-  #     b.untrain :this, "This text"
+  #     b = Reclassifier::Bayes.new([:this, :that])
+  #     b.train(:this, "This text")
+  #     b.untrain(:this, "This text")
+  #
   def untrain(classification, text)
     ensure_classification_exists(classification)
 
@@ -63,11 +65,13 @@ class Reclassifier::Bayes
     end
   end
 
+  # Returns the scores of the specified text for each classification.
   #
-  # Returns the scores of the specified text for each classification. E.g.,
-  #    b.classifications "I hate bad words and you"
+  #    b.calculate_scores("I hate bad words and you")
   #    =>  {"Uninteresting"=>-12.6997928013932, "Interesting"=>-18.4206807439524}
+  #
   # The largest of these scores (the one closest to 0) is the one picked out by #classify
+  #
   def calculate_scores(text)
     scores = {}
 
@@ -93,30 +97,31 @@ class Reclassifier::Bayes
     scores
   end
 
-  #
   # Returns the classification of the specified text, which is one of the
-  # classifications given in the initializer. E.g.,
-  #    b.classify "I hate bad words and you"
+  # classifications given in the initializer.
+  #
+  #    b.classify("I hate bad words and you")
   #    =>  :uninteresting
+  #
   def classify(text)
     calculate_scores(text).max_by {|classification| classification[1]}[0]
   end
 
-  #
   # Provides a list of classification names
-  # For example:
+  #
   #     b.classifications
   #     =>   [:this, :that, :the_other]
+  #
   def classifications
     @classifications.keys
   end
 
-  #
   # Adds the classification to the classifier.
   # Has no effect if the classification already existed.
   # Returns the classification.
-  # For example:
+  #
   #     b.add_classification(:not_spam)
+  #
   def add_classification(classification)
     @classifications[classification] ||= {}
 
@@ -128,8 +133,9 @@ class Reclassifier::Bayes
   #
   # Removes the classification from the classifier.
   # Returns the classifier if the classification existed, else nil.
-  # For example:
+  #
   #     b.remove_classification(:not_spam)
+  #
   def remove_classification(classification)
     return_value = if @classifications.include?(classification)
                      classification
@@ -183,6 +189,7 @@ class Reclassifier::Bayes
   end
 
   private
+
     def update_doc_count(classification, value)
       @docs_in_classification_count[classification] += value
 

data/lib/reclassifier/version.rb

@@ -1,3 +1,3 @@
 module Reclassifier
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reclassifier
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
   prerelease: 
 platform: ruby
 authors: