jruby_mahout 0.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+.idea/
+.DS_Store
+log/*.log
+pkg/
+.rbenv-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    jruby_mahout (0.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (10.0.1)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  jruby_mahout!
+  rake
+  rspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Vasily Vasinov
+
+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,30 @@
+# Jruby Mahout
+Jruby Mahout is a gem that unleashes the power of Apache Mahout in the world of Jruby. Mahout is a superior machine learning library written in Java. It deals with recommendations, clustering and classification machine learning problems at scale. Until now it was difficult to use it in Ruby projects. You'd have to implement Java interfaces in Jruby yourself, which is not quick especially if you just started exploring the world of machine learning.
+
+The goal of this library is to make machine learning at scale in Jruby projects simple.
+
+## Quick Overview
+This is an early version of a Jruby gem that only supports Mahout recommendations. It also includes a simple Postgres manager that can be used to manage appropriate recommendations tables. Unfortunately it's impossible to use ActiveRecord (AR) with Mahout, because AR at a mach higher level and creates a lot of overhead that is critical when dealing with millions of records in real time.
+
+## Get Mahout
+First of all you need to download Mahout library from one of the [mirrors](http://www.apache.org/dyn/closer.cgi/mahout/). Jruby Mahout only supports Mahout 0.7 at this point.
+
+## Get Postgres JDBC Adapter
+If you wish to work with a database for recommendations, you'll have to install [JDBC driver for Postgres](http://jdbc.postgresql.org/download.html). Another option is to use file-based recommendation.
+
+## Installation
+### 1. Set environment variable MAHOUT_DIR to point at your Mahout installation.
+### 2. Add the gem to your `Gemfile`
+```ruby
+platform :jruby do
+  gem "jruby_mahout"
+end
+```
+And run `bundle install`.
+
+## Contribute
+- Fork the project.
+- Write code for a feature or bug fix.
+- Add Rspec tests for it.
+- Commit, do not make changes to rakefile or version.
+- Submit a pull request.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/jruby_mahout.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require "jruby_mahout/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "jruby_mahout"
+  gem.version     = JrubyMahout::VERSION
+  gem.authors     = ["Vasily Vasinov"]
+  gem.email       = ["vasinov@me.com"]
+  gem.homepage    = "https://github.com/vasinov/jruby_mahout"
+  gem.summary     = "Jruby Mahout is a gem that unleashes the power of Apache Mahout in the world of Jruby."
+  gem.description = "Jruby Mahout is a gem that unleashes the power of Apache Mahout in the world of Jruby. Mahout is a superior machine learning library written in Java. It deals with recommendations, clustering and classification machine learning problems at scale. Until now it was difficult to use it in Ruby projects. You'd have to implement Java interfaces in Jruby yourself, which is not quick especially if you just started exploring the world of machine learning."
+  gem.license = "MIT"
+
+  gem.files = Dir["{lib}/**/*"] + ["MIT-LICENSE", "README.md"]
+  gem.test_files = Dir["spec/**/*"]
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/jruby_mahout.rb

@@ -0,0 +1,8 @@
+module JrubyMahout
+  require 'java'
+  require File.join(ENV["MAHOUT_DIR"], 'mahout-core-0.7.jar')
+  require File.join(ENV["MAHOUT_DIR"], 'mahout-integration-0.7.jar')
+  require File.join(ENV["MAHOUT_DIR"], 'mahout-math-0.7.jar')
+  Dir.glob(File.join(ENV["MAHOUT_DIR"], 'lib/*.jar')).each { |d| require d }
+  Dir['./lib/jruby_mahout/*.rb'].each{ |f| require f }
+end

data/lib/jruby_mahout/data_model.rb

@@ -0,0 +1,20 @@
+module JrubyMahout
+  class DataModel
+    attr_accessor :data_model
+
+    def initialize(data_model_type, params)
+      case data_model_type
+        when "file"
+          @data_model = FileDataModel.new(java.io.File.new(params[:file_path]))
+        when "mysql"
+          # TODO: implement
+          @data_model = nil
+        when "postgres"
+          @data_model = PostgresManager.new(params).setup_data_model(params)
+        else
+          @data_model = nil
+      end
+    end
+  end
+end
+

data/lib/jruby_mahout/evaluator.rb

@@ -0,0 +1,18 @@
+module JrubyMahout
+  class Evaluator
+    def initialize(data_model, recommender_builder)
+      @data_model = data_model
+      @recommender_builder = recommender_builder
+      @mahout_evaluator = AverageAbsoluteDifferenceRecommenderEvaluator.new()
+    end
+
+    def evaluate(training_percentage, evaluation_percentage)
+      if @recommender_builder.recommender_name == "GenericItemBasedRecommender" and !@recommender_builder.item_based_allowed
+        nil
+      else
+        Float(@mahout_evaluator.evaluate(@recommender_builder, nil, @data_model, training_percentage, evaluation_percentage))
+      end
+    end
+  end
+end
+

data/lib/jruby_mahout/mahout_imports.rb

@@ -0,0 +1,34 @@
+# Recommenders
+java_import org.apache.mahout.cf.taste.eval.RecommenderBuilder
+java_import org.apache.mahout.cf.taste.impl.similarity.PearsonCorrelationSimilarity
+java_import org.apache.mahout.cf.taste.impl.similarity.EuclideanDistanceSimilarity
+java_import org.apache.mahout.cf.taste.impl.similarity.SpearmanCorrelationSimilarity
+java_import org.apache.mahout.cf.taste.impl.similarity.LogLikelihoodSimilarity
+java_import org.apache.mahout.cf.taste.impl.similarity.TanimotoCoefficientSimilarity
+java_import org.apache.mahout.cf.taste.impl.similarity.PearsonCorrelationSimilarity
+
+# Neighborhoods
+java_import org.apache.mahout.cf.taste.impl.neighborhood.NearestNUserNeighborhood
+
+# Recommenders
+java_import org.apache.mahout.cf.taste.impl.recommender.GenericUserBasedRecommender
+java_import org.apache.mahout.cf.taste.impl.recommender.GenericItemBasedRecommender
+java_import org.apache.mahout.cf.taste.impl.recommender.slopeone.SlopeOneRecommender
+
+# Weighting
+java_import org.apache.mahout.cf.taste.common.Weighting
+
+# Evaluators
+java_import org.apache.mahout.cf.taste.impl.eval.AverageAbsoluteDifferenceRecommenderEvaluator
+
+# Data Models
+java_import org.apache.mahout.cf.taste.impl.model.jdbc.PostgreSQLJDBCDataModel
+java_import org.apache.mahout.cf.taste.impl.model.file.FileDataModel
+
+
+# Postgres
+begin
+  java_import org.postgresql.ds.PGPoolingDataSource
+rescue Exception => e
+  puts e
+end

data/lib/jruby_mahout/mysql_manager.rb

@@ -0,0 +1,5 @@
+module JrubyMahout
+  class MysqlManager
+    # TODO: implement
+  end
+end

data/lib/jruby_mahout/postgres_manager.rb

@@ -0,0 +1,76 @@
+module JrubyMahout
+  class PostgresManager
+    attr_accessor :data_model, :data_source, :statement
+
+    def initialize(params)
+      @data_source = PGPoolingDataSource.new()
+      @data_source.setUser(params[:username])
+      @data_source.setPassword(params[:password])
+      @data_source.setServerName(params[:host])
+      @data_source.setPortNumber(params[:port])
+      @data_source.setDatabaseName(params[:db_name])
+    end
+
+    def setup_data_model(params)
+      begin
+        @data_model = PostgreSQLJDBCDataModel.new(@data_source, params[:table_name], "user_id", "item_id", "rating", "created")
+      rescue Exception => e
+        puts e
+      end
+    end
+
+    def create_statement
+      begin
+        connection = @data_source.getConnection()
+        @statement = connection.createStatement()
+      rescue Exception => e
+        puts e
+      end
+    end
+
+    def close_data_source
+      begin
+        @data_source.close()
+      rescue Exception => e
+        puts e
+      end
+    end
+
+    def upsert_record(record, name)
+      begin
+        @statement.execute("UPDATE #{name} SET user_id=#{record[:user_id]}, item_id=#{record[:item_id]}, rating=#{record[:rating]} WHERE user_id=#{record[:user_id]} AND item_id=#{record[:item_id]};")
+        @statement.execute("INSERT INTO #{name} (user_id, item_id, rating) SELECT #{record[:user_id]}, #{record[:item_id]}, #{record[:rating]} WHERE NOT EXISTS (SELECT 1 FROM #{name} WHERE user_id=#{record[:user_id]} AND item_id=#{record[:item_id]});")
+      rescue java.sql.SQLException => e
+        puts e
+      end
+    end
+
+    def create_table(name)
+      begin
+        @statement.executeUpdate("
+          CREATE TABLE #{name} (
+            user_id BIGINT NOT NULL,
+            item_id BIGINT NOT NULL,
+            rating int NOT NULL,
+            created TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+            PRIMARY KEY (user_id, item_id)
+          );
+        ")
+        @statement.executeUpdate("CREATE INDEX #{name}_user_id_index ON #{name} (user_id);")
+        @statement.executeUpdate("CREATE INDEX #{name}_item_id_index ON #{name} (item_id);")
+      rescue java.sql.SQLException => e
+        puts e
+      end
+    end
+
+    def delete_table(name)
+      begin
+        @statement.executeUpdate("DROP INDEX IF EXISTS #{name}_user_id_index;")
+        @statement.executeUpdate("DROP INDEX IF EXISTS #{name}_item_id_index;")
+        @statement.executeUpdate("DROP TABLE IF EXISTS #{name};")
+      rescue java.sql.SQLException => e
+        puts e
+      end
+    end
+  end
+end

data/lib/jruby_mahout/recommender.rb

@@ -0,0 +1,78 @@
+module JrubyMahout
+  class Recommender
+    attr_accessor :is_weighted, :neighborhood_size, :similarity_name, :recommender_name, :data_model
+
+    def initialize(similarity_name, neighborhood_size, recommender_name, is_weighted)
+      @is_weighted = is_weighted
+      @neighborhood_size = neighborhood_size
+      @similarity_name = similarity_name
+      @recommender_name = recommender_name
+      @recommender_builder = RecommenderBuilder.new(@similarity_name,
+                                                   @neighborhood_size,
+                                                   @recommender_name,
+                                                   @is_weighted)
+      @data_model = nil
+      @recommender = nil
+    end
+
+    def data_model=(data_model)
+      @data_model = data_model
+      @recommender = @recommender_builder.buildRecommender(@data_model)
+    end
+
+    def recommend(user_id, number_of_items, rescorer)
+      if @recommender.nil?
+        nil
+      else
+        recommendations_to_array(@recommender.recommend(user_id, number_of_items, rescorer))
+      end
+    end
+
+    def evaluate(training_percentage, evaluation_percentage)
+      evaluator = Evaluator.new(@data_model, @recommender_builder)
+      evaluator.evaluate(training_percentage, evaluation_percentage)
+    end
+
+    def similar_items(item_id, number_of_items, rescorer)
+      if @recommender.nil? or @recommender_name == "GenericItemBasedRecommender"
+        nil
+      else
+        @recommender.mostSimilarItems(item_id, number_of_items, rescorer)
+      end
+    end
+
+    def similar_users(user_id, number_of_items, rescorer)
+      if @recommender.nil? or @recommender_name == "GenericUserBasedRecommender"
+        nil
+      else
+        @recommender.mostSimilarUserIDs(user_id, amount, rescorer)
+      end
+    end
+
+    def estimate_preference(user_id, item_id)
+      if @recommender.nil?
+        nil
+      else
+        @recommender.estimatePreference(user_id, item_id)
+      end
+    end
+
+    def recommended_because(user_id, item_id, number_of_items)
+      if @recommender.nil? or @recommender_name == "GenericItemBasedRecommender"
+        nil
+      else
+        @recommender.recommendedBecause(user_id, item_id, number_of_items)
+      end
+    end
+
+    private
+    def recommendations_to_array(recommendations)
+      recommendations_array = []
+      recommendations.each do |recommendation|
+        recommendations_array << [recommendation.getItemID, recommendation.getValue.round(5)]
+      end
+
+      recommendations_array
+    end
+  end
+end

data/lib/jruby_mahout/recommender_builder.rb

@@ -0,0 +1,56 @@
+module JrubyMahout
+  class RecommenderBuilder
+    attr_accessor :recommender_name, :item_based_allowed
+    # public interface RecommenderBuilder
+    # Implementations of this inner interface are simple helper classes which create a Recommender to be evaluated based on the given DataModel.
+    def initialize(similarity_name, neighborhood_size, recommender_name, is_weighted)
+      @is_weighted = is_weighted
+      @neighborhood_size = neighborhood_size
+      @similarity_name = similarity_name
+      @recommender_name = recommender_name
+      @item_based_allowed = (@similarity_name == "SpearmanCorrelationSimilarity") ? false : true
+    end
+
+    # buildRecommender(DataModel dataModel)
+    # Builds a Recommender implementation to be evaluated, using the given DataModel.
+    def buildRecommender(data_model)
+      begin
+        case @similarity_name
+          when "PearsonCorrelationSimilarity"
+            similarity = (@is_weighted) ? PearsonCorrelationSimilarity.new(data_model, Weighting::WEIGHTED) : PearsonCorrelationSimilarity.new(data_model)
+          when "EuclideanDistanceSimilarity"
+            similarity = (@is_weighted) ? EuclideanDistanceSimilarity.new(data_model, Weighting::WEIGHTED) : EuclideanDistanceSimilarity.new(data_model)
+          when "SpearmanCorrelationSimilarity"
+            similarity = SpearmanCorrelationSimilarity.new(data_model)
+          when "LogLikelihoodSimilarity"
+            similarity = LogLikelihoodSimilarity.new(data_model)
+          when "TanimotoCoefficientSimilarity"
+            similarity = TanimotoCoefficientSimilarity.new(data_model)
+          when "GenericItemSimilarity"
+            similarity = PearsonCorrelationSimilarity.new(data_model, Weighting::WEIGHTED)
+          else
+            similarity = nil
+        end
+
+        unless @neighborhood_size.nil?
+          neighborhood = NearestNUserNeighborhood.new(Integer(@neighborhood_size), similarity, data_model)
+        end
+
+        case @recommender_name
+          when "GenericUserBasedRecommender"
+            recommender = GenericUserBasedRecommender.new(data_model, neighborhood, similarity)
+          when "GenericItemBasedRecommender"
+            recommender = (@item_based_allowed) ? GenericItemBasedRecommender.new(data_model, similarity) : nil
+          when "SlopeOneRecommender"
+            recommender = SlopeOneRecommender.new(data_model)
+          else
+            recommender = nil
+        end
+
+        recommender
+      rescue Exception => e
+        return e
+      end
+    end
+  end
+end

data/lib/jruby_mahout/version.rb

@@ -0,0 +1,3 @@
+module JrubyMahout
+  VERSION = '0.2.0'
+end