slope_one 0.1

data/Manifest.txt

@@ -0,0 +1,9 @@
+Manifest.txt
+README.markdown
+Rakefile
+lib/slope_one.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_slope_one.rb

data/README.markdown

@@ -0,0 +1,58 @@
+# Slope One (Recommendation Algorithm)
+
+## DESCRIPTION:
+
+Implementation of the [Slope One](http://en.wikipedia.org/wiki/Slope_One) collaborative filtering/recommendation algorithm.
+
+Ported to Ruby from Bryan O’Sullivan's [Python implementation](http://www.serpentine.com/blog/2006/12/12/collaborative-filtering-made-easy/). All credit goes to him.
+
+## SYNOPSIS:
+
+    user_data = {
+      "rob" => {
+        "24" => 9.5,
+        "Lost" => 8.2,
+        "House" => 6.8
+      },
+
+      "bob" => {
+        "24" => 3.7,
+        "Big Bang Theory" => 2.1,
+        "House" => 8.3
+      },
+
+      "tod" => {
+        "24" => 9.5,
+        "Lost" => 3.4,
+        "House" => 5.5,
+        "Big Bang Theory" => 9.3
+      },
+
+      "dod" => {
+        "24" => 7.2,
+        "Lost" => 5.1,
+        "House" => 8.4,
+        "The Event" => 7.8,
+      }
+    }
+
+    slope_one = SlopeOne.new
+    slope_one.update(user_data)
+    puts slope_one.predict({"House" => 3, "Big Bang Theory" => 7.5}).inspect
+
+## INSTALL:
+
+    gem install slope_one
+
+or in your Gemfile:
+
+    gem 'slope_one'
+
+## LICENSE:
+
+Copyright 2006 Bryan O'Sullivan <bos@serpentine.com> (Original implementation)
+Copyright 2010 Ashley Williams <hi@ashleyw.co.uk> (Ruby port)
+
+This software may be used and distributed according to the terms
+of the GNU General Public License, version 2 or later, which is
+incorporated herein by reference.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/slope_one'
+
+Hoe.plugin :newgem
+
+$hoe = Hoe.spec 'slope_one' do
+  self.developer 'Ashley Williams', 'hi@ashleyw.co.uk'
+  self.rubyforge_name = self.name # TODO this is default value
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/slope_one.rb

@@ -0,0 +1,52 @@
+VERSION = '0.1'
+
+class SlopeOne
+  attr_accessor :diffs, :freqs
+  
+  def initialize
+    self.diffs = {}
+    self.freqs = {}
+  end
+
+  def insert(user_data)
+    user_data.each do |name, ratings|
+      ratings.each do |item1, rating1|
+        self.freqs[item1] ||= {}
+        self.diffs[item1] ||= {}
+        ratings.each do |item2, rating2|
+          self.freqs[item1][item2] ||= 0
+          self.diffs[item1][item2] ||= 0.0
+          self.freqs[item1][item2] += 1
+          self.diffs[item1][item2] += (rating1 - rating2)
+        end
+      end
+    end
+    
+    self.diffs.each do |item1, ratings|
+      ratings.each do |item2, rating2|
+        ratings[item2] = ratings[item2] / self.freqs[item1][item2]
+      end
+    end
+  end
+  
+  def predict(user)
+    preds, freqs = {}, {}
+
+    user.each do |item, rating|
+      self.diffs.each do |diff_item, diff_ratings|
+        next if self.freqs[diff_item].nil? or diff_ratings[item].nil?
+        freq = self.freqs[diff_item][item]
+        preds[diff_item] ||= 0.0
+        freqs[diff_item] ||= 0
+        preds[diff_item] += freq * (diff_ratings[item] + rating)
+        freqs[diff_item] += freq
+      end
+    end
+    
+    results = {}
+    preds.each do |item, value|
+      results[item] = sprintf('%.3f', (value / freqs[item])).to_f unless user.include?(item) && freqs[item] > 0
+    end
+    return results
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/slope_one.rb'}"
+puts "Loading slope_one gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/slope_one'

data/test/test_slope_one.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestSlopeOne < Test::Unit::TestCase
+  def setup
+    user_data = {
+      "rob" => {
+        "24" => 9.5,
+        "Lost" => 8.2,
+        "House" => 6.8
+      },
+
+      "bob" => {
+        "24" => 3.7,
+        "Big Bang Theory" => 2.1,
+        "House" => 8.3
+      },
+      
+      "tod" => {
+        "24" => 9.5,
+        "Lost" => 3.4,
+        "House" => 5.5,
+        "Big Bang Theory" => 9.3
+      },
+
+      "dod" => {
+        "24" => 7.2,
+        "Lost" => 5.1,
+        "House" => 8.4,
+        "The Event" => 7.8,
+      }
+    }
+
+    @slope_one = SlopeOne.new
+    @slope_one.insert(user_data)
+  end
+  
+  def input_test(input, output)
+    assert @slope_one.predict(input) == output
+  end
+  
+  def test_predict
+    input = {"House" => 3, "Big Bang Theory" => 7.5}
+    output = {"24"=>4.95, "Lost"=>1.65, "The Event"=>2.4}
+    input_test(input, output)
+  end
+  
+  def test_irrelevent_input
+    input = {"Eastenders" => 7.25}
+    output = {}
+    input_test(input, output)
+  end
+  
+  def test_insufficient_data
+    @slope_one = SlopeOne.new
+    # < here there nay be data insertion >
+    input = {"Eastenders" => 7.25}
+    output = {}
+    input_test(input, output)
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: slope_one
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Ashley Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-13 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Implementation of the weighted Slope One collaborative filtering/recommendation algorithm.
+email: 
+- hi@ashleyw.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Manifest.txt
+- README.markdown
+- Rakefile
+- lib/slope_one.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_slope_one.rb
+has_rdoc: true
+homepage: http://github.com/ashleyw/slope_one
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: slope_one
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Implementation of the Slope One recommendation algorithm.
+test_files: []
+