libsvmffi 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Robert Berry
+
+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 without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.

data/README

@@ -0,0 +1,37 @@
+== Introduction
+
+This is alpha grade software.
+
+Under development.  But simple use cases may be worth checking out.
+
+http://www.csie.ntu.edu.tw/~cjlin/libsvm/
+
+libsvm version 310
+
+
+== Installation
+
+1.  download (see url above)
+2.  make lib
+3.  place .so in load path
+
+gem install libsvmffi
+
+== Usage
+
+#> require 'libsvmffi'
+
+#> m = Libsvmffi::Model.new
+#> m.add :good, {:height => 1, :width => 1, :length => 1}
+#> m.add :bad, {:height => 10, :width => 3, :length => 6}
+#> m.train
+
+#> m.classify({:height => 1, :width => 1.1, :length => 1})
+#=> :good
+
+
+== Source Code
+ 
+https://github.com/bdigital/libsvmffi
+
+Assistance developing is welcome.

data/lib/libsvmffi/model.rb

@@ -0,0 +1,156 @@
+module Libsvmffi
+  #
+  #
+  #
+  class Model
+ 
+    attr_accessor :parameters, :problem, :svm_model
+    attr_accessor :examples
+    attr_accessor :labels, :features 
+    attr_accessor :elements, :x_space
+    
+    attr_accessor :nodes, :x
+
+    def initialize(options = {})
+
+      @parameters = Parameters.new      
+      
+      # TODO merge defaults options hash.
+      @parameters[:svm_type] = C_SVC;
+      @parameters[:kernel_type] = RBF;
+      @parameters[:degree] = 3;
+      @parameters[:gamma] = 0;  # 1/num_features
+      @parameters[:coef0] = 0;
+      @parameters[:nu] = 0.5;
+      @parameters[:cache_size] = 100;
+      @parameters[:C] = 1;
+      @parameters[:eps] = 0.001;
+      @parameters[:p] = 0.1;
+      @parameters[:shrinking] = 1;
+      @parameters[:probability] = 0;
+      @parameters[:nr_weight] = 0;
+      @parameters[:weight_label] = nil;
+      @parameters[:weight] = nil;
+      
+      @elements = 0
+      @examples, @labels, @features = [], [], []
+      
+      @nodes = []
+    end
+
+    #
+    # Adds an example which will be used upon trainining
+    #
+    def add(label, features)
+      @labels.push label unless @labels.include? label
+      indexed_features = {}
+      features.each do |k, v|
+        @features.push k unless @features.include? k
+        indexed_features[@features.index(k)] = v
+      end
+
+      @examples.push({@labels.index(label) => indexed_features})
+
+      @elements += features.length + 1 # also -1 terminator, see libsvm readme.
+    end
+
+    #
+    # Build libsvm model
+    # 
+    def train
+
+      @problem = Problem.new
+      @problem[:l] = @examples.length
+      @problem[:y] = FFI::MemoryPointer.new(:double, @problem[:l])
+      @x = FFI::MemoryPointer.new(:pointer, @problem[:l])
+      @problem[:x] = x.address #FFI::MemoryPointer.new(:pointer, @problem[:l])
+      @x_space = FFI::MemoryPointer.new(Node, @elements) 
+
+      y = @examples.map {|e| e.keys.first}
+      @problem[:y].put_array_of_double 0, y
+
+      i = 0
+      space_index = 0
+      examples.each do |ex| #TODO clean up this hash structure
+        ex.each do |e|
+          @x[i].write_pointer @x_space[space_index]
+          i += 1          
+ 
+          features = e.last.merge({-1 => 0}) #terminator
+          features.each do |k, v|
+            n = Node.new @x_space[space_index]
+            n[:index] = k
+            n[:value] = v
+            space_index += 1
+            
+            @nodes.push n
+          end
+        end
+      end
+      
+      @parameters[:gamma] = 1 / @features.length.to_f
+      
+      @svm_model = Libsvmffi.svm_train @problem.pointer, @parameters.pointer
+      
+    end
+
+    #
+    #
+    #
+    def classify(features)   
+      nodes = fton(features) 
+      label_index = Libsvmffi.svm_predict @svm_model, nodes
+      @labels[label_index.to_i]
+    end
+    
+
+    #
+    # Save to file
+    #
+    def save(filename = "model.out")
+      Libsvmffi.svm_save_model FFI::MemoryPointer.from_string(filename), @svm_model
+    end
+    
+    #
+    # Add training examples from a libsvm training format file
+    #
+    def add_from_file(filename)
+      f = File.open filename, 'r'
+      f.lines.each do |l|
+        tokens = l.split " "
+        label = tokens.shift
+        features = {}
+        tokens.each do |t|
+          index, value = t.split(":")
+          features[index.to_i] = value.to_f
+        end
+        self.add label, features 
+      end
+    end
+   
+    #
+    # Features to array of node struct (currently factored just for debugging, only used in predict)
+    #
+    def fton(features)
+    
+     indexed_features = {}
+      features.each do |k, v|
+        indexed_features[@features.index(k)] = v unless !@features.include? k
+      end
+      
+      nodes = FFI::MemoryPointer.new(Node, indexed_features.length + 1)
+      indexed_features = indexed_features.merge({-1 => 0}) #terminator
+      i = 0
+      indexed_features.each do |k, v|
+        n = Node.new nodes[i]
+        n[:index] = k
+        n[:value] = v
+        i += 1
+      end
+      
+      return nodes
+      
+    end
+   
+  end
+end

data/lib/libsvmffi/node.rb

@@ -0,0 +1,6 @@
+module Libsvmffi
+  class Node < FFI::Struct
+    layout :index, :int,
+           :value, :double
+  end
+end

data/lib/libsvmffi/parameters.rb

@@ -0,0 +1,19 @@
+module Libsvmffi
+  class Parameters < FFI::Struct
+    layout :svm_type, :int,
+         :kernel_type, :int,
+         :degree, :int,           # for poly
+         :gamma, :double,         # for poly/rbf/sigmoid
+         :coef0, :double,         # for poly/sigmoid
+         :cache_size, :double ,   # in MB
+         :eps, :double,           # stopping criteria
+         :C, :double,             # for C_SVC, EPSILON_SVR and NU_SVR
+         :nr_weight, :int,        # for C_SVC
+         :weight_label, :pointer, # int for C_SVC
+         :weight, :pointer,       # double for C_SVC
+         :nu, :double,            # for NU_SVC, ONE_CLASS, and NU_SVR
+         :p, :double,             # for EPSILON_SVR
+         :shrinking, :int,        # use the shrinking heuristics
+         :probability, :int       # do probability estimates
+  end
+end

data/lib/libsvmffi/problem.rb

@@ -0,0 +1,7 @@
+module Libsvmffi
+  class Problem < FFI::Struct
+    layout :l, :int,
+          :y, :pointer,
+          :x, :pointer # svm_node
+  end
+end

data/lib/libsvmffi.rb

@@ -0,0 +1,38 @@
+require 'ffi'
+require 'libsvmffi/problem'
+require 'libsvmffi/parameters'
+require 'libsvmffi/node'
+require 'libsvmffi/model'
+
+
+module Libsvmffi
+
+  extend FFI::Library
+  ffi_lib 'svm' # REVIEW
+
+  C_SVC, NU_SVC, ONE_CLASS, EPSILON_SVR, NU_SVR = 0, 1, 2, 3, 4 # SVM Type
+  LINEAR, POLY, RBF, SIGMOID, PRECOMPUTED = 0, 1, 2, 3, 4       # Kernel Type
+
+  attach_function 'svm_train', [:pointer, :pointer], :pointer
+
+  attach_function 'svm_cross_validation', [:pointer, :pointer, :int, :pointer], :void
+
+  attach_function 'svm_save_model', [:pointer, :pointer], :int
+  attach_function 'svm_load_model', [:pointer], :pointer
+
+  attach_function 'svm_get_svm_type', [:pointer], :int
+  attach_function 'svm_get_nr_class', [:pointer], :int
+  attach_function 'svm_get_labels', [:pointer, :pointer], :void
+  attach_function 'svm_get_svr_probability', [:pointer], :double
+
+  attach_function 'svm_predict', [:pointer, :pointer], :double
+  attach_function 'svm_predict_values', [:pointer, :pointer, :pointer], :void
+  attach_function 'svm_predict_probability', [:pointer, :pointer, :pointer], :double
+
+  attach_function 'svm_free_and_destroy_model', [:pointer], :void
+  attach_function 'svm_destroy_param', [:pointer], :void
+
+  attach_function 'svm_check_parameter', [:pointer, :pointer], :pointer
+  attach_function 'svm_check_probability_model', [:pointer], :int
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: libsvmffi
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Robert Berry
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-01 00:00:00 Z
+dependencies: []
+
+description: SVM operations.
+email: berrydigital@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/libsvmffi.rb
+- lib/libsvmffi/problem.rb
+- lib/libsvmffi/node.rb
+- lib/libsvmffi/parameters.rb
+- lib/libsvmffi/model.rb
+- README
+- LICENSE
+homepage: http://github.com/bdigital/libsvmffi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Libsvm ffi bindings
+test_files: []
+
+has_rdoc: false