ruby-fann 1.2.1 → 1.2.2

data/README.md

@@ -0,0 +1,64 @@
+# Ruby::Fann
+
+Bindings to use FANN from within ruby/rails environment.  Fann is a is a free open source neural network library, which implements multilayer artificial neural networks with support for both fully connected and sparsely connected networks.  It is easy to use, versatile, well documented, and fast.  RubyFann makes working with neural networks a breeze using ruby, with the added benefit that most of the heavy lifting is done natively.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-fann'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-fann
+
+## Usage
+
+### 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)
+  outputs = fann.run([0.3, 0.2, 0.4])    
+```
+
+### Save trained NN 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])    
+```
+  
+### Now implements a callback method
+
+This callback function can be called during training when using train_on_data, train_on_file or cascadetrain_on_data.
+
+It is very useful for doing custom things during training.  It is recommended to use this function when implementing custom training procedures, or when visualizing the training in a GUI etc.  The args which the callback function takes is the parameters given to the train_on_data, plus an epochs parameter which tells how many epochs the training have taken so far.
+
+The callback method should return an integer, if the callback function returns -1, the training will terminate.
+
+The callback (training_callback) will be automatically called if it is implemented on your subclass as follows:
+
+```ruby
+class MyFann < RubyFann::Standard
+  def training_callback(args)
+    puts "ARGS: #{args.inspect}"
+    0  
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/ruby_fann/version.rb

@@ -2,7 +2,7 @@ module RubyFann #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 2
-    TINY  = 1
+    TINY  = 2
 
     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.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -17,7 +17,9 @@ email:
 executables: []
 extensions:
 - ext/ruby_fann/extconf.rb
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- ext/ruby_fann/ruby_fann.c
 files:
 - lib/ruby-fann.rb
 - lib/ruby_fann/neurotica.rb
@@ -44,6 +46,7 @@ files:
 - ext/ruby_fann/fann_train.h
 - ext/ruby_fann/ruby_compat.h
 - ext/ruby_fann/extconf.rb
+- README.md
 homepage: http://github.com/tangledpath/ruby-fann
 licenses: []
 post_install_message: