som 0.0.3 → 0.0.4

data/README.rdoc

@@ -32,13 +32,31 @@ A pure Ruby implementation of the Self Organising Map machine learning algorithm
   a.inspect
     #=> [[0, [1, 0...]], [1, [99, 84...]], [2, [11, 23...]]]
     
+You can also save your SOM and load a previously save SOM:
+
+  require 'rubygems'
+  require 'som'
+  
+  data = [[1,2,3], [4,5,6]...]
+  
+  a = SOM.new(data, :number_of_nodes => 4, 
+                    :dimensions => 3,
+                    :save_to => 'file_path/to/here.som')
+
+  a.train # Saves it
+  
+  b = SOM.load('file_path/to/here.som') # Loads it
+  
+  b.classify(new_data) # etc...
+    
 == Options
 
   SOM.new(data, :number_of_nodes => 1,   #Default: 5
                 :learning_rate => 0.7,   #Default: 0.5
                 :radius => 1,            #Default: number_of_nodes / 2
                 :max_iterations => 100,  #Default: 100
-                :verbose => true)        #Default: false
+                :verbose => true,        #Default: false
+                :save_to => 'file_path') #Default: nil
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/examples/example.rb

@@ -17,17 +17,16 @@ SOM_DATA.each do |n|
   data << normalizer.normalize(n)
 end
   
-a = SOM.new(data, :nodes => 8, 
-                  :radius => 0.8)
+a = SOM.new(data, :nodes => 8)
 
-puts a.global_distance_error
+#puts a.global_distance_error
 
 times = Benchmark.measure do
   a.train
 end
 
-puts a.global_distance_error
+#puts a.global_distance_error
 
 #puts a.nodes.inspect
 
-puts times
+#puts times

data/lib/som.rb

@@ -2,6 +2,18 @@ require File.expand_path(File.dirname(__FILE__) + '/som/node')
 
 class SOM
   
+  class << self
+    def load(db_filepath)
+      data = ""
+      File.open(db_filepath) do |f|
+        while line = f.gets
+          data << line
+        end
+      end
+      Marshal.load(data)
+    end
+  end
+  
   def initialize(training_data, options={})
     @training_data = training_data
     @dimensions = training_data[0].size
@@ -9,9 +21,10 @@ class SOM
     
     # Options
     @number_of_nodes = options[:nodes] || 5
-    @learning_rate = options[:learning_rate] || 0.5
+    @learning_rate = options[:learning_rate] || 0.7
     @radius = options[:radius] || @number_of_nodes / 2
     @max_iterations = options[:max_iterations] || 100
+    @db_filepath = options[:save_to]
     
     # TODO: Allow a lambda so we can use different neighborhood functions
     @neighborhood_function = 1 #options[:neighborhood_function] || 1
@@ -30,6 +43,7 @@ class SOM
     # Place the data in the nodes buckets so we can see how
     # The data has been clustered
     place_data_into_buckets(@training_data)
+    save
   end
   
   # Returns an array of buckets containing the index of the training data
@@ -56,6 +70,14 @@ class SOM
   
   private
   
+  def save
+    if @db_filepath
+      File.open(@db_filepath, "w+") do |f|
+        f.write Marshal.dump(self)
+      end
+    end
+  end
+  
   def train_it!(data)
     return false if @iteration_count >= @max_iterations
     
@@ -73,9 +95,12 @@ class SOM
       # Update nodes that closer than the radius
       other_nodes = nodes - [closest_node]
       other_nodes.each_with_index do |node, index|
-        next if node.distance_from(closest_node.weights) > decayed_radius
+        distance_from_node = node.distance_from(closest_node.weights)
+        print_message("\t\tDistance from node: #{distance_from_node}")
+        
+        next if distance_from_node > decayed_radius
         
-        print_message("\t\tUpdating other nodes: #{index+1}/#{other_nodes.size}")
+        print_message("\t\t\tUpdating other nodes: #{index+1}/#{other_nodes.size}")
         
         node.update_weight(@learning_rate, input, neighborhood_function)
       end

data/som.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{som}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["reddavis"]
-  s.date = %q{2009-11-30}
+  s.date = %q{2010-01-05}
   s.description = %q{A Self Organising Map}
   s.email = %q{reddavis@gmail.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/som.rb",
      "lib/som/node.rb",
      "som.gemspec",
+     "spec/db/som.som",
      "spec/node_spec.rb",
      "spec/som_spec.rb",
      "spec/spec.opts",

data/spec/som_spec.rb

@@ -89,4 +89,36 @@ describe "Som" do
       @a.global_distance_error.should be_a(Float)
     end
   end
+  
+  describe "Saving" do
+    before do
+      data = [[0,0], [999,999]]
+      @a = SOM.new(data, :nodes => 5, :save_to => save_to_filepath)
+    end
+    
+    it "should save the SOM where specified" do
+      FileUtils.rm(save_to_filepath, :force => true)
+      @a.train
+      File.exists?(save_to_filepath).should be_true
+    end
+  end
+  
+  describe "Loading" do
+    before do |variable|
+      data = [[0,0], [999,999]]
+      a = SOM.new(data, :nodes => 5, :save_to => save_to_filepath)
+      a.train
+    end
+    
+    it "should have 5 nodes" do
+      a = SOM.load(save_to_filepath)
+      a.nodes.size.should == 5
+    end
+  end
+  
+  private
+  
+  def save_to_filepath
+    File.expand_path(File.dirname(__FILE__) + '/db/som.som')
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: som
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - reddavis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-30 00:00:00 +00:00
+date: 2010-01-05 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - lib/som.rb
 - lib/som/node.rb
 - som.gemspec
+- spec/db/som.som
 - spec/node_spec.rb
 - spec/som_spec.rb
 - spec/spec.opts