scoruby 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98eb545b1bb149f22fb5afbaf467d144af1dbb2c
+  data.tar.gz: dbae0fa59acbf5bb10252bd1971cda46fafb8095
+SHA512:
+  metadata.gz: c572f65fdd04226519f6518aa56ec92d942b8882c700828f2c17447b89cff9286fea243a8f171b2b259b3a15dbce6985ea474ff14a802894fa068546db355ce8
+  data.tar.gz: 9bd8096adc82636f5a10d6b93d6f0230a7a82b67a755da53153b32dc58c29887a06a31af86235bf2533792bdbccc8b9c77d9677bb3c099c8ab30793aa4696ce4

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scoruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 asaf schers
+
+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,49 @@
+<a href="https://codeclimate.com/github/asafschers/scoruby"><img src="https://codeclimate.com/github/asafschers/scoruby/badges/gpa.svg" /></a>
+[![Gem Version](https://badge.fury.io/rb/random_forester.svg)](https://badge.fury.io/rb/random_forester)
+[![Build Status](https://travis-ci.org/asafschers/scoruby.svg?branch=master)](https://travis-ci.org/asafschers/scoruby)
+
+# Scoruby
+
+Reads Random Forest PMML files and creates Ruby Random Forest classifier model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scoruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scoruby
+
+## Usage
+
+```ruby
+random_forest = Scourby.get_model 'rf.pmml'
+features = {a: 1, b: true, c: "YES"}
+random_forest.predict(features)
+random_forest.decisions_count(features)
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/asafschers/scoruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "pry -r scoruby -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scoruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/gbm/gbm.rb

@@ -0,0 +1,23 @@
+require 'gbm_decision_tree'
+
+class Gbm
+  GBM_FOREST_XPATH = '//Segmentation[@multipleModelMethod="sum"]/Segment'
+  CONST_XPATH      = '//Constant[@dataType="double"]'
+
+  def initialize(xml)
+    @decision_trees = xml.xpath(GBM_FOREST_XPATH).collect{ |xml_tree|
+      GbmDecisionTree.new(xml_tree)
+    }
+    @const = Float(xml.xpath(CONST_XPATH).children[0].content)
+  end
+
+  def tree_count
+    @decision_trees.count
+  end
+
+  def score(features)
+    x = @decision_trees.map { |dt| dt.decide(features) }.reduce(:+) + @const
+    Math.exp(x) / (1 + Math.exp(x))
+  end
+end
+

data/lib/gbm/gbm_decision_tree.rb

@@ -0,0 +1,37 @@
+require 'gbm_node'
+
+class GbmDecisionTree
+  attr_reader :root
+
+  def initialize(tree_xml)
+    @id = tree_xml.attribute('id')
+    @root = GbmNode.new(tree_xml.xpath('TreeModel/Node'))
+  end
+
+  def decide(features)
+    curr = @root
+    while curr.score.nil?
+      prev = curr
+      curr = step(curr, features)
+      return if didnt_step?(curr, prev)
+    end
+
+    curr.score
+  end
+
+  private
+
+  def step(curr, features)
+    curr = curr.left if curr.left && curr.left.true?(features)
+    curr = curr.right if curr.right && curr.right.true?(features)
+    curr = curr.missing if curr.missing && curr.missing.true?(features)
+    curr
+  end
+
+  def didnt_step?(curr, prev)
+    return false if (prev.pred != curr.pred)
+    Scoruby.logger.error "Null tree: #{@id}, bad feature: #{curr.left.pred.field }"
+    true
+  end
+  
+end

data/lib/gbm/gbm_node.rb

@@ -0,0 +1,23 @@
+require 'gbm_predicate'
+
+class GbmNode
+
+  attr_reader :score, :missing, :left, :right, :pred
+
+  def initialize(xml)
+    children = xml.children
+    @pred = GbmPredicate.new(children[0])
+
+    @score = xml.attribute('score').to_s.to_f unless xml.attribute('score').to_s.empty?
+
+    return if children.count == 1
+    @missing = GbmNode.new(children[1]) if children[1]
+    @left = GbmNode.new(children[2]) if children[2]
+    @right = GbmNode.new(children[3]) if children[3]
+  end
+
+  def true?(features)
+    @pred.nil? || @pred.true?(features)
+  end
+
+end

data/lib/gbm/gbm_predicate.rb

@@ -0,0 +1,18 @@
+require 'simple_predicate'
+require 'simple_set_predicate'
+
+class GbmPredicate
+
+  def initialize(pred_xml)
+    @pred = SimplePredicate.new(pred_xml) if pred_xml.name == 'SimplePredicate'
+    @pred = SimpleSetPredicate.new(pred_xml) if pred_xml.name == 'SimpleSetPredicate'
+  end
+
+  def field
+    @pred.field
+  end
+
+  def true?(features)
+    @pred.true?(features)
+  end
+end

data/lib/random_forest/decision_tree.rb

@@ -0,0 +1,36 @@
+require 'node'
+
+class DecisionTree
+
+  attr_reader :root
+
+  def initialize(tree_xml)
+    @id = tree_xml.attribute('id')
+    @root = Node.new(tree_xml.xpath('TreeModel/Node'))
+  end
+
+  def decide(features)
+    curr = @root
+    while curr.decision == ''
+      prev = curr
+      curr = step(curr, features)
+      return if didnt_step?(curr, prev)
+    end
+
+    curr.decision
+  end
+
+  private
+
+  def step(curr, features)
+    curr = curr.left if curr.left && curr.left.true?(features)
+    curr = curr.right if curr.right && curr.right.true?(features)
+    curr
+  end
+
+  def didnt_step?(curr, prev)
+    return false if (prev.pred != curr.pred)
+    Scoruby.logger.error "Null tree: #{@id}, bad feature: #{curr.left.pred.field }"
+    true
+  end
+end

data/lib/random_forest/node.rb

@@ -0,0 +1,21 @@
+require 'predicate'
+
+class Node
+
+  attr_reader :decision, :left, :right, :pred
+
+  def initialize(xml)
+    children = xml.children
+    @pred = Predicate.new(children[0])
+
+    @decision = xml.attribute('score').to_s
+
+    return if children.count == 1
+    @left = Node.new(children[1]) if children[1]
+    @right = Node.new(children[2]) if children[2]
+  end
+
+  def true?(features)
+    @pred.nil? || @pred.true?(features)
+  end
+end

data/lib/random_forest/predicate.rb

@@ -0,0 +1,32 @@
+require 'simple_predicate'
+require 'simple_set_predicate'
+
+class Predicate
+
+  def initialize(pred_xml)
+    @pred = SimplePredicate.new(pred_xml) if pred_xml.name == 'SimplePredicate'
+    @pred = SimpleSetPredicate.new(pred_xml) if pred_xml.name == 'SimpleSetPredicate'
+  end
+
+  def field
+    @pred.field
+  end
+
+  def true?(features)
+    return if missing_feature?(features)
+    return if nil_feature?(features)
+    @pred.true?(features)
+  end
+
+  def missing_feature?(features)
+    return false if features.has_key? field
+    Scoruby.logger.error "Missing feature #{field}"
+    true
+  end
+
+  def nil_feature?(features)
+    return false unless features[field].nil?
+    Scoruby.logger.error "Feature #{field} value is nil"
+    true
+  end
+end

data/lib/random_forest/random_forest.rb

@@ -0,0 +1,24 @@
+require 'decision_tree'
+
+class RandomForest
+  RF_FOREST_XPATH = 'PMML/MiningModel/Segmentation/Segment'
+
+  def initialize(xml)
+    xml_trees = xml.xpath(RF_FOREST_XPATH)
+    @decision_trees = xml_trees.collect{ |xml_tree|
+      DecisionTree.new(xml_tree)
+    }
+  end
+
+  def decisions_count(features)
+    decisions = @decision_trees.collect { |decision_tree|
+      decision_tree.decide(features)
+    }
+    decisions.inject(Hash.new(0)) { |h, e| h[e] += 1 ; h }
+  end
+
+  def predict(features)
+    decisions_count(features).max_by {|_, v|  v }[0]
+  end
+
+end

data/lib/random_forest/simple_predicate.rb

@@ -0,0 +1,44 @@
+class SimplePredicate
+
+  GREATER_THAN = 'greaterThan'
+  LESS_THAN = 'lessThan'
+  LESS_OR_EQUAL = 'lessOrEqual'
+  GREATER_OR_EQUAL = 'greaterOrEqual'
+  MATH_OPS = [GREATER_THAN, LESS_THAN, LESS_OR_EQUAL, GREATER_OR_EQUAL]
+  EQUAL = 'equal'
+  IS_MISSING = 'isMissing'
+
+  attr_reader :field
+
+  def initialize(pred_xml)
+    attributes = pred_xml.attributes
+
+    @field = attributes['field'].value.to_sym
+    @operator = attributes['operator'].value
+    return if @operator == IS_MISSING
+    @value = attributes['value'].value 
+  end
+
+  def true?(features)
+    format_boolean(features)
+    return num_true?(features) if MATH_OPS.include?(@operator)
+
+    return features[@field] == @value if @operator == EQUAL
+    features[field].nil? || !features.has_key?(field) if @operator == IS_MISSING
+  end
+
+  def num_true?(features)
+    return false unless features[@field]
+    curr_value = Float(features[@field])
+    value = Float(@value)
+    return curr_value > value if @operator == GREATER_THAN
+    return curr_value < value if @operator == LESS_THAN
+    return curr_value <= value if @operator == LESS_OR_EQUAL
+    curr_value >= value if @operator == GREATER_OR_EQUAL
+  end
+
+  def format_boolean(features)
+    features[@field] = 'f' if features[@field] == false
+    features[@field] = 't' if features[@field] == true
+  end
+end

data/lib/random_forest/simple_set_predicate.rb

@@ -0,0 +1,31 @@
+class SimpleSetPredicate
+
+  IS_IN = 'isIn'
+
+  attr_reader :field
+
+  def initialize(pred_xml)
+    attributes = pred_xml.attributes
+    @field = attributes['field'].value.to_sym
+    @array = single_or_quoted_words(pred_xml.children[0].content)
+    @operator = attributes['booleanOperator'].value
+  end
+
+  def true?(features)
+    format_boolean(features)
+    @array.include? features[@field] if @operator == IS_IN
+  end
+
+  private
+
+  def single_or_quoted_words(string)
+    string.split(/\s(?=(?:[^"]|"[^"]*")*$)/).
+        reject(&:empty?).
+        map { |w| w.tr('"','')}
+  end
+
+  def format_boolean(features)
+    features[@field] = 'f' if features[@field] == false
+    features[@field] = 't' if features[@field] == true
+  end
+end

data/lib/scoruby.rb

@@ -0,0 +1,51 @@
+require 'scoruby/version'
+require 'nokogiri'
+require 'random_forest'
+require 'gbm'
+require 'logger'
+require 'pry'
+
+module Scoruby
+  RANDOM_FOREST_MODEL = 'randomForest_Model'
+  GBM_INDICATION = '//OutputField[@name="scaledGbmValue"]'
+  MODEL_NOT_SUPPORTED_ERROR = 'model not supported'
+
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = self.name
+      end
+    end
+  end
+
+  def self.get_model(pmml_file_name)
+    xml = xml_from_file_path(pmml_file_name)
+    new_model(xml)
+  end
+
+  def self.new_model(xml)
+    return RandomForest.new(xml) if random_forest?(xml)
+    return Gbm.new(xml) if gbm?(xml)
+    raise MODEL_NOT_SUPPORTED_ERROR
+  end
+
+  def self.xml_from_file_path(pmml_file_name)
+    pmml_string = File.open(pmml_file_name, 'rb').read
+    xml_from_string(pmml_string)
+  end
+
+  def self.xml_from_string(pmml_string)
+    xml = Nokogiri::XML(pmml_string) { |config| config.noblanks }
+    xml.remove_namespaces!
+  end
+
+  def self.random_forest?(xml)
+    xml.xpath('PMML/MiningModel/@modelName').to_s == RANDOM_FOREST_MODEL
+  end
+
+  def self.gbm?(xml)
+    !xml.xpath(GBM_INDICATION).empty?
+  end
+end

data/lib/scoruby/version.rb

@@ -0,0 +1,3 @@
+module Scoruby
+  VERSION = '0.1.3'
+end

data/scoruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scoruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scoruby"
+  spec.version       = Scoruby::VERSION
+  spec.authors       = ["Asaf Schers"]
+  spec.email         = ["schers@riskified.com"]
+
+  spec.summary       = %q{Creates a random forest object from a pmml file.}
+  spec.homepage      = 'https://github.com/asafschers/scoruby'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "lib/random_forest", "lib/gbm"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "ruby-prof"
+  spec.add_dependency "nokogiri", "~> 1.7"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: scoruby
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Asaf Schers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: 
+email:
+- schers@riskified.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/gbm/gbm.rb
+- lib/gbm/gbm_decision_tree.rb
+- lib/gbm/gbm_node.rb
+- lib/gbm/gbm_predicate.rb
+- lib/random_forest/decision_tree.rb
+- lib/random_forest/node.rb
+- lib/random_forest/predicate.rb
+- lib/random_forest/random_forest.rb
+- lib/random_forest/simple_predicate.rb
+- lib/random_forest/simple_set_predicate.rb
+- lib/scoruby.rb
+- lib/scoruby/version.rb
+- scoruby.gemspec
+homepage: https://github.com/asafschers/scoruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/random_forest
+- lib/gbm
+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: Creates a random forest object from a pmml file.
+test_files: []
+has_rdoc: