fisher_classifier 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmMyNjg5M2FhZmM5YjBhNTRhNzQ1Y2U0ZGNlZTY1MjgyZTRlMjc0YQ==
+    OWYzNGVmOGRhZGYzYjg5ZGQ3ZGU5OGY2NWI3YTk1MjllM2IyZDNkYw==
   data.tar.gz: !binary |-
-    MTQ4M2E0YjgwMzUwZGU2NGIwNjAwZGQwNzZhODdlNWYwYjUyZWFkMQ==
+    YWRlNDQxZWE0M2E2ZjdiNTA1NWM2YTE0ZDhhM2MyNDQxZWEwNzJlMQ==
 SHA512:
   metadata.gz: !binary |-
-    M2M0NGI4Njg1MjdkZDRiZWJiYmJiYTJlNTE3YmY5YTM3MWEyNTQwMGVkOTlm
-    OGRiNDgzNTIyNjZiMWFkZGFkM2Q2ZDJkOTgyNDdlMjc5OGNkOTMxNWEyMTM4
-    YjNhMWIzYWIxMmM0NWEyZjFmNzVkNjczODcxMjQ0YTlkN2ZhNDE=
+    ODJiMjE4NjNiOWVjOTc5NjQyY2M0MGY1ZTJlOTZkNjNhNTc3YmQxMTI5OGQx
+    NGU2ZTcxZjI3YTM0YjI2NjY0NWJmMGUwODllZDEyNDYzZDNlYzhlMDFmMWRi
+    YTI0MzYyOWM4N2JlOTIzZDUwNTU3YWE0NDA5YWVhZjAwMTBlZWU=
   data.tar.gz: !binary |-
-    YTNlM2M5MzZlOWQyY2FmN2NjOTA0NzUzNTlhMTBhMDNhYWMwYjQwZGUyMjVl
-    OGZlM2Y1MWYyMzg5NTUyYjM2YWFhZTk4Zjg0MjViYWM5NGNhNGE1YWIyYjBk
-    OWE5MjFlZGY4YTY4YmExYzU5ZTIwNmYzMzQ5M2RkMmQzMTA3NTE=
+    ZTMyNDEyODYxYTAyYmExYzk0MDE1NDllMWU0NjNmM2RlMjFmMWFlMGI4YWNi
+    YjRiOGYzOWUwMTA4NWZlZDhlOGFlZGI2YjE2NWYwMzM0ZDFiZGNhYTFlMGFm
+    N2FiZmRlODIzNDg3NTY4ZDAzYzQ4OGEwYWI2ZTM0MWEwMjA5OTY=

data/README.md

@@ -1,29 +1,151 @@
 # FisherClassifier
 
-TODO: Write a gem description
+Реализация статистического классификатора докуметов на основе линейного дискриминанта Фишера.
 
-## Installation
+Предоставляет прозрачный DSL для кофигурирования с возможностью определить:
 
-Add this line to your application's Gemfile:
+* набор категорий;
+* способ определения признаков;
+* коэффициент для подсчета взвешенной вероятности;
+* минимальный порог для определения принадлежности к категории;
+* любое хранилище статистики.
+
+Подробнее с теорией:
+* [Баесовский классификатор](http://www.machinelearning.ru/wiki/index.php?title=%D0%91%D0%B0%D0%B9%D0%B5%D1%81%D0%BE%D0%B2%D1%81%D0%BA%D0%B8%D0%B9_%D0%BA%D0%BB%D0%B0%D1%81%D1%81%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80)
+* [Линейный дискриминант Фишера](http://www.machinelearning.ru/wiki/index.php?title=%D0%9B%D0%B8%D0%BD%D0%B5%D0%B9%D0%BD%D1%8B%D0%B9_%D0%B4%D0%B8%D1%81%D0%BA%D1%80%D0%B8%D0%BC%D0%B8%D0%BD%D0%B0%D0%BD%D1%82_%D0%A4%D0%B8%D1%88%D0%B5%D1%80%D0%B0)
+
+## Установка
+
+Добавить в Gemfile:
 
     gem 'fisher_classifier'
 
-And then execute:
+Выполнить:
 
     $ bundle
 
-Or install it yourself as:
+Или поставить как гем:
 
     $ gem install fisher_classifier
 
-## Usage
+## Try Before You Buy™
+
+Попробовать можно в консоли, вот так:
+
+    $ irb
+
+    1.9.3-p448 :002 > require 'fisher_classifier'
+    1.9.3-p448 :003 > cl = FisherClassifier.create_in_memory
+    1.9.3-p448 :005 > cl.train('Nobody owns the water.','good')
+    => ["Nobody", "owns", "the", "water."]
+    1.9.3-p448 :006 > cl.train('the quick rabbit jumps fences','good')
+    => ["the", "quick", "rabbit", "jumps", "fences"]
+    1.9.3-p448 :007 > cl.train('buy pharmaceuticals now','bad')
+    => ["buy", "pharmaceuticals", "now"]
+    1.9.3-p448 :008 > cl.train('make quick money at the online casino','bad')
+    => ["make", "quick", "money", "at", "the", "online", "casino"]
+    1.9.3-p448 :009 > cl.train('the quick brown fox jumps','good')
+    => ["the", "quick", "brown", "fox", "jumps"]
+    1.9.3-p448 :015 >  cl.train('online trading with forex','bad')
+     => ["online", "trading", "with", "forex"]
+    1.9.3-p448 :008 > cl.classify('the quick money with forex now')
+    => :bad
+    1.9.3-p448 :009 > cl.classify('quck mouse runs from fox')
+    => :good
+
+В данном примере в качестве хранилища используется оперативная память.
+
+## DSL
+
+### Определениепризнаков
+
+```ruby
+  get_features do |text|
+    # Выделить набор признаков из текста
+  end
+```
+
+### Обучение
+
+```ruby
+  inc_feature do |feature, category|
+    # Увеличить счетчик кол-ва использований признака в категории
+  end
+
+  inc_category do |category|
+    # Увеличить счетчик кол-ва использований категории
+  end
+```
+
+### Классификация
+
+```ruby
+  # Предполагаемая вероятность (Вероятность признака, если он ни разу не появлялся)
+  assumed_prob 0.4
+
+  # Порог. Минимальное значение вероятности принадлежности текста в категории
+  fisher_threshold 0.1
+
+  categories do
+    # Возможные категории
+  end
+
+  category_count do |category|
+    # Кол-во использований категории
+  end
+
+  features_count do |feature, category|
+    # Кол-во использований признака в категории
+  end
+
+  default_category do
+    # Категория по умолчанию
+  end
+```
+
+## Rails (Active Record)
+
+Миграция (db/migrate/20131106143644_create_classifier_features.rb):
+
+```ruby
+class CreateClassifierFeatures < ActiveRecord::Migration
+  def change
+    create_table :classifier_features do |t|
+      t.string :name
+      t.string :category
+      t.integer :count, default: 1
+    end
+  end
+end
+```
+
+Модель (app/models/classifier_feature.rb):
+
+```ruby
+class ClassifierFeature < ActiveRecord::Base
+  validates :category, presence: true
+  validates :name, presence: true, uniqueness: {:scope => :category}
+
+  def self.categories
+    [:good, :bad]
+  end
+end
+```
+
+Инициалайзер:
+
+[config/initializers/classifier.rb](https://github.com/Andrew8xx8/fisher_classifier/blob/master/examples/classifier_initializer.rb)
+
+Использование:
 
-TODO: Write usage instructions here
+    $ rails c
+    1.9.3-p448 :009 > Classifier.train('the quick brown fox jumps', :good)
+    1.9.3-p448 :009 > Classifier.classify('the quick brown fox jumps', :good)
 
-## 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`)
+1. Форкни
+2. Зафигач фиче-ветку (`git checkout -b my-new-feature`)
+3. Коммить изменения (`git commit -am 'Add some feature'`)
+4. Пуш ветку (`git push origin my-new-feature`)
 5. Create new Pull Request

data/README_EN.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/examples/classifier_initializer.rb

@@ -0,0 +1,39 @@
+Classifier = FisherClassifier.create do
+  assumed_prob 0.4
+  fisher_threshold 0.1
+
+  inc_feature do |feature, category|
+    feature = ClassifierFeature.find_or_initialize_by(name: feature, category: category)
+    feature.count += 1 if feature
+    feature.save
+  end
+
+  get_features do |text|
+    if text
+      text.to_s.split(' ').map { |s| s.downcase }
+    else
+      []
+    end
+  end
+
+  categories do
+    ClassifierFeature.categories
+  end
+
+  category_count do |category|
+    ClassifierFeature.where(category: category).count
+  end
+
+  features_count do |feature, category|
+    f = ClassifierFeature.find_by(name: feature, category: category)
+    if f
+      f.count
+    else
+      0
+    end
+  end
+
+  default_category do
+    "bad"
+  end
+end

data/lib/fisher_classifier.rb

@@ -19,24 +19,17 @@ module FisherClassifier
 
         inc_feature do |feature, category|
           @features[category] ||= {}
-
-          if @features[category].has_key? feature
-            @features[category][feature] += 1
-          else
-            @features[category][feature] = 1
-          end
+          @features[category][feature] ||= 0
+          @features[category][feature] += 1
         end
 
         inc_category do |category|
-          if @categories.has_key? category
-            @categories[category] += 1
-          else
-            @categories[category] = 1
-          end
+          @categories[category] ||= 0
+          @categories[category] += 1
         end
 
         get_features do |text|
-          text.split(' ')
+          text.split(' ').map { |s| s.downcase }
         end
 
         categories do
@@ -44,8 +37,8 @@ module FisherClassifier
         end
 
         category_count do |category|
-          if @features.has_key?(category)
-            @categories[category] || 0
+          if @categories.has_key?(category)
+            @categories[category]
           else
             0
           end
@@ -53,7 +46,7 @@ module FisherClassifier
 
         features_count do |feature, category|
           if @features.has_key?(category) && @features[category].has_key?(feature)
-            @features[category][feature] || 0
+            @features[category][feature]
           else
             0
           end

data/lib/fisher_classifier/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fisher_classifier
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrew8xx8
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,7 +64,9 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- README_EN.md
 - Rakefile
+- examples/classifier_initializer.rb
 - fisher_classifier.gemspec
 - lib/fisher_classifier.rb
 - lib/fisher_classifier/classifier.rb