recommendation 0.1.3

data/doc/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/doc/ChangeLog

@@ -0,0 +1,5 @@
+=== 0.1.3 / 2013-10-18
+
+* First release.
+
+

data/doc/LICENSE

@@ -0,0 +1,8 @@
+You can redistribute it and/or modify it under either the terms of the GPL
+version 3, or LGPL version 3 (Dual License).
+
+See the file doc/COPYING or doc/COPYING.LESSER.
+
+Copyright (c) 774 All Rights Reserved.
+Web: http://id774.net
+E-Mail: 774@id774.net

data/doc/README

@@ -0,0 +1,16 @@
+recommendation
+
+Name
+ Collaborative filtering for recommender system
+
+Syntax
+ require 'recommendation'
+
+Description
+ http://en.wikipedia.org/wiki/Recommender_system
+
+Installation
+ $ gem install recommendation
+
+Tutorial
+ See spec files.

data/lib/recommendation.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+module Recommendation
+  VERSION = "0.1.3"
+  require File.dirname(__FILE__) +  "/recommendation/supervisor"
+  require File.dirname(__FILE__) +  "/recommendation/engine"
+end

data/lib/recommendation/engine.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+module Recommendation
+  class Engine
+    def recommendation(table, user, similarity=:sim_pearson)
+      totals_h = Hash.new(0)
+      sim_sums_h = Hash.new(0)
+      table.each do |other, val|
+        next if other == user
+        sim = __send__(similarity, table, user, other)
+        next if sim <= 0
+        table[other].each do |item, val|
+          if !table[user].keys.include?(item) || table[user][item] == 0
+            totals_h[item] += table[other][item]*sim
+            sim_sums_h[item] += sim
+          end
+        end
+      end
+
+      rankings = Hash.new
+      totals_h.each do |item, total|
+        rankings[item] = total/sim_sums_h[item]
+      end
+
+      Hash[rankings.sort_by{|k, v| -v}]
+    end
+
+    def top_matches(table, user, n=5, similarity=:sim_pearson)
+      scores = Array.new
+      table.each do |key, value|
+        if key != user
+          scores << [__send__(similarity, table, user,key), key]
+        end
+      end
+      result = Hash.new
+      scores.sort.reverse[0,n].each do |k, v|
+        result[v] = k
+      end
+      result
+    end
+
+    private
+
+    def sim_pearson(table, user1, user2)
+      shared_items_a = shared_items_a(table, user1, user2)
+
+      n = shared_items_a.size
+      return 0 if n == 0
+
+      sum1 = shared_items_a.inject(0) {|result, si|
+        result + table[user1][si]
+      }
+      sum2 = shared_items_a.inject(0) {|result, si|
+        result + table[user2][si]
+      }
+
+      sum1_sq = shared_items_a.inject(0) {|result, si|
+        result + table[user1][si]**2
+      }
+      sum2_sq = shared_items_a.inject(0) {|result, si|
+        result + table[user2][si]**2
+      }
+
+      sum_products = shared_items_a.inject(0) {|result, si|
+        result + table[user1][si]*table[user2][si]
+      }
+
+      num = sum_products - (sum1*sum2/n)
+      den = Math.sqrt((sum1_sq - sum1**2/n)*(sum2_sq - sum2**2/n))
+      return 0 if den == 0
+      return num/den
+    end
+
+    def shared_items(table, user1, user2)
+      shared_items_h = Hash.new
+      table[user1].each do |k, v|
+        shared_items_h[k] = 1 if table[user2].include?(k)
+      end
+      shared_items_h
+    end
+
+    def shared_items_a(table, user1, user2)
+      table[user1].nil? ? [] : table[user1].keys & table[user2].keys
+    end
+  end
+end

data/lib/recommendation/supervisor.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+module Recommendation
+  class Supervisor
+    def initialize(params = {})
+      @table = params
+    end
+
+    def table
+      @table
+    end
+
+    def train(params = {})
+      @table.merge!(params)
+    end
+
+    def transform_table
+      new_table = {}
+      @table.each do |key, value|
+        value.each do |new_key, new_value|
+          new_table[new_key] ||= Hash.new
+          new_table[new_key][key] = new_value
+        end
+      end
+      new_table
+    end
+  end
+end

data/recommendation.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: recommendation 0.1.3 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "recommendation"
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["id774"]
+  s.date = "2013-10-18"
+  s.description = "Collaborative filtering for recommender system"
+  s.email = "idnanashi@gmail.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "demo.rb",
+    "doc/AUTHORS",
+    "doc/COPYING",
+    "doc/COPYING.LESSER",
+    "doc/ChangeLog",
+    "doc/LICENSE",
+    "doc/README",
+    "lib/recommendation.rb",
+    "lib/recommendation/engine.rb",
+    "lib/recommendation/supervisor.rb",
+    "recommendation.gemspec",
+    "script/build",
+    "spec/lib/recommendation/engine_spec.rb",
+    "spec/lib/recommendation/supervisor_spec.rb",
+    "spec/lib/recommendation_spec.rb",
+    "spec/spec_helper.rb",
+    "vendor/.gitkeep"
+  ]
+  s.homepage = "http://github.com/id774/recommendation"
+  s.licenses = ["GPL"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.5"
+  s.summary = "recommendation"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/script/build

@@ -0,0 +1,32 @@
+#!/bin/sh
+#
+########################################################################
+# Integration Build Script
+#
+#  Maintainer: id774 <idnanashi@gmail.com>
+#
+#  v1.2 4/17,2013
+#       Using simplecov for coverage.
+#  v1.1 3/14,2013
+#       Show ruby version.
+#  v1.0 3/16,2012
+#       First.
+########################################################################
+
+kickstart() {
+    export RACK_ROOT="."
+    export RACK_ENV="test"
+    ruby -v
+}
+
+run_tests() {
+    rake simplecov
+}
+
+main() {
+    kickstart
+    run_tests
+}
+
+set -ex
+main

data/spec/lib/recommendation/engine_spec.rb

@@ -0,0 +1,204 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe 'Recommendation::Engine' do
+  describe 'recommendation' do
+    it 'should be suggesting interesting products' do
+      expected = {"The Night Listener"=>3.3477895267131017, "Lady in the Water"=>2.8325499182641614, "Just My Luck"=>2.530980703765565}
+
+
+      supervisor = Recommendation::Supervisor.new(visitors)
+      supervisor.train(new_comer)
+      engine = Recommendation::Engine.new
+
+      new_comer.keys[0].should be_eql 'Toby'
+      engine.recommendation(supervisor.table, new_comer.keys[0]).should be_eql expected
+    end
+  end
+
+  describe 'top_matches' do
+    it 'should be finding similar users' do
+      expected ={"Lisa Rose"=>0.9912407071619299, "Mick LaSalle"=>0.9244734516419049, "Claudia Puig"=>0.8934051474415647, "Jack Matthews"=>0.66284898035987, "Gene Seymour"=>0.38124642583151164}
+
+      supervisor = Recommendation::Supervisor.new(visitors)
+      supervisor.train(new_comer)
+      engine = Recommendation::Engine.new
+
+      new_comer.keys[0].should be_eql 'Toby'
+      engine.top_matches(supervisor.table, new_comer.keys[0]).should be_eql expected
+    end
+  end
+
+  describe 'transform_table ' do
+    it 'should return reversed critics' do
+      supervisor = Recommendation::Supervisor.new(visitors)
+      supervisor.train(new_comer)
+      engine = Recommendation::Engine.new
+
+      movies = supervisor.transform_table
+      movies.should be_eql reversed_critics
+    end
+  end
+
+  describe 'reversed critics' do
+    it 'should be found similar items' do
+      expected = {"You, Me and Dupree"=>0.6579516949597695, "Lady in the Water"=>0.4879500364742689, "Snake on the Plane"=>0.11180339887498941, "The Night Listener"=>-0.1798471947990544, "Just My Luck"=>-0.42289003161103106}
+
+      supervisor = Recommendation::Supervisor.new(visitors)
+      supervisor.train(new_comer)
+      engine = Recommendation::Engine.new
+
+      movies = supervisor.transform_table
+
+      new_comer.values[0].keys[2].should be_eql 'Superman Returns'
+      engine.top_matches(movies, new_comer.values[0].keys[2]).should be_eql expected
+    end
+  end
+
+  describe 'recommendation for the unexisting user' do
+    it 'should return empty array' do
+      expected = {}
+
+      supervisor = Recommendation::Supervisor.new(visitors)
+      supervisor.train(new_comer)
+      engine = Recommendation::Engine.new
+
+      engine.recommendation(supervisor.table, 'hoge').should be_eql expected
+    end
+  end
+
+  describe 'top_matches for the unexisting item' do
+    it 'should return all zero score' do
+      expected = {"Toby"=>0, "Mick LaSalle"=>0, "Michael Phillips"=>0, "Lisa Rose"=>0, "Jack Matthews"=>0}
+
+      supervisor = Recommendation::Supervisor.new(visitors)
+      supervisor.train(new_comer)
+      engine = Recommendation::Engine.new
+
+      engine.top_matches(supervisor.table, 'fuga').should be_eql expected
+    end
+  end
+end
+
+def new_comer
+  {
+    'Toby' => {
+      'Snake on the Plane' => 4.5,
+      'You, Me and Dupree' => 1.0,
+      'Superman Returns'   => 4.0
+    }
+  }
+end
+
+def visitors
+  {
+    'Lisa Rose' => {
+      'Lady in the Water'  => 2.5,
+      'Snake on the Plane' => 3.5,
+      'Just My Luck'       => 3.0,
+      'Superman Returns'   => 3.5,
+      'You, Me and Dupree' => 2.5,
+      'The Night Listener' => 3.0
+    },
+
+    'Gene Seymour' => {
+      'Lady in the Water'  => 3.0,
+      'Snake on the Plane' => 3.5,
+      'Just My Luck'       => 1.5,
+      'Superman Returns'   => 5.0,
+      'The Night Listener' => 3.0,
+      'You, Me and Dupree' => 3.5
+    },
+
+    'Michael Phillips' => {
+      'Lady in the Water'  => 2.5,
+      'Snake on the Plane' => 3.0,
+      'Superman Returns'   => 3.5,
+      'The Night Listener' => 4.0
+    },
+
+    'Claudia Puig' => {
+      'Snake on the Plane' => 3.5,
+      'Just My Luck'       => 3.0,
+      'The Night Listener' => 4.5,
+      'Superman Returns'   => 4.0,
+      'You, Me and Dupree' => 2.5
+    },
+
+    'Mick LaSalle' => {
+      'Lady in the Water'  => 3.0,
+      'Snake on the Plane' => 4.0,
+      'Just My Luck'       => 2.0,
+      'Superman Returns'   => 3.0,
+      'The Night Listener' => 3.0,
+      'You, Me and Dupree' => 2.0
+    },
+
+    'Jack Matthews' => {
+      'Lady in the Water'  => 3.0,
+      'Snake on the Plane' => 4.0,
+      'The Night Listener' => 3.0,
+      'Superman Returns'   => 5.0,
+      'You, Me and Dupree' => 3.5
+    }
+  }
+end
+
+def reversed_critics
+  {
+    "Lady in the Water" => {
+      "Lisa Rose"        => 2.5,
+      "Gene Seymour"     => 3.0,
+      "Michael Phillips" => 2.5,
+      "Mick LaSalle"     => 3.0,
+      "Jack Matthews"    => 3.0
+    },
+
+    "Snake on the Plane" => {
+      "Lisa Rose"        => 3.5,
+      "Gene Seymour"     => 3.5,
+      "Michael Phillips" => 3.0,
+      "Claudia Puig"     => 3.5,
+      "Mick LaSalle"     => 4.0,
+      "Jack Matthews"    => 4.0,
+      "Toby"             => 4.5
+    },
+
+    "Just My Luck" => {
+      "Lisa Rose"        => 3.0,
+      "Gene Seymour"     => 1.5,
+      "Claudia Puig"     => 3.0,
+      "Mick LaSalle"     => 2.0
+    },
+
+    "Superman Returns" => {
+      "Lisa Rose"        => 3.5,
+      "Gene Seymour"     => 5.0,
+      "Michael Phillips" => 3.5,
+      "Claudia Puig"     => 4.0,
+      "Mick LaSalle"     => 3.0,
+      "Jack Matthews"    => 5.0,
+      "Toby"             => 4.0
+    },
+
+    "You, Me and Dupree" => {
+      "Lisa Rose"        => 2.5,
+      "Gene Seymour"     => 3.5,
+      "Claudia Puig"     => 2.5,
+      "Mick LaSalle"     => 2.0,
+      "Jack Matthews"    => 3.5,
+      "Toby"             => 1.0
+    },
+
+    "The Night Listener" => {
+      "Lisa Rose"        => 3.0,
+      "Gene Seymour"     => 3.0,
+      "Michael Phillips" => 4.0,
+      "Claudia Puig"     => 4.5,
+      "Mick LaSalle"     => 3.0,
+      "Jack Matthews"    => 3.0
+    }
+  }
+end