cofi_cost 0.0.2 → 0.0.3

data/README.textile

@@ -0,0 +1,41 @@
+h2. About
+
+Playground for collaborative filtering in Ruby using NArray and rb-gsl.
+
+h2. Usage
+
+Create a variable to store the ratings as an NArray (number of users x number of tracks).
+
+Set the number of features to learn, lambda (regularization parameter), and the number of iterations of gradient descent.
+
+Call min_cost
+
+<pre>
+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
+cofi = CofiCost.new(ratings, num_features, lambda, iterations, nil, nil)
+cofi.min_cost
+</pre>
+
+The cost and predictions (an NArray of the original size of ratings) can then be
+returned after running min_cost:
+
+<pre>
+cofi.cost
+cofi.predictions
+</pre>
+
+h2. Installation
+
+h3. gem
+
+rails 3.2
+# gem 'cofi_cost'
+in your Gemfile
+# <pre>bundle install</pre> from the command line
+
+h2. License
+
+MIT License 2012 Thomas Wolfe

data/lib/cofi_cost.rb

@@ -6,10 +6,10 @@ include GSL::MultiMin
 
 class CofiCost
 
-	attr_accessor :ratings, :num_features, :cost, :lambda
+	attr_accessor :ratings, :num_features, :cost, :lambda, :iterations
 	attr_reader :boolean_rated, :num_tracks, :num_users, :features, :theta, :ratings_mean, :ratings_norm, :predictions
 	
-	def initialize(ratings, num_features, lambda, features = nil, theta = nil)
+	def initialize(ratings, num_features = 2, lambda = 1, iterations = 10, features = nil, theta = nil)
 		@ratings = ratings.to_f	# make sure it's a float for correct normalization
 		@num_features = num_features
 		@cost = 0
@@ -26,6 +26,7 @@ class CofiCost
 		@ratings_mean, @ratings_norm = normalize_ratings
 		@lambda = lambda
 		@predictions = nil
+		@iterations = iterations
 	end
 	
 	def normalize_ratings
@@ -114,7 +115,7 @@ class CofiCost
 			x = minimizer.x
 			f = minimizer.f
 			printf("%5d %.5f %.5f %10.5f\n", iter, x[0], x[1], f)
-		end while status == GSL::CONTINUE and iter < 10
+		end while status == GSL::CONTINUE and iter < @iterations
 		
 		unroll_params_init_shape(x)
 		@cost = f

data/test/unit/test_cofi_cost.rb

@@ -10,9 +10,10 @@ class CofiCostTest < Test::Unit::TestCase
     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, features, theta)
+    @c = CofiCost.new(ratings, num_features, lambda, iterations, features, theta)
   end
   
   def teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cofi_cost
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gsl
-  requirement: &83060750 !ruby/object:Gem::Requirement
+  requirement: &84373640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *83060750
+  version_requirements: *84373640
 - !ruby/object:Gem::Dependency
   name: narray
-  requirement: &83060170 !ruby/object:Gem::Requirement
+  requirement: &84373200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *83060170
+  version_requirements: *84373200
 description: Playground for collaborative filtering in Ruby using NArray and rb-gsl.
 email: tomwolfe@gmail.com
 executables: []
@@ -40,7 +40,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/cofi_cost.rb
-- README
+- README.textile
 - test/unit/test_cofi_cost.rb
 homepage: http://github.com/tomwolfe/cofi_cost
 licenses:

data/README

@@ -1,10 +0,0 @@
-Playground for collaborative filtering in Ruby using NArray and rb-gsl.
-
-“Snowflakes, like people, are all different and beautiful, 
-but they can be a nuisance when they lose their identity in a mob”
-
-Roadmap:
-First release name: Graupel
-Release Date: TBD
-From http://en.wikipedia.org/wiki/Graupel Jan 1, 2012
-"Graupel refers to precipitation that forms when supercooled droplets of water are collected and freeze on a falling snowflake, forming a 2–5 mm (0.079–0.197 in) ball of rime. The term graupel is the German word for this meteorological phenomenon. Graupel is sometimes referred to as small hail, although the World Meteorological Organization defines small hail as snow pellets encapsulated by ice, a precipitation halfway between graupel and hail."