brainz 0.1.2 → 0.1.3

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -1,5 +1,7 @@
 Copyright (c) 2012 Vilius Luneckas
 
+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
@@ -17,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Brainz
+
+Artificial Neural Network Library written in Ruby.
+
+## Supported training algorithms
+
+* Backpropagation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'brainz'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brainz
+
+## Usage
+
+### Simple example, logical AND operation
+
+    require 'brainz'
+    
+    brainz = Brainz::Brainz.new
+    
+    brainz.teach do |iteration, error|
+      that(1, 1).is(1)
+      that(1, 0).is(0)
+      that(0, 1).is(0)
+      that(0, 0).is(0)
+      p "error_rate = #{'%.3f' % error || 0 } after #{iteration} iterations" if iteration % 10 == 0
+    end
+    
+    puts "0 and 0 = #{brainz.guess(a: 0, b: 0)}"
+    puts "0 and 1 = #{brainz.guess(a: 0, b: 1)}"
+    puts "1 and 1 = #{brainz.guess(a: 1, b: 1)}"
+    puts "1 and 0 = #{brainz.guess(a: 1, b: 0)}"
+
+### Advanced usage, ligical XOR operation
+
+    require 'brainz'
+
+    brainz = Brainz::Brainz.new
+    
+    # specify number of hidden layers
+    # 3 hidden layers with 4, 7 and 3 neurons
+    brainz.num_hidden = [4, 7, 3]
+    
+    # tune learning parameters: learning_rate, momentum, wanted_error (mse)
+    brainz.teach(learning_rate: 0.2, momentum: 0.05, wanted_error: 0.01) do |iteration, error|
+      that(1, 1).is(0)
+      that(1, 0).is(1)
+      that(0, 1).is(1)
+      that(0, 0).is(0)
+    end
+
+    puts "Learning took #{brainz.last_iterations}, error: #{brainz.error}, time: #{brainz.learning_time} s."
+
+## 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

data/Rakefile

@@ -1,13 +1,7 @@
-# encoding: utf-8
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require 'rake'
-require 'echoe'
-require './lib/brainz/version.rb'
+RSpec::Core::RakeTask.new
 
-Echoe.new('brainz', Brainz::VERSION) do |gem|
-  gem.description = "Simple artificial intelligence"
-  gem.url = "https://github.com/ViliusLuneckas/brainz/"
-  gem.email = "vilius.luneckas@gmail.com"
-  gem.author = "Vilius Luneckas"
-  gem.development_dependencies = ['rspec', 'mocha']
-end
+task :default => :spec

data/brainz.gemspec

@@ -1,35 +1,20 @@
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/brainz/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = "brainz"
-  s.version = "0.1.2"
+Gem::Specification.new do |gem|
+  gem.authors       = ["Vilius Luneckas"]
+  gem.email         = ["vilius.luneckas@gmail.com"]
+  gem.description   = %q{Artificial Neural Network library written in Ruby}
+  gem.summary       = %q{Artificial Neural Network library written in Ruby}
+  gem.homepage      = "https://github.com/ViliusLuneckas/brainz/"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Vilius Luneckas"]
-  s.date = "2012-03-26"
-  s.description = "Simple artificial intelligence"
-  s.email = "vilius.luneckas@gmail.com"
-  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "lib/brainz.rb", "lib/brainz/backpropagation.rb", "lib/brainz/brainz.rb", "lib/brainz/layer.rb", "lib/brainz/loader.rb", "lib/brainz/network.rb", "lib/brainz/neuron.rb", "lib/brainz/synapse.rb", "lib/brainz/version.rb", "lib/ext/array.rb"]
-  s.files = ["LICENSE", "README.rdoc", "Rakefile", "brainz.gemspec", "examples/and.rb", "examples/multi_layer_xor.rb", "examples/sign.rb", "examples/xor.rb", "lib/brainz.rb", "lib/brainz/backpropagation.rb", "lib/brainz/brainz.rb", "lib/brainz/layer.rb", "lib/brainz/loader.rb", "lib/brainz/network.rb", "lib/brainz/neuron.rb", "lib/brainz/synapse.rb", "lib/brainz/version.rb", "lib/ext/array.rb", "spec/array_spec.rb", "spec/brainz_spec.rb", "spec/loader_spec.rb", "spec/neuron_spec.rb", "spec/spec_helper.rb", "spec/temp/brainz.b", "Manifest"]
-  s.homepage = "https://github.com/ViliusLuneckas/brainz/"
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Brainz", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = "brainz"
-  s.rubygems_version = "1.8.19"
-  s.summary = "Simple artificial intelligence"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "brainz"
+  gem.require_paths = ["lib"]
+  gem.version       = Brainz::VERSION
+  %w(rspec mocha).each do |gem_name|
+    gem.add_development_dependency gem_name
   end
 end

data/examples/and.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/brainz'
+require 'brainz'
 
 # AND problem
 

data/examples/multi_layer_xor.rb

@@ -1,5 +1,4 @@
-require_relative '../lib/brainz'
-
+require 'brainz'
 
 brainz = Brainz::Brainz.new
 

data/examples/sign.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/brainz'
+require 'brainz'
 
 # SIGN function
 

data/examples/xor.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/brainz'
+require 'brainz'
 
 # XOR problem
 
@@ -11,4 +11,4 @@ brainz.teach(learning_rate: 0.2, momentum: 0.01, wanted_error: 0.01, max_iterati
   that(0, 0).is(0)
 end
 
-p "Learning took #{brainz.last_iterations}, error: #{brainz.error}, time: #{brainz.learning_time} s."
+p "Learning took #{brainz.last_iterations}, error: #{brainz.error}, time: #{brainz.learning_time} s."

data/lib/brainz.rb

@@ -1,10 +1,13 @@
-require_relative 'ext/array.rb'
+require "brainz/version"
+require "ext/array"
 
-require_relative 'brainz/version.rb'
-require_relative 'brainz/backpropagation.rb'
-require_relative 'brainz/synapse.rb'
-require_relative 'brainz/neuron.rb'
-require_relative 'brainz/layer'
-require_relative 'brainz/network'
-require_relative 'brainz/brainz.rb'
-require_relative 'brainz/loader.rb'
+module Brainz
+  require "brainz/algorithms"
+  require "brainz/algorithms/backpropagation"
+  require "brainz/synapse"
+  require "brainz/neuron"
+  require "brainz/layer"
+  require "brainz/network"
+  require "brainz/brainz"
+  require "brainz/loader"
+end

data/lib/brainz/algorithms.rb

@@ -0,0 +1,4 @@
+module Brainz
+  module Algorithms
+  end
+end

data/lib/brainz/brainz.rb

@@ -139,9 +139,5 @@ end
 
 
 def self.method_missing(meth = nil, *args, &block)
-  if meth == :that
-    Brainz::Brainz.current.send(meth, *args)
-  else
-    raise NoMethodError
-  end
-end
+  meth == :that ? Brainz::Brainz.current.send(meth, *args) : super
+end

data/lib/brainz/network.rb

@@ -1,6 +1,5 @@
 module Brainz
   class Network
-    # layers
     attr_reader :input, :hidden, :output
 
     attr_accessor :training_algorithm, :learning_rate, :momentum, :mse
@@ -46,4 +45,4 @@ module Brainz
       output.adjust_weights
     end
   end
-end
+end

data/lib/brainz/version.rb

@@ -1,3 +1,3 @@
 module Brainz
-  VERSION = '0.1.2'
-end
+  VERSION = '0.1.3'
+end

data/spec/{array_spec.rb → ext/array_spec.rb}

@@ -1,4 +1,4 @@
-require_relative '../spec/spec_helper'
+require 'spec_helper'
 
 describe Array do
   describe "#to_hash" do
@@ -6,4 +6,4 @@ describe Array do
       [1, 2, 3].to_hash([:a, :b, :c]).should == {a: 1, b: 2, c: 3}
     end
   end
-end
+end

data/spec/{brainz_spec.rb → lib/brainz_spec.rb}

@@ -1,4 +1,4 @@
-require_relative '../spec/spec_helper'
+require 'spec_helper'
 
 describe Brainz::Brainz do
   subject { Brainz::Brainz.new }
@@ -79,40 +79,6 @@ describe Brainz::Brainz do
     end
   end
 
-
-  describe "#update" do
-
-    before do
-      pending
-      subject.stubs(num_hidden: 2, num_output: 1)
-    end
-
-    it "should return subject" do
-      subject.update([]).should == subject
-    end
-
-    it "should create weight matrices" do
-      Kernel.stubs(rand: 0)
-      expect {
-        expect {
-          subject.update([1.0, 1.0])
-        }.to change { subject.input_weights }.from(nil).to([[-0.2, -0.2], [-0.2, -0.2], [-0.2, -0.2]])
-      }.to change { subject.output_weights }.from(nil).to([[-2], [-2]])
-    end
-
-    it "should create input weights matrix size of input and hidden" do
-      matrix = subject.update([0, 1, 0]).input_weights
-      matrix.size.should == 4
-      matrix[0].size.should == 2
-    end
-
-    it "should create output weights matrix size of hidden and output" do
-      matrix = subject.update([0, 1, 0]).output_weights
-      matrix.size.should == 2
-      matrix[0].size.should == 1
-    end
-  end
-
   describe "xor" do
     it "should learn xor" do
       subject.teach do

data/spec/lib/loader_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe "loader" do
+  let(:file_path) { File.expand_path('spec/fixtures/brainz.b') }
+
+  subject { Brainz::Brainz.new }
+
+  before do
+    FileUtils.rm_rf(file_path)
+
+    subject.teach do
+      subject.that(a: 1, b: 1).is(0)
+      subject.that(1, 0).is(1)
+      subject.that(0, 1).is(1)
+      subject.that(0, 0).is(0)
+    end
+  end
+
+  after do
+    FileUtils.rm_rf(file_path)
+  end
+
+  it "should work after load" do
+    results_before_saving = []
+    results_before_saving << subject.explain(a: 0, b: 0).first.round
+    results_before_saving << subject.explain(a: 0, b: 1).first.round
+    results_before_saving << subject.explain(a: 1, b: 1).first.round
+    results_before_saving << subject.explain(a: 1, b: 0).first.round
+
+    subject.save(file_path)
+    loaded_brainz = Brainz::Brainz.load(file_path)
+
+    results_after_load = []
+    results_after_load << subject.explain(a: 0, b: 0).first.round
+    results_after_load << subject.explain(a: 0, b: 1).first.round
+    results_after_load << subject.explain(a: 1, b: 1).first.round
+    results_after_load << subject.explain(a: 1, b: 0).first.round
+
+    results_before_saving.should == results_after_load
+  end
+end

data/spec/lib/neuron_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Brainz::Neuron do
+  before do
+    @brainz = Brainz::Brainz.new
+    @brainz.stubs(num_input: 2, num_output: 2, learning_rate: 1.66, momentum: 0.123)
+    @brainz.initialize_network
+  end
+
+  subject { @brainz.network.input.neurons.first }
+
+  it "should return learning rate of brainz" do
+    subject.learning_rate.should == 1.66
+  end
+
+  it "should return momentum of brainz" do
+    subject.momentum.should == 0.123
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'rspec'
-require 'mocha'
-require_relative '../lib/brainz'
+require 'mocha_standalone'
+require 'brainz'
 
 RSpec.configure do |config|
   config.mock_with :mocha
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brainz
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-26 00:00:00.000000000 Z
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -43,26 +43,17 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple artificial intelligence
-email: vilius.luneckas@gmail.com
+description: Artificial Neural Network library written in Ruby
+email:
+- vilius.luneckas@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
-- lib/brainz.rb
-- lib/brainz/backpropagation.rb
-- lib/brainz/brainz.rb
-- lib/brainz/layer.rb
-- lib/brainz/loader.rb
-- lib/brainz/network.rb
-- lib/brainz/neuron.rb
-- lib/brainz/synapse.rb
-- lib/brainz/version.rb
-- lib/ext/array.rb
+extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - brainz.gemspec
 - examples/and.rb
@@ -70,7 +61,8 @@ files:
 - examples/sign.rb
 - examples/xor.rb
 - lib/brainz.rb
-- lib/brainz/backpropagation.rb
+- lib/brainz/algorithms.rb
+- lib/brainz/algorithms/backpropagation.rb
 - lib/brainz/brainz.rb
 - lib/brainz/layer.rb
 - lib/brainz/loader.rb
@@ -79,23 +71,16 @@ files:
 - lib/brainz/synapse.rb
 - lib/brainz/version.rb
 - lib/ext/array.rb
-- spec/array_spec.rb
-- spec/brainz_spec.rb
-- spec/loader_spec.rb
-- spec/neuron_spec.rb
+- spec/ext/array_spec.rb
+- spec/fixtures/.gitkeep
+- spec/lib/brainz_spec.rb
+- spec/lib/loader_spec.rb
+- spec/lib/neuron_spec.rb
 - spec/spec_helper.rb
-- spec/temp/brainz.b
-- Manifest
 homepage: https://github.com/ViliusLuneckas/brainz/
 licenses: []
 post_install_message: 
-rdoc_options:
-- --line-numbers
-- --inline-source
-- --title
-- Brainz
-- --main
-- README.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -109,11 +94,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '1.2'
+      version: '0'
 requirements: []
-rubyforge_project: brainz
-rubygems_version: 1.8.19
+rubyforge_project: 
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Simple artificial intelligence
-test_files: []
+summary: Artificial Neural Network library written in Ruby
+test_files:
+- spec/ext/array_spec.rb
+- spec/fixtures/.gitkeep
+- spec/lib/brainz_spec.rb
+- spec/lib/loader_spec.rb
+- spec/lib/neuron_spec.rb
+- spec/spec_helper.rb

data/Manifest

@@ -1,25 +0,0 @@
-LICENSE
-README.rdoc
-Rakefile
-brainz.gemspec
-examples/and.rb
-examples/multi_layer_xor.rb
-examples/sign.rb
-examples/xor.rb
-lib/brainz.rb
-lib/brainz/backpropagation.rb
-lib/brainz/brainz.rb
-lib/brainz/layer.rb
-lib/brainz/loader.rb
-lib/brainz/network.rb
-lib/brainz/neuron.rb
-lib/brainz/synapse.rb
-lib/brainz/version.rb
-lib/ext/array.rb
-spec/array_spec.rb
-spec/brainz_spec.rb
-spec/loader_spec.rb
-spec/neuron_spec.rb
-spec/spec_helper.rb
-spec/temp/brainz.b
-Manifest

data/README.rdoc

@@ -1,20 +0,0 @@
-= brainz
-
-Artificial Neural Network Library for Ruby programming language.
-
-== Supported algorithms
-* Backpropagation
-
-== Contributing to brainz
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Vilius Luneckas. See LICENSE for further details.

data/spec/loader_spec.rb

@@ -1,31 +0,0 @@
-require_relative '../spec/spec_helper'
-require 'fileutils'
-
-describe "loader" do
-  describe "xor" do
-    subject { Brainz::Brainz.new }
-
-    it "should work after load" do
-      subject.teach do
-        subject.that(a: 1, b: 1).is(0)
-        subject.that(1, 0).is(1)
-        subject.that(0, 1).is(1)
-        subject.that(0, 0).is(0)
-      end
-
-      subject.explain(a: 0, b: 0).first.round.should == 0
-      subject.explain(a: 0, b: 1).first.round.should == 1
-      subject.explain(a: 1, b: 1).first.round.should == 0
-      subject.explain(a: 1, b: 0).first.round.should == 1
-
-      subject.save(File.expand_path('.', 'temp/brainz.b'))
-
-
-      old_brainz = Brainz::Brainz.load(File.expand_path('.', 'temp/brainz.b'))
-      old_brainz.explain(a: 0, b: 0).first.round.should == 0
-      old_brainz.explain(a: 0, b: 1).first.round.should == 1
-      old_brainz.explain(a: 1, b: 1).first.round.should == 0
-      old_brainz.explain(a: 1, b: 0).first.round.should == 1
-    end
-  end
-end

data/spec/neuron_spec.rb

@@ -1,18 +0,0 @@
-require_relative '../spec/spec_helper'
-
-describe Brainz::Neuron do
-  before do
-    brainz = Brainz::Brainz.new
-    brainz.stubs(num_input: 2, num_output: 2, learning_rate: 1.66, momentum: 0.123)
-    brainz.initialize_network
-    @neuron = brainz.network.input.neurons.first
-  end
-
-  it "should get learning rate from brainz" do
-    @neuron.learning_rate.should == 1.66
-  end
-
-  it "should get momentum from brainz" do
-    @neuron.momentum.should == 0.123
-  end
-end