ibm-ml 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8043c7c62f75f733b6e6b714c9dd3cd9a231c418
-  data.tar.gz: 2e9cc28ef1ac51cb993785890ae4ebbf95e7e3c7
+  metadata.gz: 9181a59f405e92671980ea2483c050acece5a3db
+  data.tar.gz: c260419693c752f3e050031e1005de5da5a62177
 SHA512:
-  metadata.gz: 42bfc1730006f18327265ec024d5427edc895938d90a07c73c1c33353ea07fb2d88b31a937959df2b1bf1672c0f8bda867cb08b400f9317321a75cc423fdfa76
-  data.tar.gz: e13d5dfd1365ecae5acffdd8e2223abb07e876c7412206ffe8a63cab713d96bf5d93db0a72a0ffb84dd8d945111aa8ddc62c612150d6adcb1c60ee31581d293e
+  metadata.gz: 96b92a8a2e4af5bd444a689975676e6fc4c7d849863eaae472806a9fd03e69dc630420ed0fb19acad635dca5a3a8b5c2e4e337837b30e85dececf48098c90987
+  data.tar.gz: 55a34c8a5899d2986ea0c637cc5a2e9e33bf14096c76e0e9e17dd5b069a805245f77b9ac3bec6fa04990a0bf0082272e05f04db0bb3c91f934fb17fff2ecdbdb

data/.travis.yml

@@ -12,3 +12,5 @@ deploy:
   gem: ibm-ml
   api_key:
     secure: KrW9QsWC2deO9ubwZxQSRcbL8Azj4xkE0KpY30B564/o3qJOFZN98cevVJ7EujyxA+HVXWsdvEsr+PHk17fCSbSlbnmcRS0C7BSy7RCNWgHhDd2hiUG32QXszpr5ZFvXkzlZ9N5gNRzlIpOVckQS2swYCt20GNTn6XQ69a9j7wMER68bDT4gWCkq+xssioS5PaE1hFqOvPDXRltigIz3cZz8+8UDnPzprTyyJ235KNktEFs4OUWGrDwfbgoJs3K744+PvYyTxw+xenlZ6huZqEYmYAws/okIPKenQ/qiTBOx4RRRkVOXWzZ4kUexJiAdIoxKunZ1bPjTtip3AKa1nu3FdgJqq3DZxxX5wftKyeeZYyOoZs+e24Vi79JGXSRcHpMDi578nd5Fqu1UU6weTjS11DHhxX2rPNYRBcvCwXxKCnrw3IY8bzhQ2cF3K1PTV6g6RCXqEY/IKqex6RUw+dcPxqFNaH5VIgyDxs3TUUkEUmsGfHZmyz1MXNjnrLJRQki+H25LpHhOP/lcwJZuLjwNca5uBp01M0R89gsumLVvI5fxpteWjFMUTMZ397sC6Ve0/PmggYxuwLre1nT1N8MMVX79oHXwxeOHltw9lcR4wOc7oIPX8BzgtLvnCvsha9AHXP8F0n0u2F8UrJr25sBQ0CXLpTeTG+zG2t63L5s=
+  on:
+    rvm: 2.4.0

data/README.md

@@ -10,14 +10,14 @@ Currently supports:
 
 ## Installation
 
-#### With Gem
+### With Gem
 After [installing Ruby](https://www.ruby-lang.org/en/documentation/installation/) >= 2.0:
 
 ```bash
 $ gem install ibm-ml
 ```
 
-#### With Bundler
+### With Bundler
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -32,12 +32,12 @@ $ bundle install
 
 ## Usage
 
-#### Setup
+### Setup
 ```ruby
 require 'ibm/ml'
 require 'pp'
 
-# example input record to score 
+# input record to score 
 record = {
   GENDER:        'M',
   AGEGROUP:      '45-54',
@@ -50,30 +50,53 @@ record = {
 }
 ```
 
-#### Cloud
+### Cloud 
 ```ruby
-USERNAME =      # ML service username
-PASSWORD =      # ML service password
-MODEL_ID =      # model ID
-DEPLOYMENT_ID = # deployment ID
-
-service = IBM::ML::Cloud.new(USERNAME, PASSWORD)
-pp service.fetch_token
-pp service.published_models
-pp service.deployments
-pp service.get_score(MODEL_ID, DEPLOYMENT_ID, record)
+CLOUD_USERNAME  =  # WML service username
+CLOUD_PASSWORD  =  # WML service password
+DEPLOYMENT_ID   =  # deployment ID
+
+# Create the service object
+ml_service = IBM::ML::Cloud.new(CLOUD_USERNAME, CLOUD_PASSWORD)
+
+# Fetch an authentication token
+pp ml_service.fetch_token
+
+# Query models
+pp ml_service.models
+pp ml_service.model_by_name('ML Model')
+
+# Query deployments
+pp ml_service.deployments
+pp ml_service.deployment(DEPLOYMENT_ID)
+pp ml_service.deployment_by_name('Deployed ML Model')
+
+# Get a score for the given deployment and record
+score = ml_service.score(DEPLOYMENT_ID, record)
+score = ml_service.score_by_name('Deployed ML Model', record)
+pp score
+prediction = ml_service.query_score(score, 'prediction')
+probability = ml_service.query_score(score, 'probability')[prediction]
+puts
+puts "Prediction = #{prediction == 1}"
+puts "Probability = #{(probability * 100).round(1)}%"
 ```
 
-#### Local
+### Local
 ```ruby
-HOST =          # DSX Local hostname / IP address
-USERNAME =      # DSX Local username
-PASSWORD =      # DSX Local password
-DEPLOYMENT_ID = # deployment ID
-
-service = IBM::ML::Local.new(HOST, USERNAME, PASSWORD)
-pp service.fetch_token
-pp service.get_score(DEPLOYMENT_ID, record)
+LOCAL_HOST      =  # DSX Local hostname / IP address
+LOCAL_USERNAME  =  # DSX Local username
+LOCAL_PASSWORD  =  # DSX Local password
+DEPLOYMENT_ID   =  # deployment ID
+
+# Create the service object
+ml_service = IBM::ML::Local.new(LOCAL_HOST, LOCAL_USERNAME, LOCAL_PASSWORD)
+
+# Fetch an authentication token
+pp ml_service.fetch_token
+
+# Get a score for the given deployment and record
+pp ml_service.score(DEPLOYMENT_ID, record)
 ```
 
 ## Development

data/lib/ibm/ml.rb

@@ -32,7 +32,7 @@ module IBM
 
     def get_request(addr, top_key)
       url     = URI(addr)
-      header  = { 'authorization' => "Bearer #{fetch_token}" }
+      header  = auth_header
       request = Net::HTTP::Get.new url, header
 
       response = @http.request(request)
@@ -40,5 +40,22 @@ module IBM
       body = JSON.parse(response.read_body)
       body.key?(top_key) ? body : raise(body['message'])
     end
+
+    def auth_header
+      { 'authorization' => "Bearer #{fetch_token}" }
+    end
+
+    def post_request(url, body)
+      request = Net::HTTP::Post.new(url, post_header)
+      request.body = body
+      response = @http.request(request)
+      JSON.parse(response.read_body)
+    end
+
+    def post_header
+      header = auth_header
+      header['content-type'] = 'application/json'
+      header
+    end
   end
 end

data/lib/ibm/ml/cloud.rb

@@ -10,7 +10,7 @@ module IBM
         @http.use_ssl = true
       end
 
-      def published_models
+      def models
         get_request "https://#{@host}/v2/published_models", 'resources'
       end
 
@@ -18,31 +18,44 @@ module IBM
         get_request "https://#{@host}/v2/deployments", 'resources'
       end
 
-      def get_model(model_id)
+      def deployment(deployment_id)
+        find_by_id(deployments, deployment_id)
+      end
+
+      def deployment_by_name(name)
+        find_by_name(deployments, name)
+      end
+
+      def model(model_id)
         get_request "https://#{@host}/v2/published_models/#{model_id}", 'entity'
       end
 
-      def get_score(model_id, deployment_id, record)
-        url = URI("https://#{@host}/v2/published_models/#{model_id}/deployments/#{deployment_id}/online")
+      def model_by_name(name)
+        find_by_name(models, name)
+      end
+
+      def score_by_name(name, record)
+        deployment = find_by_name(deployments, name)
+        score(deployment['metadata']['guid'], record)
+      end
 
-        # noinspection RubyStringKeysInHashInspection
-        header = {
-          'authorization' => "Bearer #{fetch_token}",
-          'content-type'  => 'application/json'
-        }
+      def score(deployment_id, record)
+        deployment = deployment(deployment_id)['entity']
+        model_fields = model(deployment['published_model']['guid'])['entity']['input_data_schema']['fields']
 
-        model_fields = get_model(model_id)['entity']['input_data_schema']['fields']
-        request      = Net::HTTP::Post.new(url, header)
-        request.body = {
+        response = post_request deployment['scoring_href'], {
           fields: model_fields.map { |field| field['name'] },
           values: [record.values]
         }.to_json
 
-        response = @http.request(request)
+        raise(response['message'] + ' : ' + response['description']) if response.key?('message')
+        response
+      end
 
-        body = JSON.parse(response.read_body)
-        return body if body.key?('fields') && body.key?('values')
-        raise(body['message'] + ' : ' + body['description'])
+      def query_score(score, field)
+        fields = score['fields'].map(&:upcase)
+        index = fields.index(field.upcase)
+        score['values'].map { |record| record[index] }[0]
       end
 
       private
@@ -61,6 +74,22 @@ module IBM
       def process_ldap_response(response)
         JSON.parse(response.read_body)['token']
       end
+
+      def find_by_id(response, guid)
+        response['resources'].each do |resource|
+          return resource if resource['metadata']['guid'] == guid
+        end
+      end
+
+      def find_by_name(response, name)
+        response['resources'].each do |resource|
+          return resource if resource['entity']['name'] == name
+        end
+        raise(QueryError, "Could not find resource with name \"#{name}\"")
+      end
+    end
+
+    class QueryError < StandardError
     end
   end
 end

data/lib/ibm/ml/local.rb

@@ -12,7 +12,7 @@ module IBM
         @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
 
-      def get_score(deployment_id, hash)
+      def score(deployment_id, hash)
         url = URI("https://#{@host}/v2/scoring/online/#{deployment_id}")
 
         # noinspection RubyStringKeysInHashInspection

data/lib/ibm/ml/version.rb

@@ -1,5 +1,5 @@
 module IBM
   module ML
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.2.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm-ml
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - David Thomason
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler