fisher_classifier 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGYyYTEwNDI3NjdhNjYwNmYxMTllYzhlZWJiNDE1ODhjNGQ5OGE0Yw==
+  data.tar.gz: !binary |-
+    NjAzYTczODQzZWIwZjhjNTRjM2I1OTFiMTk2MDk1ZjMxNWI4ODEyMg==
+SHA512:
+  metadata.gz: !binary |-
+    NWQ3NjQyN2U1MzI4MjExMzIyNjAwNDFiYzQxMmMyMTdjMTNjNTE0N2FmMDU3
+    OWQ2NDc5OGIxMzVlOGZjNDUwMzY2MTliNjg5YjU2ZTkxZWYwYTUwM2QxZTgy
+    M2FhOWVhYWYwZjgzZTI5ZTM4YWYzMThmMDZlYzE0YjEwMGM2N2Q=
+  data.tar.gz: !binary |-
+    NGMwNjFlZDEwZjlhZDZkNjY0M2E4MTJlY2Q3YTdhNzVhOGUzNmYwMWQ5MzA5
+    OTIzOGRiMjZlNjZmMjE4YTIxYjg0ZjhkMTQwMjA3MjUxNTNhNTdkMGRkYzkw
+    MTgwOWZmNTZkYWE3ZTg4Y2RjMDYxYWY1Y2ZiNGFlZDZmZWFkNmQ=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fisher_classifier.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'coveralls', :require => false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew8xx8
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# FisherClassifier
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fisher_classifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fisher_classifier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/fisher_classifier.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fisher_classifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fisher_classifier"
+  spec.version       = FisherClassifier::VERSION
+  spec.authors       = ["Andrew8xx8"]
+  spec.email         = ["avk@8xx8.ru"]
+  spec.description   = %q{Light document classifier based on Fisher method}
+  spec.summary       = %q{Light document classifier based on Fisher method}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "awesome_print"
+end

data/lib/fisher_classifier.rb

@@ -0,0 +1,70 @@
+require "fisher_classifier/version"
+
+module FisherClassifier
+  autoload :Classifier, 'fisher_classifier/classifier'
+  autoload :Config, 'fisher_classifier/config'
+  autoload :Meta, 'fisher_classifier/meta'
+
+  class << self
+    def create(&block)
+      config = Config.new block
+
+      Classifier.new config
+    end
+
+    def create_in_memory
+      create do
+        @features = {}
+        @categories = {}
+
+        inc_feature do |feature, category|
+          @features[category] ||= {}
+
+          if @features[category].has_key? feature
+            @features[category][feature] += 1
+          else
+            @features[category][feature] = 1
+          end
+        end
+
+        inc_category do |category|
+          if @categories.has_key? category
+            @categories[category] += 1
+          else
+            @categories[category] = 1
+          end
+        end
+
+        get_features do |text|
+          text.split(' ')
+        end
+
+        categories do
+          [:good, :bad]
+        end
+
+        category_count do |category|
+          if @features.has_key?(category)
+            @categories[category] || 0
+          else
+            0
+          end
+        end
+
+        features_count do |feature, category|
+          if @features.has_key?(category) && @features[category].has_key?(feature)
+            @features[category][feature] || 0
+          else
+            0
+          end
+        end
+
+        default_category do
+          :none
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fisher_classifier/classifier.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+module FisherClassifier
+  class Classifier
+    include FisherClassifier::Meta
+
+    def initialize(config)
+      @config = config
+    end
+
+    def train(text, category)
+      get_features(text).each do |feature|
+        inc_feature(feature, category)
+        inc_category(category)
+      end
+    end
+
+    def classify(text)
+      features = get_features(text)
+      best = default_category
+      max = 0.0
+
+      categories.each do |category|
+        prob = fisher_prob(category, features)
+
+        if prob > max
+          best = category
+          max = prob
+        end
+      end
+
+      best
+    end
+
+    private
+
+    def fisher_prob(category, features)
+      invchi2(
+        fisher_factor(
+          probs_multiply(features, category)
+        ), features.size * 2
+      )
+    end
+
+    def probs_multiply(features, category)
+      fprobs = features.map { |f| weighted_prob(f, category) }
+      probs_multiply = fprobs.inject(:*)
+      probs_multiply ||= 0
+    end
+
+    def fisher_factor(probs_multiply)
+      -2 * Math.log(probs_multiply)
+    end
+
+    def feature_prob(feature, category)
+      cc = category_count(category)
+      return cc if cc.zero?
+
+      features_count(feature, category) / cc.to_f
+    end
+
+    def weighted_prob(feature, category)
+      current_prob = category_prob(feature, category)
+      totals = feature_in_all_categories(feature)
+
+      (weight * ap + totals * current_prob) / ( weight + totals).to_f
+    end
+
+    def feature_in_all_categories(feature)
+      counts = categories.map { |c| features_count(feature, c) }
+      counts.inject(:+)
+    end
+
+    def category_prob(feature, category)
+      fp = feature_prob(feature, category)
+      return fp if fp.zero?
+
+      fp / feature_freqsum(feature, category)
+    end
+
+    def feature_freqsum(feature, category)
+      counts = categories.map { |c| feature_prob(feature, c) }
+      counts.inject(:+)
+    end
+
+    def invchi2(chi, df)
+      m = chi / 2.0
+      sum = term = Math.exp(-m)
+
+      for i in 1..(df / 2)
+        term *= m / i
+        sum += term
+      end
+
+      [sum, 1.0].min
+    end
+
+    def default_category
+      @config.call(:default_category)
+    end
+
+    def category_threshold(category)
+      @config.call(:category_threshold, category)
+    end
+
+    def weight
+      @config.get(:weight)
+    end
+
+    def ap
+      @config.get(:ap)
+    end
+
+    def get_features(text)
+      @config.call(:get_features, text)
+    end
+
+    def categories
+      @config.call(:categories)
+    end
+
+    def category_count(category)
+      @config.call(:category_count, category)
+    end
+
+    def features_count(feature, category)
+      @config.call(:features_count, feature, category)
+    end
+
+    def inc_feature(feature, category)
+      @config.call :inc_feature, feature, category
+    end
+
+    def inc_category(category)
+      @config.call :inc_category, category
+    end
+  end
+end

data/lib/fisher_classifier/config.rb

@@ -0,0 +1,34 @@
+module FisherClassifier
+  class Config
+
+    def initialize(block)
+      @config = {
+        weight: 1.0,
+        ap: 0.5
+      }
+      @methods = {}
+      instance_eval &block
+    end
+
+    def get(key)
+      raise "'#{key}' value does not defined in config" unless @config.has_key? key
+
+      @config[key]
+    end
+
+    def call(name, *args)
+      raise "'#{name}' mehtod does not defined in config" unless @methods.has_key? name
+
+      @methods[name].call *args
+    end
+
+    def method_missing(key, value = nil, &block)
+      if block_given?
+        @methods[key] = block
+      else
+        @config[key] = value
+      end
+    end
+
+  end
+end

data/lib/fisher_classifier/meta.rb

@@ -0,0 +1,51 @@
+module FisherClassifier
+  module Meta
+    def meta_classify(text)
+      features = get_features(text)
+
+      {
+        text: text,
+        default_category: default_category,
+        selected_category: classify(text),
+        features: meta_features(features),
+        categories: meta_categories(features),
+      }
+    end
+
+    private
+
+    def meta_categories(features)
+      categories.map do |category|
+        pm = probs_multiply(features, category)
+        {
+          name: category,
+          probs_multiply: pm,
+          fisher_factor: fisher_factor(pm),
+          fisher_prob: fisher_prob(category, features),
+        }
+      end
+    end
+
+    def meta_features(features)
+      features.map do |feature|
+        {
+          name: feature,
+          feature_in_all_categories: feature_in_all_categories(feature),
+          categories: meta_feature_categories(feature)
+        }
+      end
+    end
+
+    def meta_feature_categories(feature)
+      categories.map do |category|
+        {
+          name: category,
+          category_prob: category_prob(feature, category),
+          feature_prob: feature_prob(feature, category),
+          weighted_prob: weighted_prob(feature, category),
+          freqsum: feature_freqsum(feature, category)
+        }
+      end
+    end
+  end
+end

data/lib/fisher_classifier/version.rb

@@ -0,0 +1,3 @@
+module FisherClassifier
+  VERSION = "0.0.2"
+end

data/spec/fisher_classifier/config_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe FisherClassifier::Config do
+  before do
+    config = Proc.new do
+      key :value
+
+      features_count do
+        3
+      end
+    end
+
+    @instance = FisherClassifier::Config.new config
+  end
+
+  it 'should be initialized with configuration block' do
+    expect( @instance ).to be
+  end
+
+  it 'should raise error if config value missing' do
+    expect{ @instance.get(:missing_value) }.to raise_error
+  end
+
+  it 'should raise error if config method missing' do
+    expect{ @instance.get(:missing_value) }.to raise_error
+  end
+
+  it 'should be save value for key' do
+    value = @instance.get(:key)
+
+    expect( value ).to eq :value
+  end
+
+  it 'should execute block stored in config' do
+    result = @instance.call(:features_count)
+
+    expect( result ).to eq 3
+  end
+end

data/spec/fisher_classifier_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe FisherClassifier do
+  before do
+    # Use in-memory classifier
+    @classifier = FisherClassifier.create_in_memory
+  end
+
+  it 'should calculate feature prob' do
+    expect(@classifier).to be
+
+    @classifier.train 'the quick rabbit jumps fences', :good
+    @classifier.train 'buy pharmaceuticals now', :bad
+
+    cat =  @classifier.classify('buy now')
+    expect(cat).to eq :bad
+
+    cat =  @classifier.classify('buy stuff now')
+    expect(cat).to eq :bad
+
+    cat =  @classifier.classify('rabbit jumps now')
+    expect(cat).to eq :good
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.require
+
+if ENV["TRAVIS"]
+  require 'coveralls'
+  Coveralls.wear!
+end

data/spec_helper.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+require 'sfk'
+require 'bundler/setup'
+Bundler.require(:default, :development, :test)
+
+require 'simplecov'
+if ENV["COVERAGE"]
+  SimpleCov.start
+  files = Dir[File.join(File.dirname(__FILE__), "../lib/**/*.rb")]
+  files.each {|file| require file }
+end
+
+require 'webmock/rspec'
+require File.expand_path('../support/stub_helpers', __FILE__)
+
+SFK::RSpec.configure do |config|
+  config.root_path = Pathname(File.join(File.dirname(__FILE__), '../'))
+  config.apps_path = Pathname(File.join(File.dirname(__FILE__), 'support'))
+  config.shared_app_contexts [:main] do
+    let(:base) {app.view('base')}
+  end
+
+  include StubHelpers
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: fisher_classifier
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andrew8xx8
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Light document classifier based on Fisher method
+email:
+- avk@8xx8.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fisher_classifier.gemspec
+- lib/fisher_classifier.rb
+- lib/fisher_classifier/classifier.rb
+- lib/fisher_classifier/config.rb
+- lib/fisher_classifier/meta.rb
+- lib/fisher_classifier/version.rb
+- spec/fisher_classifier/config_spec.rb
+- spec/fisher_classifier_spec.rb
+- spec/spec_helper.rb
+- spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Light document classifier based on Fisher method
+test_files:
+- spec/fisher_classifier/config_spec.rb
+- spec/fisher_classifier_spec.rb
+- spec/spec_helper.rb