ruby-fann 1.2.3 → 1.2.4

data/README.md

@@ -18,25 +18,38 @@ Or install it yourself as:
 
 ## Usage
 
+First, Go here & read about FANN. You don't need to install it before using the gem, but understanding FANN will help you understand what you can do with the ruby-fann gem:
+http://leenissen.dk/fann/
+
 ### Example training & subsequent execution:
   
 ```ruby
   require 'ruby-fann'
   train = RubyFann::TrainData.new(:inputs=>[[0.3, 0.4, 0.5], [0.1, 0.2, 0.3]], :desired_outputs=>[[0.7], [0.8]])
-  fann = RubyFann::Standard.new(:num_inputs=>5, :hidden_neurons=>[2, 8, 4, 3, 4], :num_outputs=>1)
-  fann.train_on_data(train, 1000, 10, 0.1)
+  fann = RubyFann::Standard.new(:num_inputs=>3, :hidden_neurons=>[2, 8, 4, 3, 4], :num_outputs=>1)
+  fann.train_on_data(train, 1000, 10, 0.1) # 1000 max_epochs, 10 errors between reports and 0.1 desired MSE (mean-squared-error)
   outputs = fann.run([0.3, 0.2, 0.4])    
 ```
 
-### Save trained NN to file and use it later (continued from above)
+### Save training data to file and use it later (continued from above)
 
 ```ruby
   train.save('verify.train')
   train = RubyFann::TrainData.new(:filename=>'verify.train')
-  outputs = fann.run([0.1, 0.9, 0.4])    
+  # Train again with 10000 max_epochs, 20 errors between reports and 0.01 desired MSE (mean-squared-error)
+  # This will take longer:
+  fann.train_on_data(train, 10000, 20, 0.01) 
+```
+
+### Save trained network to file and use it later (continued from above)
+
+```ruby
+  fann.save('foo.net')
+  saved_nn = RubyFann::Standard.new(:filename=>"foo.net")
+  saved_nn.run([0.3, 0.2, 0.4])  
 ```
   
-### Now implements a callback method
+### Custom training using a callback method
 
 This callback function can be called during training when using train_on_data, train_on_file or cascadetrain_on_data.
 
@@ -54,6 +67,13 @@ class MyFann < RubyFann::Standard
   end
 end
 ```
+### A sample project using Ruby Fann to play tic-tac-toe
+https://github.com/bigohstudios/tictactoe
+
+## Documentation
+http://ruby-fann.rubyforge.org/
+
+
 
 ## Contributing
 

data/lib/ruby_fann/neurotica.rb

@@ -48,9 +48,12 @@ module RubyFann
         fillcolor = "transparent"  # : "khaki3"
         layer = neuron[:layer]
         fillcolor = case layer
-          when 0: @input_layer_color
-          when max_layer: @output_layer_color
-          else; @hidden_layer_colors[(layer-1) % @hidden_layer_colors.length]
+          when 0
+            @input_layer_color
+          when max_layer
+            @output_layer_color
+          else
+            @hidden_layer_colors[(layer-1) % @hidden_layer_colors.length]
         end
         
         #puts "adding neuron with #{neuron[:value]}"

data/lib/ruby_fann/version.rb

@@ -2,7 +2,7 @@ module RubyFann
   module VERSION
     MAJOR = 1
     MINOR = 2
-    TINY  = 3
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-fann
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies: []
 description: Bindings to use FANN from within ruby/rails environment
 email:
@@ -67,8 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubyforge_project: ruby-fann
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Bindings to use FANN from within ruby/rails environment.  Fann is a is a