pmml_consumer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71a1bb8e8baf276924decd5e2a2f1fbe0289cdca
+  data.tar.gz: 5bfa9c66b0c34caa5426c76ea9fd1e65d23f381b
+SHA512:
+  metadata.gz: 6d8f878175b7df250b8bd6277005c234d009528df8e3f8c62feccfd55d20cee94cd1f467ed44c5bd916da734f856faefff82dda49cdbe2541575a210016fb1d0
+  data.tar.gz: dd631650ab36da646d11c6154b610df0a8a2d0f9dad8b14349cd964397f02779acdf8e643964120ad583256870499b9b90e7a6b9338ed740ab02e1d1fd144f68

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+LineLength:
+  Max: 160
+StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

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

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 pmml_consumer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 romain.sagean
+
+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,43 @@
+# Ruby PMML Consumer
+
+Generate a PMML file with your favorite machine learning library and use this gem to read the file and make prediciton in a ruby application. This gem is primarily intended to work with apache spark 1.5 PMML file, so some features from the PMML standard maybe missing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pmml_consumer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pmml_consumer
+
+## Usage
+
+```ruby
+pmml_string = File.open('my_pmml_file.xml', "rb").read
+predictor = PMMLConsumer.load(pmml_string)
+input = { "feature1" => 1, "feature2" => "banana"}
+puts predictor.predict(input)
+```
+
+## 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/hupi-analytics/pmml_consumer. 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 pmml_consumer -I ./lib"
+end

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pmml_consumer"
+
+# 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.
+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/pmml_consumer.rb

@@ -0,0 +1,50 @@
+require "pmml_consumer/version"
+require "nokogiri"
+
+require "pmml_consumer/ml_model"
+require "pmml_consumer/regression_model"
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+module PMMLConsumer
+  def self.load(pmml_string, model_name: nil)
+    xml = Nokogiri::XML(pmml_string)
+
+    ml_model = model_node(xml, model_name)
+
+    case ml_model.name
+    when 'RegressionModel'
+      RegressionModel.new(ml_model, field_type(xml))
+    else
+      MLModel.new(ml_model, field_type(xml))
+    end
+  end
+
+  def self.field_type(xml)
+    xml.xpath("/xmlns:PMML/xmlns:DataDictionary/xmlns:DataField").each_with_object({}) do |child, memo|
+      memo[child.attributes["name"].value] = case child.attributes["optype"].value
+      when "continuous"
+        child.to_h.reject! { |key| %w(name optype).include?(key) }
+      when "categorical"
+        data_field_h = child.to_h.reject! { |key| %w(name optype).include?(key) }
+        data_field_h["values"] = child.xpath("xmlns:Value").map do |cat|
+          cat.attributes["value"].value
+        end
+        data_field_h
+      else
+        raise "unknow optype: #{child.attributes['optype'].value}"
+      end
+    end
+  end
+
+  def self.model_node(xml, model_name)
+    if model_name.nil?
+      xml.xpath("/xmlns:PMML/*[contains(name(), 'Model') or (name() = 'NeuralNetwork') or (name() = 'Scorecard')]").first
+    else
+      xml.xpath("/xmlns:PMML/*[@modelName='#{model_name}']").first
+    end
+  end
+end

data/lib/pmml_consumer/ml_model.rb

@@ -0,0 +1,56 @@
+require "nokogiri"
+module PMMLConsumer
+  class MLModel
+    attr_accessor :model_node, :fields_type
+
+    def initialize(model_node, field_type)
+      @model_node = model_node
+      @fields_type = filter_field(field_type)
+      @target_fields = target_fields
+    end
+
+    def predict(input)
+      raise "not implemented"
+    end
+
+    def cast_input(input)
+      @fields_type.each do |field_name, field_type|
+        input[field_name] = if input[field_name].nil? && !field_type["missingValueReplacement"].nil?
+          field_type["missingValueReplacement"]
+        elsif input[field_name].nil? && field_type["missingValueReplacement"].nil?
+          raise "value '#{field_name}' not found and no value replacement set"
+        else
+          case field_type["dataType"]
+          when "double"
+            input[field_name].to_f
+          when "integer"
+            input[field_name].to_i
+          when "string"
+            input[field_name].to_s
+          else
+            raise "unknow dataType: #{field_type["dataType"]}"
+          end
+        end
+        if field_type["values"].is_a?(Array) && !field_type["values"].include?(input[field_name])
+          raise "not a valid value: #{input[field_name]}"
+        end
+      end
+      input
+    end
+
+    def filter_field(field_type)
+      @model_node.xpath("xmlns:MiningSchema/xmlns:MiningField").each do |mining_field|
+        unless mining_field.attributes["usageType"].nil? || mining_field.attributes["usageType"].value == "active"
+          field_type.delete(mining_field.attributes["name"].value)
+        end
+      end
+      field_type
+    end
+
+    def target_fields
+      @model_node.xpath("xmlns:MiningSchema/xmlns:MiningField[@usageType='target']").map do |mining_field|
+        mining_field["name"]
+      end
+    end
+  end
+end

data/lib/pmml_consumer/regression_model.rb

@@ -0,0 +1,98 @@
+module PMMLConsumer
+  class RegressionModel < MLModel
+
+    def predict(input)
+      cast_input(input)
+      res = @model_node.xpath("xmlns:RegressionTable").each_with_object({}) do |regression_table, result|
+        res_name = regression_table["targetCategory"]
+        res_name ||= @model_node["targetFieldName"]
+        res_name ||= @target_fields.first
+        result[res_name] = regression_table["intercept"].to_f
+        regression_table.element_children.each do |predictor|
+          case predictor.name
+          when "NumericPredictor"
+            coefficient = predictor["coefficient"].to_f
+            exponent = (predictor["exponent"] || "1").to_i
+            result[res_name] += coefficient * (input[predictor["name"]]**exponent)
+          when "CategoricalPredictor"
+            if predictor["value"] == input[predictor["name"]]
+              result[res_name] += predictor["coefficient"].to_f
+            end
+          when "PredictorTerm"
+            coefficient = predictor["coefficient"].to_f
+            predictor.element_children.each do |field_ref|
+              coefficient *= input[field_ref["field"]]
+            end
+            result[res_name] += coefficient
+          else
+            raise "unknow predictor name: #{predictor.name}"
+          end
+        end
+      end
+      case @model_node["normalisationMethod"]
+      when "softmax"
+        softmax(res)
+      when "logit"
+        logit(res)
+      when "probit"
+        probit(res)
+      when "cloglog"
+        cloglog(res)
+      when "loglog"
+        loglog(res)
+      when "cauchit"
+        cauchit(res)
+      when "exp"
+        exp(res)
+      when nil, "none"
+      else
+        raise "unknow normalisation method: #{@model_node["normalisationMethod"]}"
+      end
+      res
+    end
+
+    def softmax(result)
+      if result.count == 1
+        1 / (1 + Math.exp(-result.values.first))
+      else
+        sum1n = result.values.reduce(:+)
+        result.each do |k, v|
+          result[k] = Math.exp(v) / sum1n
+        end
+      end
+    end
+
+    def logit(result)
+      result.each do |k, v|
+        result[k] = 1 / (1 + Math.exp(-v))
+      end
+    end
+
+    def cloglog(result)
+      raise "error" if result.count == 1
+      result.each do |k, v|
+        result[k] = 1 - Math.exp(-Math.exp(v))
+      end
+    end
+
+    def loglog(result)
+      raise "error" if result.count == 1
+      result.each do |k, v|
+        result[k] = Math.exp(-Math.exp(-v))
+      end
+    end
+
+    def cauchit(result)
+      raise "error" if result.count == 1
+      result.each do |k, v|
+        result[k] = 0.5 + (1 / Math::PI) * Math.atan(v)
+      end
+    end
+
+    def exp(result)
+      result.each do |k, v|
+        result[k] = Math.exp(v)
+      end
+    end
+  end
+end

data/lib/pmml_consumer/version.rb

@@ -0,0 +1,3 @@
+module PMMLConsumer
+  VERSION = "0.1.0"
+end

data/pmml_consumer.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pmml_consumer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pmml_consumer"
+  spec.version       = PMMLConsumer::VERSION
+  spec.authors       = ["scauglog"]
+  spec.email         = ["scauglog@gmail.com"]
+
+  spec.summary       = %q{read a PMML file and use it to make prediction}
+  spec.homepage      = "https://github.com/hupi-analytics/pmml_consumer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "nokogiri", "~> 1.6"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: pmml_consumer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- scauglog
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-10 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- scauglog@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pmml_consumer.rb
+- lib/pmml_consumer/ml_model.rb
+- lib/pmml_consumer/regression_model.rb
+- lib/pmml_consumer/version.rb
+- pmml_consumer.gemspec
+homepage: https://github.com/hupi-analytics/pmml_consumer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: read a PMML file and use it to make prediction
+test_files: []