word_aligner 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a4c26333b5e0991c70d0e61ef5435268672a112
-  data.tar.gz: 2ec6efcb6606676f2e30bd26425bd21843278018
+  metadata.gz: c32d9ee5728f79dcb8f723768c832ec8807a321d
+  data.tar.gz: f51260981c579aac86155c91e2b11184d5663929
 SHA512:
-  metadata.gz: 199f2c4f5288a60c907a9d842951e740ec712eeaca1a9371a74b96db92d2053107543809b107c23bd025f532f5a75add474f5ff7f12cd163d0c99cb728cb5ffd
-  data.tar.gz: 95ae32a917c4e2578bb6087973c0cf195eb4b41b56e771b37d1d138b336440163e8bee9e1ebf015bb48b9690831654ed08fcce8c962dcbae3f11d765f9f01d86
+  metadata.gz: 64d4796c1231a2a758d744bde20177c2bf867e4ad8134f576ebb9e3a0fb1cd43e49f3ab4b797b151f1c24cc4ed71e0441c2e68b1b79dc2759f64cfcb844305a7
+  data.tar.gz: 9b97b27165cee5f997f4fd4a057e33342e71d37415e115b5295a524697f8ff1459b4b0d8a85541a6ae838832587f8bd141e025b0213174049c2ddea76917e407

data/README.md

@@ -31,11 +31,14 @@ $ bundle
 
  error_rate.correct => 2
  error_rate.errors => 1
- error_rate.percent_correct  => 66.0
- error_rate.percent_error    => 33.0
- error_rate.percent_accuracy => 66.0
+ error_rate.percentage_correct   => 66.0
+ error_rate.percentage_incorrect => 33.0
+ error_rate.percentage_accurate  => 66.0
 ```
 
+There is also ```WordErrorRateCollection``` if you need to calculate
+the word error rate for multiple hypotheses.
+
 ## Contributing
 
 1. Fork it

data/lib/word_aligner.rb

@@ -1,3 +1,4 @@
+require 'word_error_rate_collection'
 require 'word_aligner/aligner'
 require 'word_aligner/word_error_rate'
 

data/lib/word_error_rate_collection.rb

@@ -0,0 +1,55 @@
+class WordErrorRateCollection
+
+  attr_reader :entries
+
+  def initialize(entries)
+    @entries = entries
+  end
+
+  def correct_words
+    entries.map(&:correct_words).inject(0, :+)
+  end
+
+  def incorrect_words
+    entries.map(&:incorrect_words).inject(0, :+)
+  end
+
+  def words
+    entries.map(&:words).inject(0, :+)
+  end
+
+  def percentage_correct
+    percent_rate(correct_words)
+  end
+
+  def percentage_incorrect
+    percent_rate(incorrect_words)
+  end
+
+  def percentage_accurate
+    100 - percentage_incorrect
+  end
+
+  def aligned_transcription
+    'TOTAL'
+  end
+
+  def aligned_hypothesis
+    'TOTAL'
+  end
+
+  def method_missing(name)
+    'N/A'
+  end
+
+  def to_partial_path
+    'word_error_rates/word_error_rate'
+  end
+
+  private
+
+  def percent_rate(value)
+    value * 100.0 / [words, 1].max
+  end
+
+end

data/spec/lib/word_aligner/aligner_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'yaml'
 
 class Sample < OpenStruct
   def aligner_result

data/spec/lib/word_error_rate_collection.rb_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe WordErrorRateCollection do
+
+  word_error_rates = []
+  word_error_rates << WordAligner.align('hello and welcome', 'hullo and wulcome')
+  word_error_rates << WordAligner.align('good morning', 'good lulz')
+
+  subject { WordErrorRateCollection.new(word_error_rates) }
+
+  its(:entries)               { should eq word_error_rates }
+  its(:aligned_transcription) { should eq 'TOTAL' }
+  its(:aligned_hypothesis)    { should eq 'TOTAL' }
+
+  its(:correct_words)         { should eq 2 }
+  its(:incorrect_words)       { should eq 3 }
+  its(:words)                 { should eq 5 }
+
+  its(:percentage_correct)    { should be_within(0.1).of(40) }
+  its(:percentage_incorrect)  { should be_within(0.1).of(60) }
+  its(:percentage_accurate)   { should be_within(0.1).of(40) }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: word_aligner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Maciej
@@ -100,8 +100,10 @@ files:
 - lib/word_aligner.rb
 - lib/word_aligner/aligner.rb
 - lib/word_aligner/word_error_rate.rb
+- lib/word_error_rate_collection.rb
 - spec/lib/word_aligner/aligner_spec.rb
 - spec/lib/word_aligner/word_error_rate_spec.rb
+- spec/lib/word_error_rate_collection.rb_spec.rb
 - spec/lib/word_aligner_spec.rb
 - spec/sample_data/grab_for_comparision.rb
 - spec/sample_data/regression/sentences.yml