recommender-core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af526dd7ce5518845a6ddb738193919ccebe7879
+  data.tar.gz: 96686cf178180de62daca570e3b767a6f003a686
+SHA512:
+  metadata.gz: 8c63fe907f43f18c3d70beab4cbfa63bec7eaf336fb5872434e87867dcfb0b5d08fb92b0b3cd4ee1b47e985a95654c99c424de1ce494339fa7377cb2dc1d2e9a
+  data.tar.gz: 11c3fa7c623aaeac45dcfcb99c1426a619db40014eb0f160ee0de0aaeea3925d118889ae31f1a35ef82de342c58b3887c0a54cc7b65071bc07bac80416d06b5d

data/.autotest

@@ -0,0 +1,9 @@
+require 'autotest/fsevent'
+
+class Autotest::Rspec2 < Autotest
+  def make_test_cmd(files_to_test)
+    files_to_test.empty? ? '' :
+      "#{prefix}#{ruby}#{suffix} --ng -S '#{RSPEC_EXECUTABLE}' --tty \
+      #{normalize(files_to_test).keys.flatten.map { |f| "'#{f}'"}.join(' ')}"
+  end
+end

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+ruby '1.9.3', :engine => 'jruby', :engine_version => '1.7.12'
+gem 'autotest'
+gem 'autotest-fsevent'
+gem 'ZenTest'
+gem 'autotest-spec'
+
+platform :jruby do
+  gem 'jruby_mahout'
+end
+# Specify your gem's dependencies in recommender_core.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# RecommenderCore
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'recommender_core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install recommender_core
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/recommender_core/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/recommender_core/handler.rb

@@ -0,0 +1,64 @@
+require 'jruby_mahout'
+
+class RecommenderCore::Handler
+
+  def self.similar_users(params)
+    recommender = init_recommender(params[:hash])
+    recommender.similar_users(params[:id], params[:nb_wanted], params[:rescorer])
+  end
+
+  def self.similar_items(params)
+    recommender = init_recommender(params[:hash])
+    recommender.similar_items(params[:id], params[:nb_wanted], params[:rescorer])
+  end
+
+  def self.recommend_items(params)
+    recommender = init_recommender(params[:hash])
+    recommender.recommend(params[:id], params[:nb_wanted], params[:rescorer])
+  end
+
+  def self.evaluate(params)
+    recommender = init_recommender(params[:hash])
+    recommender.evaluate(params[:training_prcentage], params[:eval_prcentage])
+  end
+
+
+  def self.estimate_preference(params)
+    recommender = init_recommender(params[:hash])
+    recommender.estimate_preference(params[:user_id], params[:item_id])
+  end
+
+  private #################################
+
+  def self.tell_to_do()
+  end
+
+  def self.respond_to()
+  end
+
+  def self.init_recommender(params)
+    recommender = JrubyMahout::Recommender.new(params[:similarity_metric], params[:neighborhood], params[:recommender_algo], true)
+    file = data_to_csv(params[:engine_data])
+    recommender.data_model = JrubyMahout::DataModel.new('file', {file_path: file.path}).data_model
+    free_file(file.path)
+    recommender
+  end
+
+  def self.data_to_csv(engine_data)
+    file = File.new(return_tmp_path, "w+")
+    return nil unless file
+    engine_data.each do |row|
+      file.puts "#{row[:customer_id]},#{row[:item_id]},#{row[:preference]}"
+    end
+    file.rewind
+    file
+  end
+
+  def self.free_file(file)
+    File.delete(file)
+  end
+
+  def self.return_tmp_path
+    'tmp/' + Time.now.to_s + ".csv"
+  end
+end

data/lib/recommender_core/version.rb

@@ -0,0 +1,3 @@
+module RecommenderCore
+  VERSION = "0.0.1"
+end

data/lib/recommender_core.rb

@@ -0,0 +1,8 @@
+require "recommender_core/version"
+require 'recommender_core/handler'
+
+module RecommenderCore
+  # Your code goes here...
+  class Handler
+  end
+end

data/recommender_core.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recommender_core/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "recommender-core"
+  spec.version       = RecommenderCore::VERSION
+  spec.authors       = ["atacraft & fabira"]
+  spec.email         = ["atacraft@gmail.com"]
+  spec.summary       = %q{The core module of the recommender}
+  spec.description   = %q{This one is responsible of interactions with mahout}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/handler_spec.rb

@@ -0,0 +1,41 @@
+require_relative 'spec_helper'
+
+describe RecommenderCore::Handler do
+  let(:engine_data) { engine_data_sample }
+  let(:hash_user_based) { { similarity_metric: 'PearsonCorrelationSimilarity', neighborhood: 5, recommender_algo: 'GenericUserBasedRecommender', engine_data: engine_data }  }
+  let(:hash_item_based) { { similarity_metric: 'PearsonCorrelationSimilarity', neighborhood: 5, recommender_algo: 'GenericItemBasedRecommender', engine_data: engine_data }  }
+  let(:params_user_based) { {hash: hash_user_based, id: 1, nb_wanted: 2, rescorer: nil} }
+  let(:params_item_based) { {hash: hash_item_based, id: 1, nb_wanted: 2, rescorer: nil} }
+  let(:evaluation) { {hash: hash_item_based, training_prcentage: 0.7, eval_prcentage: 0.3} }
+  let(:estimation) { {hash: hash_user_based, user_id: 1, item_id: 3} }
+
+  describe ".init_recommender" do
+    it { expect(RecommenderCore::Handler.init_recommender(hash_user_based)).to_not be_nil }
+    it { expect(RecommenderCore::Handler.init_recommender(hash_item_based).class).to eq(JrubyMahout::Recommender) }
+    it { expect(RecommenderCore::Handler.init_recommender(hash_user_based).data_model).to_not be_nil }
+  end
+
+  describe ".data_to_csv" do
+    it { expect(RecommenderCore::Handler.data_to_csv(engine_data).class).to eq(File) }
+  end
+
+  describe '.similar_users' do
+    it { expect(RecommenderCore::Handler.similar_users(params_user_based)).to_not be_nil }
+  end
+
+  describe '.similar_items' do
+    it { expect(RecommenderCore::Handler.similar_items(params_item_based)).to_not be_nil }
+  end
+
+  describe '.recommend_items' do
+    it { expect(RecommenderCore::Handler.recommend_items(params_item_based)).to_not be_nil }
+  end
+
+  describe '.evaluate' do
+    it { expect(RecommenderCore::Handler.evaluate(evaluation)).to_not be_nil }
+  end
+
+  describe '.estimate_preference' do
+    it { expect(RecommenderCore::Handler.estimate_preference(estimation)).to_not be_nil }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'recommender_core'
+
+def engine_data_sample
+    engine_data = []
+    engine_data << {customer_id: 1, item_id: 1, preference: 1}
+
+  10000.times do
+    engine_data << { customer_id: rand(1..5), item_id: rand(1..10), preference: rand(1..5) }
+  end
+  engine_data
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: recommender-core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- atacraft & fabira
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: This one is responsible of interactions with mahout
+email:
+- atacraft@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/recommender_core.rb
+- lib/recommender_core/handler.rb
+- lib/recommender_core/version.rb
+- recommender_core.gemspec
+- spec/handler_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
+specification_version: 4
+summary: The core module of the recommender
+test_files:
+- spec/handler_spec.rb
+- spec/spec_helper.rb