ocarina 0.0.1

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Intellij IDEA project dir
+.idea/
+
+# Intellij IDEA project file
+*.iml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ocarina.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,204 @@
+Copyright (c) 2012 George Armhold
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,13 @@
+   Copyright 2012 George Armhold
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,83 @@
+# Ocarina - Optical Character Recognition (OCR) for Ruby
+
+### A Ruby project that uses machine learning to perform Optical Character Recognition.
+
+![](https://raw.github.com/armhold/ocarina/master/ocarina.png)
+
+I created this project in order to learn Ruby. It started as kind of a toy program, but
+quickly grew into something with a practical purpose (decoding [Letterpress](https://itunes.apple.com/us/app/id526619424?mt=8)
+gameboards!)
+
+It works fairly well on constrained input, but it's not really intended to be a
+production-level OCR package.
+
+## Status
+
+Ocarina successfully trains and recognizes the 26 letters of the alphabet. Once trained, the network
+accurately recognizes its training set (100%) and also does well (98%?) on recognizing characters
+with added noise.
+
+I'm still working on how best to organize the neural network (# of hidden nodes, # of outputs,
+edge weights) to increase the set size to support the full ASCII (and beyond) alphabet.
+
+
+## Motivation
+
+I first encountered OCR technology back in 1991 or so, on an Apple Macintosh. It seemed like
+magic, even though it was a pretty poor implementation by today's standards. Recently I came across the
+[Sudoku Grab](http://itunes.apple.com/app/sudoku-grab/id305614901?mt=8) app. It does OCR very successfully,
+albeit on very constrained input images.
+
+This inspired me to try to create my own (simplistic) OCR implementation, and that seemed like a
+great way to learn Ruby.
+
+
+## Installation
+
+
+### Dependencies
+
+Ocarina depends on ImageMagick (and the RMagick gem) to do its graphics processing.
+On OSX at least, ImageMagick requires X11 and ghostscript. You'll likely need to do the following:
+
+
+1. Download and install [X11Quartz](http://xquartz.macosforge.org/landing)
+1. `$ brew install imagemagick`
+1. `$ brew install ghostscript`
+
+
+## Usage
+
+#### Training
+
+`rake ocarina:train`
+
+#### Character Recognition
+
+`rake ocarina:eval`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## LICENSE
+
+   Copyright 2012 George Armhold
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/Rakefile

@@ -0,0 +1,146 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require_relative "lib/ocarina.rb"
+require 'powerbar'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+
+namespace :ocarina do
+  include Ocarina::Util
+
+  desc "generates and persists bitmaps for reference/noise images"
+  task :bitmaps do |t, args|
+
+    # train/eval does not actually need bitmaps on disk- we provide this so that
+    # you can examine the generated bitmap images for debugging purposes.
+    #
+    # images are saved to data/images/{reference,noise}
+
+    generator = Ocarina::CharacterGenerator.new(config)
+    generator.persist_tiles
+  end
+
+  desc "builds and trains the network"
+  task :train do |t, args|
+    network = Ocarina::Network.new(config)
+    generator = Ocarina::CharacterGenerator.new(network.config)
+
+    training_iterations = 350
+    pbar = PowerBar.new
+    pbar.settings.tty.finite.template.barchar = '#'
+    pbar.settings.tty.finite.template.padchar = '-'
+
+    training_iterations.times do |i|
+      generator.reference_image_hash.each_pair do |char, tile|
+        network.train tile, char
+        pbar.show(msg: "current error: #{'%.10f' % network.current_error}", done: i + 1, total: training_iterations)
+      end
+    end
+
+    puts "\nfinal training error: #{network.current_error}\n"
+
+    # run with: ruby -I"lib:test" test/network_test.rb -n test_network
+
+    file = "#{Ocarina::DATA_DIR}/train.bin"
+    network.save_network_to_file file
+
+    puts "trained network saved to: #{file}"
+  end
+
+  desc "runs the training images back through the network for evaluation"
+  task :eval do |t, args|
+    file = "#{Ocarina::DATA_DIR}/train.bin"
+    network = Ocarina::Network.load_network_from_file file
+    generator = Ocarina::CharacterGenerator.new(network.config)
+
+    puts "##### testing against reference images #####"
+    stats = Ocarina::ErrorStats.new(network.config)
+
+    generator.reference_image_hash.each_pair do |char, tile|
+      result = network.recognize tile
+      stats.check_error char.ord, result
+    end
+    stats.report
+
+    puts
+    puts "##### testing against noise images #####"
+
+    stats = Ocarina::ErrorStats.new(network.config)
+
+    generator.noise_image_hash.each_pair do |char, tile|
+      result = network.recognize tile
+      stats.check_error char.ord, result
+    end
+    stats.report
+  end
+
+  desc "builds and trains network using Letterpress board tiles"
+  task :letterpress do |t, args|
+    network = Ocarina::Network.new(config)
+    generator = Ocarina::LetterpressCharacterGenerator.new(network.config)
+
+    training_iterations = 1200
+    pbar = PowerBar.new
+    pbar.settings.tty.finite.template.barchar = '#'
+    pbar.settings.tty.finite.template.padchar = '-'
+
+    training_iterations.times do |i|
+      generator.reference_image_hash.each_pair do |char, tile|
+        network.train tile, char
+        pbar.show(msg: "current error: #{'%.10f' % network.current_error}", done: i + 1, total: training_iterations)
+      end
+    end
+
+    puts "\nfinal training error: #{network.current_error}\n"
+
+    network.save_network_to_file "#{Ocarina::DATA_DIR}/letterpress-train.bin"
+
+    puts "trained network saved to: #{file}"
+
+    puts "##### testing against reference images #####"
+    stats = Ocarina::ErrorStats.new(network.config)
+
+    generator.reference_image_hash.each_pair do |char, tile|
+      result = network.recognize tile
+      stats.check_error char.ord, result
+    end
+    stats.report
+
+  end
+
+  desc "deciphers letters from a letterpress game board"
+  task :gameboard, [:board_file]  do |t, args|
+    network = Ocarina::Network.load_network_from_file "#{Ocarina::DATA_DIR}/letterpress-train.bin"
+
+    puts "reading letterpress board: #{args.board_file}..."
+
+    board = Magick::Image.read(args.board_file).first
+
+    cropper = Ocarina::LetterpressCropper.new(network.config)
+    chars = cropper.decipher_board(network, board)
+    result = ""
+
+    chars.each do |row|
+      row.each do |char|
+        result << "  #{char}"
+      end
+
+      result << "\n"
+    end
+
+    puts "result: \n\n#{result}"
+  end
+
+  def config
+    # need 8 bits to represent 0..255 in binary
+    @config ||= Ocarina::Config.new("ABCDEFGHIJKLMNOPQRSTUVWXYZ", 8, 16, 16)
+  end
+
+
+end