bayes_naive_jdp 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,14 @@
 # BayesNaiveJdp
 
-TODO: Write a gem description
+This is a very simple Naive Bayesian classifier, build just for fun.
+
+I decided to use it as an example while learning to package ruby code.
+
+The algorithm used here is not original, but an adaptation from Burak Kanber's 
+[Machine Learning in Javascript](http://readable.cc/feed/view/34236/burak-kanber-s-blog) series.
+
+	
+
 
 ## Installation
 
@@ -18,12 +26,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Contributing
+	#	create an instance of the Classifier
+	classifier = BayesNaiveJdp::Classifier.new
+	
+	#	Train the Classifier using many samples from each valid category
+	#	documents are strings, categories are strings, symbols, or integers
+	classifier.train(document_a_1, category_a)
+	classifier.train(document_a_2, category_a)
+	classifier.train(document_a_3, category_a)
+	..
+	classifier.train(document_b_1, category_b)
+	classifier.train(document_b_2, category_b)
+	classifier.train(document_b_3, category_b)
+	..
+
+	#	use the classifier to categorize an unknown document
+	results = classifier.classify(mystery_document)
+	category = results[:winner][:classification]
+	confidence = results[:winner][:confidence]
+
+	#	also, results[:all_scores] is a hash 
+	#	with categories as indices and confidence levels as values
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/lib/bayes_naive_jdp/version.rb

@@ -1,3 +1,3 @@
 module BayesNaiveJdp
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_misc.rb

@@ -0,0 +1,40 @@
+require 'pathname'
+require 'test/unit'
+
+dir = Pathname.new File.expand_path(File.dirname(__FILE__))
+require dir + '..' + 'lib' + 'bayes_naive_jdp'
+
+DOCUMENT_PATH = dir + 'documents'
+CONFIDENCE_MIN = 0.98
+
+class MiscTest < Test::Unit::TestCase
+	def test_integer_categories
+		categories = [1, 2, 3]
+		classifier = BayesNaiveJdp::Classifier.new
+		categories.each do |cat|
+			4.times do |i|
+				classifier.train("#{cat} " * i, cat)
+			end
+		end
+
+		categories.each do |cat|
+			answer = classifier.classify("#{cat} " * 5)
+			assert_equal(answer[:winner][:classification], cat)
+		end
+	end
+
+	def test_symbol_categories_
+		categories = [:one, :two, :three]
+		classifier = BayesNaiveJdp::Classifier.new
+		categories.each do |cat|
+			4.times do |i|
+				classifier.train("#{cat.to_s} " * i, cat)
+			end
+		end
+
+		categories.each do |cat|
+			answer = classifier.classify("#{cat.to_s} " * 5)
+			assert_equal(answer[:winner][:classification], cat)
+		end
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bayes_naive_jdp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -77,6 +77,7 @@ files:
 - test/documents/schneier-4
 - test/documents/schneier-5
 - test/test_author_classification.rb
+- test/test_misc.rb
 homepage: ''
 licenses:
 - MIT
@@ -92,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3893581627066365178
+      hash: -4046118477202807926
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -101,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3893581627066365178
+      hash: -4046118477202807926
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -125,3 +126,4 @@ test_files:
 - test/documents/schneier-4
 - test/documents/schneier-5
 - test/test_author_classification.rb
+- test/test_misc.rb