feature_selection 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 reddavis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,38 @@
+= Feature Selection
+
+Feature Selection is a library of feature selection algorithms. 
+
+http://en.wikipedia.org/wiki/Feature_selection
+
+== Install
+
+  gem sources -a http://gems.github.com
+  sudo gem install feature_selection
+  
+== How To Use
+
+There are currently 3 implemented feature collections: Chi-Squared, Mutual Information and Frequency Based.
+
+Each return a hash that looks similar to:
+
+  {klass => {term => score, term => score}, klass => {term => score}}
+  
+Example:
+
+  data = {
+          :spam => [['this', 'is', 'some', 'information'], ['this', 'is', 'something', 'that', 'is', 'information']],
+          :ham => [['this', 'test', 'some', 'more', 'information'], ['there', 'are', 'some', 'things']],
+          }
+
+  a = FeatureSelection::ChiSquared.new(data)
+
+  # You can also use...
+  # FeatureSelection::MutualInformation
+  # FeatureSelection::FrequencyBased
+
+  a.rank_features
+    #=> {:spam => {term => score, term => score}, :ham => {term => score}}
+          
+== Copyright
+
+Copyright (c) 2009 reddavis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "feature_selection"
+    gem.summary = %Q{A library of feature selection algorithms}
+    gem.description = %Q{A library of feature selection algorithms}
+    gem.email = "reddavis@gmail.com"
+    gem.homepage = "http://github.com/reddavis/Feature-Selection"
+    gem.authors = ["reddavis"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "feature_selection #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/feature_selection.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{feature_selection}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["reddavis"]
+  s.date = %q{2010-01-05}
+  s.description = %q{A library of feature selection algorithms}
+  s.email = %q{reddavis@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "feature_selection.gemspec",
+     "lib/feature_selection.rb",
+     "lib/feature_selection/base.rb",
+     "lib/feature_selection/chi_squared.rb",
+     "lib/feature_selection/frequency_based.rb",
+     "lib/feature_selection/mutual_information.rb",
+     "spec/feature_selection/base_spec.rb",
+     "spec/feature_selection/chi_squared_spec.rb",
+     "spec/feature_selection/frequency_based_spec.rb",
+     "spec/feature_selection/mutual_information_spec.rb",
+     "spec/feature_selection_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/reddavis/Feature-Selection}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A library of feature selection algorithms}
+  s.test_files = [
+    "spec/feature_selection/base_spec.rb",
+     "spec/feature_selection/chi_squared_spec.rb",
+     "spec/feature_selection/frequency_based_spec.rb",
+     "spec/feature_selection/mutual_information_spec.rb",
+     "spec/feature_selection_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/feature_selection.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/feature_selection/base')
+require File.expand_path(File.dirname(__FILE__) + '/feature_selection/mutual_information')
+require File.expand_path(File.dirname(__FILE__) + '/feature_selection/chi_squared')
+require File.expand_path(File.dirname(__FILE__) + '/feature_selection/frequency_based')

data/lib/feature_selection/base.rb

@@ -0,0 +1,84 @@
+module FeatureSelection
+  class Base
+    
+    def initialize(data)
+      @data = data
+    end
+    
+    def classes
+      @classes ||= find_all_classes
+    end
+    
+    private
+    
+    # Contains term and belongs to class
+    def n_1_1(term, klass)
+      count = 0.0
+      
+      @data[klass].each do |document|
+        count += 1 if document.include?(term)
+      end
+      
+      count
+    end
+    
+    # Contains term but does not belong to class
+    def n_1_0(term, klass)
+      count = 0.0
+      
+      @data.each_pair do |key, documents|
+        if key != klass
+          documents.each do |document|
+            count += 1 if document.include?(term)
+          end
+        end
+      end
+      
+      count
+    end
+    
+    # Does not contain term but belongs to class
+    def n_0_1(term, klass)
+      count = 0.0
+      
+      @data[klass].each do |document|
+        count += 1 if !document.include?(term)
+      end
+      
+      count
+    end
+    
+    # Does not contain term and does not belong to class
+    def n_0_0(term, klass)
+      count = 0.0
+      
+      @data.each_pair do |key, documents|
+        if key != klass
+          documents.each do |document|
+            count += 1 if !document.include?(term)
+          end
+        end #if key
+      end #@data.each_pair
+      
+      count
+    end
+    
+    # All of the counts added together
+    def count_documents
+      size = 0
+      @data.each_value do |documents|
+        size += documents.size
+      end
+      
+      size
+    end
+    
+    def find_all_classes
+      @data.map {|x| x[0]}
+    end
+    
+    def terms
+      @data.map {|x| x[1]}.flatten
+    end
+  end
+end

data/lib/feature_selection/chi_squared.rb

@@ -0,0 +1,37 @@
+# Chi-Squared takes two events (the class and the term) and calculates
+# whether the two events are dependent. If they are, then the occurance
+# of the term makes the occurance of the class more or less likely
+
+module FeatureSelection
+  class ChiSquared < Base
+   
+    def rank_features
+      # Returns:
+      #=> {:class => {'term' => score, 'term' => score}}
+      @results = {}
+      
+      classes.each do |klass|
+        @results[klass] = {}
+        
+        terms.each do |term|
+          answer = calculate_contribution(term, klass)
+          @results[klass][term] = answer
+        end #terms.each
+      end #classes.each
+      @results
+    end
+    
+    private
+    
+    def calculate_contribution(term, klass)
+      n_1_1 = n_1_1(term, klass)
+      n_1_0 = n_1_0(term, klass)
+      n_0_1 = n_0_1(term, klass)
+      n_0_0 = n_0_0(term, klass)
+      
+      (n_1_1 + n_1_0 + n_0_1 + n_0_0) * ((n_1_1 * n_0_0 - n_1_0 * n_0_1) ** 2) /
+        (n_1_1 + n_0_1) * (n_1_1 + n_1_0) * (n_1_0 + n_0_0) * (n_0_1 + n_0_0)
+    end
+    
+  end
+end

data/lib/feature_selection/frequency_based.rb

@@ -0,0 +1,24 @@
+module FeatureSelection
+  class FrequencyBased < Base
+   
+    def rank_features
+      # Returns:
+      #=> {:class => {'term' => count, 'term' => count}}
+      @results = {}
+      
+      classes.each do |klass|
+        @results[klass] = {}
+        
+        terms.each do |term|
+          if @results[klass].key?(term)
+            @results[klass][term] += 1
+          else
+            @results[klass][term] = 1
+          end
+        end #terms.each
+      end #classes.each
+      @results
+    end
+        
+  end
+end

data/lib/feature_selection/mutual_information.rb

@@ -0,0 +1,79 @@
+# Mutual Information measures how the much information
+# presence/absence of a term contributes to making the correct
+# classification
+
+# Equation - for every class and term
+#
+# P(U=e(t), C=e(c)) * log2( P(U=e(t), C=e(c)) / P(U=e(t)) * P(C=e(c)) )
+
+# We represent each function in the form - n(t,c)
+# n(1,1) = count documents that have term and belong to specified class
+# n(0,1) = count documents that do not have term and belongs to specified class
+# n(1,0) = count documents that have term but do not belong to specified class
+# n(0,0) = count documents that do not contain term and do not belong to specfied class
+# n = n(1,1) + n(0,1) + n(1,0) + n(0,0)
+
+module FeatureSelection
+  class MutualInformation < Base
+        
+    def rank_features
+      # Returns:
+      #=> {:class => {'term' => score, 'term' => score}}
+      @results = {}
+      
+      classes.each do |klass|
+        @results[klass] = {}
+        
+        terms.each do |term|
+          answer = calculate_contribution(term, klass)
+          @results[klass][term] = answer
+        end #terms.each
+      end #classes.each
+      @results
+    end
+    
+    private
+    
+    def calculate_contribution(term, klass)
+      calculate_section(term, klass, 1, 1) +
+        calculate_section(term, klass, 1, 0) +
+          calculate_section(term, klass, 0, 1) +
+            calculate_section(term, klass, 0, 0)
+    end
+    
+    def calculate_section(term, klass, t, c)
+      n = count_documents
+      n_1_0 = n_1_0(term, klass)
+      n_0_1 = n_0_1(term, klass)
+      
+      begin
+        if t == 1 && c == 1
+          n_1_1 = n_1_1(term, klass)
+                    
+          n_1_1 / n * 
+            Math.log( (n * n_1_1) / ((n_0_1 + n_1_1) * (n_1_1 + n_1_0)) ) 
+        elsif t == 1 && c == 0
+          n_1_1 = n_1_1(term, klass)
+          n_0_0 = n_0_0(term, klass)
+        
+          n_1_0 / n *
+            Math.log( (n * n_1_0) / ((n_1_1 + n_0_1) * (n_0_1 + n_0_0)) )
+        elsif t == 0 && c == 1
+          n_0_0 = n_0_0(term, klass)
+          n_1_1 = n_1_1(term, klass)
+        
+          n_0_1 / n *
+            Math.log( (n * n_0_1) / ((n_1_0 + n_0_0) * (n_1_1 + n_1_0)) )
+        elsif t == 0 && c == 0
+          n_0_0 = n_0_0(term, klass)
+        
+          n_0_0 / n *
+            Math.log( (n * n_0_0) / ((n_1_0 + n_0_0) * (n_0_1 + n_0_0)) )
+        end
+      rescue ZeroDivisionError, Errno::EDOM
+        0.0
+      end
+    end
+        
+  end
+end

data/spec/feature_selection/base_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Base" do
+  
+  before do
+    @a = FeatureSelection::Base.new(data)
+  end
+  
+  it "should include classes ham spam" do
+    @a.classes.should include(:spam)
+    @a.classes.should include(:ham)
+  end
+      
+end

data/spec/feature_selection/chi_squared_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Chi Squared" do
+  
+  before do
+    @a = FeatureSelection::ChiSquared.new(data)
+  end
+  
+  it "should return an hash" do
+    @a.rank_features.should be_a(Hash)
+  end
+    
+end

data/spec/feature_selection/frequency_based_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Frequency Based" do
+  
+  before do
+    @a = FeatureSelection::FrequencyBased.new(data)
+  end
+  
+  it "should return an hash" do
+    @a.rank_features.should be_a(Hash)
+  end
+  
+  describe "Should count how many times is occurs in spam" do
+    it "should return 3" do
+      @a.rank_features[:spam]['is'].should == 3
+    end
+  end
+    
+end

data/spec/feature_selection/mutual_information_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Mutual Information" do
+  
+  before do
+    @a = FeatureSelection::MutualInformation.new(data)
+  end
+  
+  it "should return an hash" do
+    @a.rank_features.should be_a(Hash)
+  end
+    
+end

data/spec/feature_selection_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FeatureSelection" do
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'feature_selection'
+require 'spec'
+require 'spec/autorun'
+
+def data
+  {
+  :spam => [['this', 'is', 'some', 'information'], ['this', 'is', 'something', 'that', 'is', 'information']],
+  :ham => [['this', 'test', 'some', 'more', 'information'], ['there', 'are', 'some', 'things']],
+  }
+end
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: feature_selection
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- reddavis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-05 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: A library of feature selection algorithms
+email: reddavis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- feature_selection.gemspec
+- lib/feature_selection.rb
+- lib/feature_selection/base.rb
+- lib/feature_selection/chi_squared.rb
+- lib/feature_selection/frequency_based.rb
+- lib/feature_selection/mutual_information.rb
+- spec/feature_selection/base_spec.rb
+- spec/feature_selection/chi_squared_spec.rb
+- spec/feature_selection/frequency_based_spec.rb
+- spec/feature_selection/mutual_information_spec.rb
+- spec/feature_selection_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/reddavis/Feature-Selection
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A library of feature selection algorithms
+test_files: 
+- spec/feature_selection/base_spec.rb
+- spec/feature_selection/chi_squared_spec.rb
+- spec/feature_selection/frequency_based_spec.rb
+- spec/feature_selection/mutual_information_spec.rb
+- spec/feature_selection_spec.rb
+- spec/spec_helper.rb