dwarf 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,50 @@
+# Dwarf Classifying
+
+Dwarf provides a decision tree learning tool initially targeting
+classification of Rails 3 ActiveRecord objects. Dwarf is largely
+agnostic of types so long as they implement a few methods.
+
+## Install
+
+    gem install dwarf
+
+This will install dwarf.
+
+## Classifying
+
+Dwarf targets the interactive Rails console for the time being, 
+though there is nothing preventing it from being used in your code as
+well. Suppose you have some records (record1, record2, ... , recordN)
+that you know the classifications of. Instantiate a Classifier, inform
+the instance of the classifications via the add_example method, and
+then call learn!. The classifier will build a decision tree from your
+examples as well as a classify method to classify arbitrary instances
+you hand it. 
+
+Teaching:
+
+    classifier = Dwarf::Classifier.new()
+    classifier.add_example(record1, :good)
+    classifier.add_example(record2, :good)
+    classifier.add_example(record3, :bad)
+    .
+    .
+    .
+    classifier.add_example(recordN, :bad)
+    classifier.learn!
+
+Classifying
+
+    classifier.classify(record1) => :good
+    classifier.classify(unseen_record) => :good
+
+Dwarf will make a best guess attempt to classify records it has not
+seen yet. If the features of a record are not sufficient to classify
+it (e.g. two or more records have the same features, but different
+classifications) Dwarf will always guess the classification it has
+seen most often for that particular feature set.
+
+## Contribute
+
+Fork the dwarf project on github (http://github.com/aredington/dwarf),
+document your changes, and then send a pull request.

data/dwarf.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Alex Redington"]
   s.email       = ["aredington@gmail.com"]
   s.homepage    = "http://github.com/aredington/dwarf"
-  s.summary     = "C4.5 for ActiveRecord objects"
-  s.description = "Dwarf is an implementation of the C4.5 algorithm targeted for use in the Rails 3 console environment for classifying ActiveRecord objects."
+  s.summary     = "Decision tree learning for ActiveRecord objects"
+  s.description = "Dwarf is an implementation of decision tree learning algorithms targeted for use in the Rails 3 console environment for classifying ActiveRecord objects."
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "dwarf"

data/lib/dwarf/version.rb

@@ -1,3 +1,3 @@
 module Dwarf
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Alex Redington
@@ -62,7 +62,7 @@ dependencies:
         version: 2.0.1
   type: :development
   version_requirements: *id003
-description: Dwarf is an implementation of the C4.5 algorithm targeted for use in the Rails 3 console environment for classifying ActiveRecord objects.
+description: Dwarf is an implementation of decision tree learning algorithms targeted for use in the Rails 3 console environment for classifying ActiveRecord objects.
 email: 
 - aredington@gmail.com
 executables: []
@@ -117,6 +117,6 @@ rubyforge_project: dwarf
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: C4.5 for ActiveRecord objects
+summary: Decision tree learning for ActiveRecord objects
 test_files: []