cabalist 0.0.3 → 0.0.4

data/lib/cabalist/railtie.rb

@@ -2,13 +2,23 @@ require 'rails'
 require 'active_record'
 
 module Cabalist
+  
+  # This is the link between Rails application and the Cabalist gem
+  #
+  # This Railtie extends ActiveRecord::Base with Cabalist::ModelAdditions
+  # once ActiveRecord is loaded. It also adds relevant Rake tasks to the
+  # application which provide CLI to the Cabalist functionality.
   class Railtie < ::Rails::Railtie
 
-    initializer 'cabalist.model_additions', do
+    initializer 'cabalist.model_additions' do
       ActiveSupport.on_load :active_record do
         extend ModelAdditions
       end
     end
+    
+    rake_tasks do
+      load 'tasks/retrain.rake'
+    end
 
   end
 end

data/lib/cabalist/version.rb

@@ -1,3 +1,6 @@
 module Cabalist
-  VERSION = "0.0.3"
+  
+  # Version of the gem
+  VERSION = "0.0.4"
+  
 end

data/lib/cabalist/views/classifier.haml

@@ -10,6 +10,9 @@
       %a{ :href => "/cabalist/#{klass.to_s.downcase}/manual" } Manually Classified
     %li
       %a{ :href => "/cabalist/#{klass.to_s.downcase}/auto" } Automatically Classified
+    %li.retrain
+      %form.retrain{ :action => "/cabalist/#{klass.to_s.downcase}/retrain", :method => "POST" }
+        %button.retrain Retrain model
 
   - unless @collection.empty?
     %table.cabalist_records
@@ -52,7 +55,7 @@
                       %span.label_info Use existing class:
                       %select{ :name => 'classification' }
                         %option{ :value    => nil } - choose classification -
-                        - el.class.classifier.data_set.build_domain(-1).to_a.each do |opt|
+                        - el.class.class_variable_domain.to_a.each do |opt|
                           %option{ :value    => opt.to_s, 
                                    :selected => (el.get_class_variable == opt) }= opt
                       %p
@@ -68,7 +71,6 @@
                         :src   => '/images/target_12x12.png', 
                         :title => "Autoclassify (#{el.classify.to_s})" }/
               
-            
     %table.kaminari_nav
       %tr
         %td.previous

data/lib/cabalist/views/index.haml

@@ -2,20 +2,25 @@
 
   %h1 Dashboard
 
-  %ul.classifiers
+  .classifiers
     - @classes.each do |klass|
-      %li
-        %ul.specs
-          %lh
-            = klass.to_s
-            classifier
-          %li
-            Classifies the
-            %span.attr_name= klass.classifier.data_set.data_labels[-1]
-            attribute
-          %li
-            = klass.classifier.data_set.data_items.length 
-            data points
-          %li
-            Signals:
-            %span.attr_name= klass.classifier.data_set.data_labels[0...-1].join(', ')
+      .classifier
+        %h3.header= "#{klass.to_s} classifier"
+        .classifier_content
+          %ul.specs
+            %li
+              Classifies the
+              %span.attr_name= klass::get_class_variable_name.to_s
+              attribute
+            %li
+              Features selected:
+              %span.attr_name= klass::get_feature_names.join(', ')
+            %li
+              Trained based on
+              = klass::classifier.data_set.data_items.length 
+              data points from among
+              = klass::count
+              total records of the #{klass.to_s} class
+          .charts
+            = piechart_by_class_variable(klass)
+            = piechart_by_scope(klass)

data/lib/generators/cabalist/classifier/classifier_generator.rb

@@ -1,4 +1,10 @@
 module Cabalist
+  
+  # A Rails-specific generator which enables a class to use Cabalist methods.
+  # 
+  # This generator creates a migration to add autoclassified_at attribute
+  # to a chosen ActiveRecord model. It also prompts the user whether the
+  # resulting classifier should be exposed through the GUI.
   class ClassifierGenerator < Rails::Generators::NamedBase
     desc <<-EOF
       This generator creates a migration to add autoclassified_at attribute
@@ -12,15 +18,18 @@ module Cabalist
     source_root File.expand_path('../templates/', __FILE__)
     argument :name, :type => :string
     
+    # Get the next available number for a database migration
     def self.next_migration_number(dirname)
       Time.now.strftime("%Y%m%d%H%M%S")
     end
     
+    # Create a database migration adding autoclassified_at attribute.
     def create_migration
       migration_template("migrations/add_cabalist.rb.erb",
           "db/migrate/add_cabalist_to_#{name.tableize}.rb")
     end
     
+    # Prompt whether to expose the classifier through GUI
     def add_to_gui_if_necessary
       add_to_gui = ''
       until %w(y Y n N).include?(add_to_gui)

data/lib/generators/cabalist/install/install_generator.rb

@@ -1,10 +1,16 @@
 module Cabalist
+  
+  # A Rails-specific generator which installs Cabalist in an application
+  # 
+  # This generator copies Cabalist assets to the application public directory,
+  # creates a relevant initializer in config/initializers and adds a route to
+  # the config/routes.rb, mounting the GUI at /cabalist endpoint.
   class InstallGenerator < Rails::Generators::Base
     desc <<-EOF
       This generator installs the Cabalist initializer and 
       adds the route to Cabalist GUI (Cabalist::Frontend).
       Usage:
-      rails generate cabalist:install <ModelName>
+      rails generate cabalist:install
     EOF
     
     source_root File.expand_path('../templates/', __FILE__)

data/lib/generators/cabalist/install/templates/public/stylesheets/cabalist.css

@@ -194,4 +194,58 @@ form.autoclassify {
 span.label_info {
   display: inline-block;
   width: 130px;
-}
+}
+
+/* Dashboard */
+
+.classifier {
+  border: 1px solid #DDD;
+  margin-bottom: 10px;
+}
+
+.classifier:last-child {
+  margin-bottom: 0px;
+}
+
+.classifier .header {
+  margin: 0px;
+  padding: 3px 8px;
+  border-bottom: 1px solid #ddd;
+  background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(0%, #DEDEDE), color-stop(100%, #CCC));
+  text-shadow: white 0px 1px 1px;
+}
+
+.classifier .classifier_content {
+  padding: 0px 5px 5px;
+}
+
+.specs {
+  list-style-type: none;
+  padding: 0;
+  font-size: 0.8em;
+}
+
+ul.scopes { 
+  position: relative;
+}
+
+li.retrain {
+  position: absolute;
+  right: 10px;
+}
+
+button.retrain {
+  border: 0px none;
+  background: none;
+  font-family: "Helvetica Neue", sans-serif;
+  font-size: 14px;
+  padding: 0;
+  margin: 0;
+  color: #6EB41E;
+  text-shadow: white 0px 1px 1px;
+}
+
+button.retrain:hover {
+  color: white;
+  text-shadow: #888 0px 1px 1px;;
+}

data/lib/tasks/retrain.rake

@@ -0,0 +1,21 @@
+namespace :cabalist do
+  
+  desc 'Retrain a Cabalist model'
+  task :retrain, [:model] => :environment do |t, args|
+    unless args.model
+      puts "Usage: rake cabalist:retrain[<CLASS NAME>]"
+    else
+      begin
+        args.model.constantize.train_model
+      rescue Exception => e
+        puts "Could not retrain the classifier"
+        puts "Possibly the class is not Cabalist-enabled?"
+        puts "Anyway, here is your stack trace:"
+        puts e.backtrace
+      else
+        puts "Classifier retrained successfully"
+      end
+    end
+  end
+  
+end

data/spec/cabalist/model_additions_spec.rb

@@ -57,6 +57,21 @@ describe Cabalist::ModelAdditions do
   it "Should return class variable value domain" do
     Cat::class_variable_domain.should eq [false, true]
   end
+  
+  it "Should return percentage agreement between 0 and 1" do
+    Cat::test_cats
+    Cat::percentage_agreement.should be_between(0, 1)
+  end
+  
+  it "Should return percentage random agreement between 0 and 1" do
+    Cat::test_cats
+    Cat::percentage_random_agreement.should be_between(0, 1)
+  end
+  
+  it "Should return Cohen's kappa between -1 and 1" do
+    Cat::test_cats
+    Cat::cohens_kappa.should be_between(-1, 1)
+  end
   # == END =========================================================== #
   
   # == Test instance methods ========================================= #

data/spec/cabalist/non_cabalist_model_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Cabalist::ModelAdditions do
+  
+  with_model :Dog do
+    
+    table do |t|
+      t.string    :color
+      t.boolean   :evil
+      t.timestamp :autoclassified_at
+    end
+
+    model do
+      extend Cabalist::ModelAdditions
+    end
+
+  end
+  
+  before(:each) do
+    @new_dog = Dog::new(:color => 'white', :evil => false)
+  end
+  
+  # == Test class (static) methods =================================== #
+  it "Should not recognize the 'auto_classified' method" do
+    expect { Dog::auto_classified }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'build_model' method" do
+    expect { Dog::build_model }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'class_variable_domain' method" do
+    expect { Dog::class_variable_domain }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'cohens_kappa' method" do
+    expect { Dog::cohens_kappa }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'get_class_variable_name' method" do
+    expect { Dog::get_class_variable_name }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'get_feature_names' method" do
+    expect { Dog::get_feature_names }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'manually_classified' method" do
+    expect { Dog::manually_classified }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'not_classified' method" do
+    expect { Dog::not_classified }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'percentage_ageement' method" do
+    expect { Dog::percentage_ageement }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'percentage_random_agreement' method" do
+    expect { Dog::percentage_random_agreement }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'train_model' method" do
+    expect { Dog::train_model }.to raise_error NoMethodError
+  end
+  # == END =========================================================== #
+  
+  # == Test instance methods ========================================= #
+  it "Should not recognize the 'classify' method" do
+    expect { @new_dog.classify }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'classify!' method" do
+    expect { @new_dog.classify! }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'get_class_variable' method" do
+    expect { @new_dog.get_class_variable }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'get_features' method" do
+    expect { @new_dog.get_features }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'set_class_variable' method" do
+    expect { @new_dog.set_class_variable(false) }.to raise_error NoMethodError
+  end
+  
+  it "Should not recognize the 'teach' method" do
+    expect { @new_dog.teach(false) }.to raise_error NoMethodError
+  end
+  # == END =========================================================== #
+  
+end

data/spec/spec_helper.rb

@@ -14,6 +14,20 @@ Cabalist.configure do |config|
   config.db_path = '/tmp/cabalist_level.db'
 end
 
+RSpec::Matchers.define :be_between do |low,high|
+  match do |actual|
+    @low, @high = low, high
+    actual.between? low, high
+  end
+  
+  failure_message_for_should do |actual|
+    "expected to be between #{@low} and #{@high}, but was #{actual}"
+  end
+  failure_message_for_should_not do |actual|
+    "expected not to be between #{@low} and #{@high}, but was #{actual}"
+  end
+end
+
 RSpec.configure do |config|
   config.include Rack::Test::Methods
   config.extend  WithModel

metadata

@@ -2,7 +2,7 @@
 name: cabalist
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Marcin Wyszynski
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-25 00:00:00 Z
+date: 2012-04-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ai4r
@@ -35,29 +35,29 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: kaminari
+  name: googlecharts
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.13.0
+        version: 1.6.8
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: leveldb-ruby
+  name: kaminari
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.13.0
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: padrino-helpers
+  name: leveldb-ruby
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -68,7 +68,7 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: padrino-helpers
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -79,7 +79,7 @@ dependencies:
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: sinatra
+  name: rake
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -90,7 +90,7 @@ dependencies:
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: sinatra
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -98,10 +98,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activerecord
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
@@ -112,7 +112,7 @@ dependencies:
   type: :development
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: sqlite3
+  name: rspec
   prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
@@ -123,7 +123,7 @@ dependencies:
   type: :development
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  name: with_model
+  name: sqlite3
   prerelease: false
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
@@ -133,6 +133,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: with_model
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id012
 description: |
   Cabalist is conceived as a simple way of adding some smarts 
   (machine learning capabilities) to your Ruby on Rails models 
@@ -151,32 +162,12 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - cabalist.gemspec
-- doc/Cabalist.html
-- doc/Cabalist/ClassifierGenerator.html
-- doc/Cabalist/Configuration.html
-- doc/Cabalist/Frontend.html
-- doc/Cabalist/InstallGenerator.html
-- doc/Cabalist/ModelAdditions.html
-- doc/Cabalist/Railtie.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
 - lib/cabalist.rb
 - lib/cabalist/configuration.rb
 - lib/cabalist/frontend.rb
@@ -201,13 +192,15 @@ files:
 - lib/generators/cabalist/install/templates/public/images/x_14x14.png
 - lib/generators/cabalist/install/templates/public/javascripts/cabalist.js
 - lib/generators/cabalist/install/templates/public/stylesheets/cabalist.css
+- lib/tasks/retrain.rake
 - spec/cabalist/frontend_spec.rb
 - spec/cabalist/model_additions_spec.rb
+- spec/cabalist/non_cabalist_model_spec.rb
 - spec/cabalist/performance_benchmark_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/marcinwyszynski/cabalist
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []
 
@@ -218,7 +211,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -235,5 +228,6 @@ summary: Minimum setup machine learning (classification) library for Ruby on Rai
 test_files: 
 - spec/cabalist/frontend_spec.rb
 - spec/cabalist/model_additions_spec.rb
+- spec/cabalist/non_cabalist_model_spec.rb
 - spec/cabalist/performance_benchmark_spec.rb
 - spec/spec_helper.rb