cofi_cost 0.0.7 → 0.0.8

data/.gitignore

@@ -0,0 +1 @@
+*.txt

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    cofi_cost (0.0.8)
+      gsl
+      narray
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    columnize (0.3.6)
+    debugger (1.6.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    gsl (1.15.3)
+      narray (>= 0.5.9)
+    narray (0.6.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cofi_cost!
+  debugger

data/Rakefile

@@ -0,0 +1,5 @@
+task :default => [:test]
+
+task :test do
+  ruby "test/unit/test_cofi_cost.rb"
+end

data/cofi_cost.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'cofi_cost'
+  s.version     = '0.0.8'
+  s.date        = '2013-11-18'
+  s.summary     = "Collaborative filtering"
+  s.description = "Playground for collaborative filtering in Ruby using NArray and rb-gsl."
+  s.authors     = ["Thomas Wolfe"]
+  s.email       = 'tomwolfe@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+	s.homepage    = 'http://github.com/tomwolfe/cofi_cost'
+  s.add_runtime_dependency 'gsl'
+  s.add_runtime_dependency 'narray'
+  s.license = 'MIT'
+  s.required_ruby_version = '>= 1.9.2'
+  s.requirements << 'libgsl0-dev'
+end

data/lib/cofi_cost.rb

@@ -6,13 +6,14 @@ include GSL::MultiMin
 
 class CofiCost
 
-	attr_accessor :ratings, :num_features, :cost, :regularization, :iterations, :features, :theta
-	attr_reader :boolean_rated, :num_tracks, :num_users, :ratings_mean, :ratings_norm, :predictions
+	attr_accessor :ratings, :num_features, :regularization, :iterations, :features, :theta, :max_rating
+	attr_reader :boolean_rated, :num_tracks, :num_users, :ratings_mean, :ratings_norm, :predictions, :cost
 	
-	def initialize(ratings, num_features = 2, regularization = 1, iterations = 10, features = nil, theta = nil)
+	def initialize(ratings, num_features = 2, regularization = 1, iterations = 10, max_rating = 5, features = nil, theta = nil)
 		@ratings = ratings.to_f	# make sure it's a float for correct normalization
 		@num_features = num_features
 		@cost = 0
+		@max_rating = max_rating
 		@boolean_rated = @ratings > 0 # return 0 for all rated and 1 for all unrated
 		@boolean_unrated = @boolean_rated.eq 0 # return 1 for all unrated and 0 for all unrated
 		@num_tracks = @ratings.shape[1] # @ratings is users x tracks
@@ -122,7 +123,14 @@ class CofiCost
 	end
 	
 	def calc_predictions
-		NArray.ref(NMatrix.ref(@features) * NMatrix.ref(@theta.transpose(1,0))) + @ratings_mean
+		predicts = NArray.ref(NMatrix.ref(@features) * NMatrix.ref(@theta.transpose(1,0))) + @ratings_mean
+		set_max_predictions(predicts)
+	end
+
+	def set_max_predictions(predicts)
+		a = predicts > @max_rating
+		predicts[a] = @max_rating
+		predicts
 	end
 
 end

data/spec/cofi_cost_spec.rb

@@ -0,0 +1,77 @@
+require_relative 'spec_helper'
+
+describe CofiCost do
+	before :each do
+		ratings = NArray[[5.0,4.0,0.0,0.0],[3.0,0.0,0.0,0.0],[4.0,0.0,0.0,0.0],[3.0,0.0,0.0,0.0],[3.0,0.0,0.0,0.0]]
+		num_features = 3
+		regularization = 1
+		iterations = 10
+		max_rating = 5
+		theta = NArray[[0.28544,-1.68427,0.26294],[0.50501,-0.45465,0.31746],[-0.43192,-0.47880,0.84671],[0.72860,-0.27189,0.32684]]
+		features = NArray[[1.048686,-0.400232,1.194119],[0.780851,-0.385626,0.521198],[0.641509,-0.547854,-0.083796],[0.453618,-0.800218,0.680481],[0.937538,0.106090,0.361953]]
+		@cofi = CofiCost.new(ratings, num_features, regularization, iterations, max_rating, features, theta)
+	end
+  
+	describe "#normalize_ratings" do
+    it "subtracts the mean rating of a track from each of the tracks ratings" do
+			# called in initilization
+			@cofi.ratings_mean.should == NArray[[4.5],[3.0],[4.0],[3.0],[3.0]]
+			@cofi.ratings_norm.should == NArray[[0.5,-0.5,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0]]
+    end
+  end
+
+	describe "#partial_cost_calc(theta,features)" do
+		it "calculates part of the cost" do
+			@cofi.partial_cost_calc.to_a.should == [[0.78741733234,1.5906474134,0.0,0.0],[1.00942821458,0.0,0.0,0.0],[1.0838130652999998,0.0,-0.0,0.0],[1.65618956692,0.0,0.0,0.0],[0.18409856424000004,0.0,-0.0,0.0]]
+		end
+	end
+
+	describe "#roll_up_theta_and_features" do
+		it "returns a vector of @theta + @features" do
+			@cofi.roll_up_theta_and_features.to_a.should == [0.28544,-1.68427,0.26294,0.50501,-0.45465,0.31746,-0.43192,-0.4788,0.84671,0.7286,-0.27189,0.32684,1.048686,-0.400232,1.194119,0.780851,-0.385626,0.521198,0.641509,-0.547854,-0.083796,0.453618,-0.800218,0.680481,0.937538,0.10609,0.361953]
+		end
+	end
+
+	describe "#unroll_params_init_shape(x)" do
+		before :each do
+			@rolled = @cofi.roll_up_theta_and_features
+		end
+		it "unrolls @theta and @features back into it's original shape" do
+			orig_theta, orig_features = @cofi.theta, @cofi.features
+			@cofi.unroll_params_init_shape(@rolled)
+			@cofi.theta.should == orig_theta
+			@cofi.features.should == orig_features
+		end
+	end
+
+	describe "#min_cost" do
+		it "finds the lowest cost" do
+			@cofi.min_cost
+			@cofi.cost.should == 0.9885618408659724
+		end
+		it "calls #calc_predictions" do
+			@cofi.should_receive(:calc_predictions)
+			@cofi.min_cost
+		end
+	end
+
+	describe "#calc_predictions" do
+		it "calculates predictions" do
+			@cofi.calc_predictions.to_a.should == [[5.0, 5.0, 5.0, 5.0], [4.00942821458, 3.73512194149, 3.28867612346, 3.84412424606], [5.0, 4.54644840303, 3.91428101676, 4.58897159682], [4.65618956692, 3.80892623814, 3.76338775935, 3.7704857568600003], [3.18409856424, 3.54013784626, 2.85073191967, 3.77254609522]]
+		end
+	end
+
+	describe "#unroll_params(v)" do
+		it "unrolls v back to it's original @theta and @features dimensions" do
+			@cofi.unroll_params(@cofi.roll_up_theta_and_features)[0].to_a.should == [[0.28544,-1.68427,0.26294],[0.50501,-0.45465,0.31746],[-0.43192,-0.4788,0.84671],[0.7286,-0.27189,0.32684]]
+			@cofi.unroll_params(@cofi.roll_up_theta_and_features)[1].to_a.should == [[1.048686,-0.400232,1.194119],[0.780851,-0.385626,0.521198],[0.641509,-0.547854,-0.083796],[0.453618,-0.800218,0.680481],[0.937538,0.10609,0.361953]]
+		end
+	end
+
+	describe "#set_max_predictions(predicts)" do
+		it "does not allow any prediction greater than self.max_rating" do
+			test = NArray[[6.0,4.0,0.0,0.0],[3.0,0.0,6.5,0.0],[4.0,0.0,0.0,0.0],[3.0,0.0,0.0,0.0],[3.0,0.0,0.0,0.0]]
+			@cofi.set_max_predictions(test).to_a.should == [[5.0,4.0,0.0,0.0],[3.0,0.0,5.0,0.0],[4.0,0.0,0.0,0.0],[3.0,0.0,0.0,0.0],[3.0,0.0,0.0,0.0]]
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/cofi_cost'
+
+RSpec.configure do |config|
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cofi_cost
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-02 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gsl
@@ -49,9 +49,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/cofi_cost.rb
+- .gitignore
+- Gemfile
+- Gemfile.lock
 - README.textile
-- test/unit/test_cofi_cost.rb
+- Rakefile
+- cofi_cost.gemspec
+- lib/cofi_cost.rb
+- spec/cofi_cost_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/tomwolfe/cofi_cost
 licenses:
 - MIT

data/test/unit/test_cofi_cost.rb

@@ -1,41 +0,0 @@
-require 'test/unit'
-require_relative '../../lib/cofi_cost.rb'
-require 'narray'
-require 'gsl'
-require 'matrix'
-
-class CofiCostTest < Test::Unit::TestCase
-
-  def setup
-    ratings = NArray[[5.0,4.0,0.0,0.0],[3.0,0.0,0.0,0.0],[4.0,0.0,0.0,0.0],[3.0,0.0,0.0,0.0],[3.0,0.0,0.0,0.0]]
-    num_features = 2
-    lambda = 1
-    iterations = 10
-    features = NArray[[0.139489,1.804804],[-0.501808,1.050885],[0.354079,-0.518884],[-0.015370,0.096253],[1.147623,-0.745562]]
-    theta = NArray[[-0.079641,1.211386],[-0.130688,0.444762],[-0.789258,1.222232],[0.212132,-1.174545]]
-    @c = CofiCost.new(ratings, num_features, lambda, iterations, features, theta)
-  end
-  
-  def teardown
-    @c = nil
-  end
-  
-  def test_happy_case
-    @c.min_cost
-    assert_equal 0.07964723302994943, @c.cost
-    # oddly the following fails, even though they are equal (not enough decimal places me thinks)
-    # assert_equal NArray[[4.62547,3.91302,8.30084,1.59081],[2.96361,3.17939,1.88322,3.88434],[3.92356,4.32263,1.739,5.6172],[2.98132,3.06219,2.47359,3.3213],[2.93724,3.14111,1.33728,3.77855]], @c.predictions
-    assert_equal 4.625468057637709, @c.predictions[0,0]
-  end
-  
-  def test_normalize_ratings
-    assert_equal NArray[[4.5],[3.0],[4.0],[3.0],[3.0]], @c.ratings_mean
-    assert_equal NArray[[0.5,-0.5,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0]], @c.ratings_norm
-  end
-  
-  def test_roll_up_theta_and_features
-    rolled = @c.roll_up_theta_and_features
-    assert_equal GSL:: Vector.alloc([-0.079641, 1.211386, -0.130688, 0.444762, -0.789258, 1.222232, 0.212132, -1.174545, 0.139489, 1.804804, -0.501808, 1.050885, 0.354079, -0.518884, -0.01537, 0.096253, 1.147623, -0.745562]), rolled
-  end
-  
-end