rb-libsvm 1.0.1

data/lib/libsvm.rb

@@ -0,0 +1,63 @@
+require 'rb-libsvm/version'
+require 'rb-libsvm/libsvm'
+
+module Libsvm
+
+  module CoreExtensions
+    module Collection
+      def to_example
+        Node.features(self)
+      end
+    end
+  end
+
+  class Node
+
+    class << self
+
+      def features(*vargs)
+        array_of_nodes = []
+				if vargs.size == 1
+					if vargs.first.class == Array
+						vargs.first.each_with_index do |value, index|
+							array_of_nodes << Node.new(index.to_i, value.to_f)
+						end
+					elsif vargs.first.class == Hash
+						vargs.first.each do |index, value|
+							array_of_nodes << Node.new(index.to_i, value.to_f)
+						end
+					else
+						raise(ArgumentError.new("Node features need to be a Hash, Array or Floats"))
+					end
+				else
+					vargs.each_with_index do |value, index|
+						array_of_nodes << Node.new(index.to_i, value.to_f)
+					end
+				end
+				array_of_nodes
+      end
+
+      def [](index, value)
+        new(index, value)
+      end
+    end
+
+    def initialize(index=0, value=0.0)
+      self.index = index
+      self.value = value
+    end
+
+    def ==(other)
+      index == other.index && value == other.value
+    end
+  end
+
+end
+
+
+class Hash
+  include Libsvm::CoreExtensions::Collection
+end
+class Array
+  include Libsvm::CoreExtensions::Collection
+end

data/lib/rb-libsvm/version.rb

@@ -0,0 +1,3 @@
+module Libsvm
+  VERSION = "1.0.1"
+end

data/rb-libsvm.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'rb-libsvm/version'
+
+Gem::Specification.new do |s|
+  s.name        = "rb-libsvm"
+  s.version     = Libsvm::VERSION
+  s.authors     = ["C. Florian Ebeling", "Rimas Silkaitis"]
+  s.email       = ["neovintage@gmail.com"]
+  s.homepage    = "https://github.com/febeling/rb-libsvm"
+  s.summary     = %q{Ruby language bindings for LIBSVM}
+  s.description = %q{libsvm and ruby without using swig}
+
+  s.rubyforge_project = "rb-libsvm"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake-compiler"
+  s.add_development_dependency "rspec", "2.7.0"
+
+  s.extensions << 'ext/rb-libsvm/extconf.rb'
+end
+

data/spec/model_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+
+module ModelSpecHelper
+
+	def create_example
+		Node.features(0.2, 0.3, 0.4, 0.5)
+	end
+
+	def create_problem
+		problem = Problem.new
+		features = [Node.features([0.2,0.3,0.4,0.4]),
+								Node.features([0.1,0.5,0.1,0.9]),
+								Node.features([0.2,0.2,0.6,0.5]),
+								Node.features([0.3,0.1,0.5,0.9])]
+		problem.set_examples([1,2,1,2], features)
+		problem
+	end
+
+	def create_parameter
+		parameter = SvmParameter.new
+		parameter.cache_size = 50 # mb
+		parameter.eps = 0.01
+		parameter.c = 10
+		parameter
+	end
+
+end
+
+describe "The Libsvm::Model class interface" do
+	include ModelSpecHelper
+
+	before(:each) do
+		@problem = create_problem
+		@parameter = create_parameter
+	end
+
+	it "results from training on a problem under a certain parameter set" do
+		model = Model.train(@problem,@parameter)
+		model.should_not be_nil
+	end
+
+	it "can do cross-validation" do
+		labels = Model.cross_validation(@problem, @parameter, fold=2)
+		labels.should == [anything, anything, anything, anything]
+	end
+end
+
+describe "A saved model" do
+	include ModelSpecHelper
+
+	before(:each) do
+		@filename = "svm_model.model"
+		model = Model.train(create_problem, create_parameter)
+		model.save(@filename)
+	end
+
+	it "can be loaded" do
+		model = Model.load(@filename)
+		model.should_not be_nil
+	end
+
+	after(:each) do
+		File.delete(@filename) rescue nil
+	end
+end
+
+describe "An Libsvm model" do
+	include ModelSpecHelper
+
+	before(:each) do
+		@problem = create_problem
+		@parameter = create_parameter
+		@model = Model.train(@problem, @parameter)
+	end
+
+	it "can be saved to a file" do
+		file_path = "svm_model.model"
+		@model.save(file_path)
+		File.exist?(file_path).should be_true
+	end
+
+	it "can be asked for it's svm_type" do
+		@model.svm_type.should == SvmType::C_SVC
+	end
+
+	it "can be asked for it's number of classes (aka. labels)" do
+		@model.classes.should == 2
+	end
+
+	it "can predict" do
+		prediction = @model.predict(create_example)
+		prediction.should_not be_nil
+	end
+end
+

data/spec/node_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe "construction of a Node" do
+	it "using the properties" do
+		n = Node.new
+		n.index = 11
+		n.value = 0.11
+		n.index.should == 11
+		n.value.should be_within(0.0001).of(0.11)
+	end
+
+	it "using the :[] method" do
+		n = Node[12, 0.12]
+		n.index.should == 12
+		n.value.should be_within(0.00001).of(0.12)
+	end
+
+	it "using the constructor parameters" do
+		n = Node.new(14, 0.14)
+		n.index.should == 14
+		n.value.should be_within(0.0001).of(0.14)
+	end
+end
+
+describe "A Node" do
+	before do
+		@node = Node.new
+	end
+
+	it "can be created" do
+		@node.should_not be_nil
+	end
+
+	it "does not segfault on setting properties" do
+		@node.index = 99
+		@node.index.should == 99
+		@node.value = 3.141
+		@node.value.should be_within(0.00001).of(3.141)
+	end
+
+	it "has inited properties" do
+		@node.index.should == 0
+		@node.value.should be_within(0.00001).of(0)
+	end
+
+	it "class can create nodes from an array" do
+		ary = Node.features([0.1, 0.2, 0.3, 0.4, 0.5])
+		ary.map {|n| n.class.should == Node}
+		ary.map {|n| n.value }.should == [0.1, 0.2, 0.3, 0.4, 0.5]
+	end
+
+	it "class can create nodes from variable parameters" do
+		ary = Node.features(0.1, 0.2, 0.3, 0.4, 0.5)
+		ary.map {|n| Node.should === n }
+		ary.map {|n| n.value }.should == [0.1, 0.2, 0.3, 0.4, 0.5]
+	end
+
+	it "class can create nodes from hash" do
+		ary = Node.features(3=>0.3, 5=>0.5, 6=>0.6, 10=>1.0)
+		ary.map {|n| n.class.should == Node}
+		ary.map {|n| n.value }.sort.should == [0.3, 0.5, 0.6, 1.0]
+		ary.map {|n| n.index }.sort.should == [3, 5, 6, 10]
+	end
+
+	it "implements a value-like equality, not identity-notion" do
+		Node[1, 0.1].should == Node[1, 0.1]
+	end
+end

data/spec/parameter_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe "A Parameter has accessors for" do
+	before do
+		@p = Libsvm::SvmParameter.new
+	end
+	it "int svm_type" do
+		SvmType::C_SVC.should == 0
+		@p.svm_type = SvmType::C_SVC
+		@p.svm_type.should == SvmType::C_SVC
+	end
+
+	it "int kernel_type" do
+		KernelType::RBF.should == 2
+		@p.kernel_type = KernelType::RBF
+		@p.kernel_type.should == KernelType::RBF
+	end
+
+	it "int degree" do
+		@p.degree = 99
+		@p.degree.should == 99
+	end
+
+	it "double gamma" do
+		@p.gamma = 0.33
+		@p.gamma.should == 0.33
+	end
+
+	it "double coef0" do
+		@p.coef0 = 0.99
+		@p.coef0.should == 0.99
+	end
+
+	it "double cache_size" do
+		@p.cache_size = 0.77
+		@p.cache_size.should == 0.77
+	end
+
+	it "double eps" do
+		@p.eps = 0.111
+		@p.eps.should == 0.111
+		@p.eps = 0.112
+		@p.eps.should == 0.112
+	end
+
+	it "double C" do
+		@p.c = 3.141
+		@p.c.should == 3.141
+	end
+
+	it "can set and read weights (weight, weight_label, nr_weight members from struct)" do
+		@p.label_weights = {1=> 1.2, 3=>0.2, 5=>0.888}
+		@p.label_weights.should == {1=> 1.2, 3=>0.2, 5=>0.888}
+	end
+
+
+	it "double nu" do
+		@p.nu = 1.1
+		@p.nu.should == 1.1
+	end
+
+	it "double p" do
+		@p.p = 0.123
+		@p.p.should == 0.123
+	end
+
+	it "int shrinking" do
+		@p.shrinking = 22
+		@p.shrinking.should == 22
+	end
+
+	it "int probability" do
+		@p.probability = 35
+		@p.probability.should == 35
+	end
+end

data/spec/problem_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "A Problem" do
+	before(:each) do
+		@problem = Problem.new
+		@features = [ Node.features(0.2,0.3,0.4,0.4),
+									Node.features(0.1,0.5,0.1,0.9),
+									Node.features(0.2,0.2,0.6,0.5),
+									Node.features(0.3,0.1,0.5,0.9) ]
+	end
+
+	it "examples get stored and retrieved" do
+		@problem.set_examples([1,2,1,2], @features)
+		labels, examples =  @problem.examples
+		labels.size.should == 4
+		examples.size.should == 4
+		examples.map {|x|x.size}.should == [4,4,4,4]
+		examples.first.map {|node| node.index}.should == [0,1,2,3]
+		examples.first.map {|node| node.value}.should == [0.2,0.3,0.4,0.4]
+	end
+
+	it "can be populated" do
+		examples = [Node.features(0.2,0.3,0.4,0.4),
+								Node.features(0.1,0.5,0.1,0.9),
+								Node.features(0.2,0.2,0.6,0.5),
+								Node.features(0.3,0.1,0.5,0.9)]
+		@problem.set_examples([1,2,1,2], examples)
+	end
+
+	it "can be set twice over" do 
+		features = [Node.features(0.2, 0.3, 0.4, 0.4), Node.features(0.3,0.1,0.5,0.9)]
+		@problem.set_examples([1,2], features)
+		features = [Node.features(0.2, 0.3, 0.4, 0.4), Node.features(0.3,0.1,0.5,0.9)]
+		@problem.set_examples([8,2], features)
+	end
+		
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'libsvm'
+
+include Libsvm
+
+RSpec.configure do |config|
+	config.color_enabled = true
+  # config.formatter     = 'documentation'
+end

data/spec/usage_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "Basic usage" do
+	before do
+		@problem = Problem.new
+		@parameter = SvmParameter.new
+		@parameter.cache_size = 1 # mb
+
+		# "eps is the stopping criterion (we usually use 0.00001 in nu-SVC,
+		# 0.001 in others)." (from README)
+		@parameter.eps = 0.001 
+
+		@parameter.c = 10
+	end
+
+	it "has a nice API" do
+		example = {11 => 0.11, 21 => 0.21, 101 => 0.99 }.to_example
+		example.should == Node.features({11 => 0.11, 21 => 0.21, 101 => 0.99 })
+	end
+
+	it "is as in [PCI,217]" do
+		examples = [ [1,0,1], [-1,0,-1] ].map {|ary| Node.features(ary) }
+		labels = [1, -1]
+		@problem.set_examples(labels, examples)
+
+		model = Model.train(@problem, @parameter)
+
+		pred = model.predict(Node.features(1, 1, 1))
+		pred.should == 1.0
+
+		pred = model.predict(Node.features(-1, 1, -1))
+		pred.should == -1.0
+
+		pred = model.predict(Node.features(-1, 55, -1))
+		pred.should == -1.0
+	end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rb-libsvm
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- C. Florian Ebeling
+- Rimas Silkaitis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: &2157654260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157654260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157653760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157653760
+description: libsvm and ruby without using swig
+email:
+- neovintage@gmail.com
+executables: []
+extensions:
+- ext/rb-libsvm/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- ext/rb-libsvm/extconf.rb
+- ext/rb-libsvm/libsvm.c
+- ext/rb-libsvm/ruby-ext.h
+- ext/rb-libsvm/svm.cpp
+- ext/rb-libsvm/svm.h
+- ferret_valgrind.supp
+- lib/libsvm.rb
+- lib/rb-libsvm/version.rb
+- rb-libsvm.gemspec
+- spec/model_spec.rb
+- spec/node_spec.rb
+- spec/parameter_spec.rb
+- spec/problem_spec.rb
+- spec/spec_helper.rb
+- spec/usage_spec.rb
+homepage: https://github.com/febeling/rb-libsvm
+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: rb-libsvm
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: Ruby language bindings for LIBSVM
+test_files:
+- spec/model_spec.rb
+- spec/node_spec.rb
+- spec/parameter_spec.rb
+- spec/problem_spec.rb
+- spec/spec_helper.rb
+- spec/usage_spec.rb