tiny-classifier 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef03bed349d3c266bab512446b6dff8946d5c14f
-  data.tar.gz: 768126f03759f1fe38ef2e155dad3484836f4422
+  metadata.gz: 962697672b93b80fa4ca5efcf46c9e820d184b96
+  data.tar.gz: 199917cf6cae91ae3fed243818bf924426b929ca
 SHA512:
-  metadata.gz: 9c59f06bef1b3fcc30914a410c29ac52444ea77790f5f4f588515c268bb181a2f353083bfe1ab3ceeba94964052807a6cb556ded863712b09f6488c7d1feff07
-  data.tar.gz: aa188deccf010883b6d04f3ae63ba0124d9ff4f586690cfccf921be5e1466deed11e72b021083142d0e37134f80a1b462af4e7989af0d3c69c830a19391000c9
+  metadata.gz: 08b97dcd3859de27e4b39796fecfb57e5a978e55c8d47dcda19e700acee7cd8a7451e3e60f7e74c750530b17ee038222853babd278b63450b1f71cd82c3d5b12
+  data.tar.gz: 5c7be101d3209ff3079e597e069e502be00769aa11bb025825047bcc651bbbda5b1037ac361be4a4531dcea1a4cc32c9f82e922bd461ca4ab438036abbe75446

data/README.md

@@ -14,6 +14,14 @@ Command line tool to run text classifier based on naive bayes.
 % gem install tiny-classifier
 ```
 
+If you hope to use `--tokenizer=mecab`, you need to install MeCab like:
+
+```
+% sudo apt install mecab mecab-ipadic-utf8
+```
+
+This is example on Ubuntu.
+
 ## Basic usage
 
 Training:
@@ -36,13 +44,13 @@ positive
 
 ### Common
 
-`--labels=LABELS` (required)
+`-l`, `--labels=LABELS` (required)
 :  A comman-separated list of labels. You should use only alphabetic characters. (Non-alphabetical characters will cause problems.)
 
-`--data-dir=PATH` (optional)
-: The path to the directory that the training data to be saved. The current directory.
+`-d`, `--data-dir=PATH` (optional)
+: The path to the directory that the training data to be saved. The current directory is the default value.
 
-`--tokenizer=TOKENIZER` (optional)
+`-t`, `--tokenizer=TOKENIZER` (optional)
 : Tokenizer for input which is not separated by whitespaces. Possible values are: only `mecab`.
 
 ### Trainer

data/lib/tiny-classifier/base.rb

@@ -26,27 +26,30 @@ class TinyClassifierBase
   end
 
   def parse_command_line_options(command_line_options)
-    option_parser = create_option_parser
     option_parser.parse!(command_line_options)
   end
 
   private
+  def option_parser
+    @option_parser ||= create_option_parser
+  end
+
   def create_option_parser
     parser = OptionParser.new
 
-    parser.on("--data-dir=PATH",
+    parser.on("-d PATH", "--data-dir=PATH",
               "Path to the directory to store training data file (default=current directory)") do |data_dir|
       @data_dir = data_dir
     end
 
-    parser.on("--labels=LABELS",
+    parser.on("-l LABELS", "--labels=LABELS",
               "List of labels (comma-separated)") do |labels|
       @labels = normalize_labels(labels)
     end
 
-    parser.on("--tokenizer=TOKENIZER",
+    parser.on("-t TOKENIZER", "--tokenizer=TOKENIZER",
               "Tokenizer (default=#{@tokenizer})") do |tokenizer|
-      @tokenizer = tokenizer.to_sym
+      @tokenizer = tokenizer.downcase.to_sym
     end
 
     parser
@@ -113,7 +116,7 @@ class TinyClassifierBase
     natto = Natto::MeCab.new
     terms = []
     natto.parse(@input) do |term|
-      if term.feature =~ /名詞|形容詞|動詞/
+      if term.feature =~ /\A(名詞|形容詞|動詞)/
         terms << term.surface
       end
     end

data/lib/tiny-classifier/classifier.rb

@@ -31,11 +31,12 @@ class Classifier < TinyClassifierBase
     @input = params[:input]
     prepare_input
     if @input.empty?
-      exit(1)
+      STDERR.puts("Error: No effective input.")
+      false
     else
       label = classifier.classify(@input)
       puts label.downcase
-      exit(0)
+      true
     end
   end
 end

data/lib/tiny-classifier/trainer.rb

@@ -27,20 +27,46 @@ class Trainer < TinyClassifierBase
     end
   end
 
+  def initialize
+    super
+    option_parser.banner += " LABEL"
+  end
+
   def run(params)
     @label = params[:label]
     @input = params[:input]
+    prepare_label
     prepare_input
     if @input.empty?
-      exit(1)
+      STDERR.puts("Error: No effective input.")
+      false
     else
-      classifier.send("train_#{@label.downcase}", @input)
+      classifier.send("train_#{@label}", @input)
       save
-      exit(0)
+      true
     end
   end
 
   private
+  def prepare_label
+    unless @label
+      STDERR.puts("Error: You need to specify the label for the input.")
+      exit(false)
+    end
+
+    @label = @label.downcase.strip
+
+    if @label.empty?
+      STDERR.puts("Error: You need to specify the label for the input.")
+      exit(false)
+    end
+
+    unless @labels.include?(@label.capitalize)
+      STDERR.puts("Error: You need to specify one of valid labels: #{@labels.join(', ')}")
+      exit(false)
+    end
+  end
+
   def save
     data = Marshal.dump(classifier)
     File.open(data_file_path, "w") do |file|

data/tiny-classifier.gemspec

@@ -21,7 +21,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
 
 Gem::Specification.new do |spec|
   spec.name = "tiny-classifier"
-  spec.version = "1.0"
+  spec.version = "1.1"
   spec.homepage = "https://github.com/piroor/tiny-classifier"
   spec.authors = ["YUKI \"Piro\" Hiroshi"]
   spec.email = ["piro.outsider.reflex@gmail.com"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny-classifier
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - YUKI "Piro" Hiroshi