ibm-ml 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 001b892689cf34e34855ffbfdf4da69806407c1b
-  data.tar.gz: 2baafcd50a260b6b33422df2d3546cb32d450dd1
+  metadata.gz: 8043c7c62f75f733b6e6b714c9dd3cd9a231c418
+  data.tar.gz: 2e9cc28ef1ac51cb993785890ae4ebbf95e7e3c7
 SHA512:
-  metadata.gz: 3d153e7975a5675844a4f8955d41086dcf316d2a11c31cea37e15d862369dd78202de4ebf877157b861c450a71443abfa3128cfd973296c8cdbe8e0adbcfc915
-  data.tar.gz: c7a670045edb3cbe77725ba93907712edcfd581a9446b778b1fde1186241115abcf8da5727b19db8be71dc517a982151c04ed5d67e821cc23c5b05ad79155045
+  metadata.gz: 42bfc1730006f18327265ec024d5427edc895938d90a07c73c1c33353ea07fb2d88b31a937959df2b1bf1672c0f8bda867cb08b400f9317321a75cc423fdfa76
+  data.tar.gz: e13d5dfd1365ecae5acffdd8e2223abb07e876c7412206ffe8a63cab713d96bf5d93db0a72a0ffb84dd8d945111aa8ddc62c612150d6adcb1c60ee31581d293e

data/.travis.yml

@@ -1,8 +1,14 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.14.3
+- 2.4.0
+- 2.0.0
+cache: bundler
 script:
 - bundle exec rake
-- bundle exec rubocop
+- bundle exec rubocop
+deploy:
+  provider: rubygems
+  gem: ibm-ml
+  api_key:
+    secure: KrW9QsWC2deO9ubwZxQSRcbL8Azj4xkE0KpY30B564/o3qJOFZN98cevVJ7EujyxA+HVXWsdvEsr+PHk17fCSbSlbnmcRS0C7BSy7RCNWgHhDd2hiUG32QXszpr5ZFvXkzlZ9N5gNRzlIpOVckQS2swYCt20GNTn6XQ69a9j7wMER68bDT4gWCkq+xssioS5PaE1hFqOvPDXRltigIz3cZz8+8UDnPzprTyyJ235KNktEFs4OUWGrDwfbgoJs3K744+PvYyTxw+xenlZ6huZqEYmYAws/okIPKenQ/qiTBOx4RRRkVOXWzZ4kUexJiAdIoxKunZ1bPjTtip3AKa1nu3FdgJqq3DZxxX5wftKyeeZYyOoZs+e24Vi79JGXSRcHpMDi578nd5Fqu1UU6weTjS11DHhxX2rPNYRBcvCwXxKCnrw3IY8bzhQ2cF3K1PTV6g6RCXqEY/IKqex6RUw+dcPxqFNaH5VIgyDxs3TUUkEUmsGfHZmyz1MXNjnrLJRQki+H25LpHhOP/lcwJZuLjwNca5uBp01M0R89gsumLVvI5fxpteWjFMUTMZ397sC6Ve0/PmggYxuwLre1nT1N8MMVX79oHXwxeOHltw9lcR4wOc7oIPX8BzgtLvnCvsha9AHXP8F0n0u2F8UrJr25sBQ0CXLpTeTG+zG2t63L5s=

data/README.md

@@ -1,4 +1,6 @@
 # IBM::ML
+[![Gem Version](https://badge.fury.io/rb/ibm-ml.svg)](https://badge.fury.io/rb/ibm-ml)
+[![Build Status](https://travis-ci.org/IBM-ATAT/ibm-ml-ruby.svg?branch=master)](https://travis-ci.org/IBM-ATAT/ibm-ml-ruby)
 
 A Ruby gem to invoke the IBM Machine Learning service REST API.
 
@@ -8,6 +10,14 @@ Currently supports:
 
 ## Installation
 
+#### With Gem
+After [installing Ruby](https://www.ruby-lang.org/en/documentation/installation/) >= 2.0:
+
+```bash
+$ gem install ibm-ml
+```
+
+#### With Bundler
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -16,28 +26,54 @@ gem 'ibm-ml'
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ibm-ml
+```bash
+$ bundle install
+```
 
 ## Usage
 
+#### Setup
+```ruby
+require 'ibm/ml'
+require 'pp'
+
+# example input record to score 
+record = {
+  GENDER:        'M',
+  AGEGROUP:      '45-54',
+  EDUCATION:     'Doctorate',
+  PROFESSION:    'Executive',
+  INCOME:        200000,
+  SWITCHER:      0,
+  LASTPURCHASE:  3,
+  ANNUAL_SPEND:  1200
+}
+```
+
 #### Cloud
 ```ruby
-service = IBM::ML::Cloud.new('<ML_SERVICE_USERNAME>', '<ML_SERVICE_PASSWORD>')
-p service.fetch_token
-p service.published_models
-p service.deployments
-p service.get_score('<model_guid>', '<deployment_guid>', ['record', 'input', 'values'])
+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)
 ```
 
 #### Local
 ```ruby
-service = IBM::ML::Local.new('<DSX_LOCAL_HOST>', '<DSX_LOCAL_USERNAME>', '<DSX_LOCAL_PASSWORD>')
-p service.fetch_token
-p service.get_score('<deployment_guid>', ['record', 'input', 'values'])
+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)
 ```
 
 ## Development

data/ibm-ml.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

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  = { 'authorization' => "Bearer #{fetch_token}" }
       request = Net::HTTP::Get.new url, header
 
       response = @http.request(request)

data/lib/ibm/ml/cloud.rb

@@ -35,7 +35,7 @@ module IBM
         request      = Net::HTTP::Post.new(url, header)
         request.body = {
           fields: model_fields.map { |field| field['name'] },
-          values: [record]
+          values: [record.values]
         }.to_json
 
         response = @http.request(request)

data/lib/ibm/ml/local.rb

@@ -29,7 +29,7 @@ module IBM
         begin
           body = JSON.parse(response.read_body)
           body.key?('records') ? body : raise(ScoringError, response.read_body)
-        rescue JSON::ParserError => e
+        rescue JSON::ParserError
           raise(ScoringError, response.read_body)
         end
       end

data/lib/ibm/ml/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm-ml
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - David Thomason
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Client library for calling IBM Machine Learning API