tangram 0.1.0.pre.alpha.7 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c4cbfd5a24c6561fe11c81ae785d47bc4f4e16a0b11c10f079c63d863c6cb15
-  data.tar.gz: 29d6160096b0ca3d692781d07f4dffb971ab9563c9a6bd1c7911a1676e161806
+  metadata.gz: e622eeb9d9cd659b75acbf6dc167a0685a5111ab35a434c888c497de99faf742
+  data.tar.gz: 91c21be6670a9e3d3072648dba57b570a4cc313958af8a5a16ee7588f461c9b9
 SHA512:
-  metadata.gz: d8e03fe9d77eedf28dc4ab6b6cbf17f6c5274479b1a0324f7071d5e5f608a0fc17bb312b46d995c6873b8b7ef8fac81f8b02490ca06038e936c61a07ac19f38b
-  data.tar.gz: 8c47ffbf42a08c613e3e6bcfdcefc396d5db0d2288a85b52f3bf766f30f9a0bff685d04c282a837b693e2c959e4037713f655a3e07a01e4fe1bc04077ee997df
+  metadata.gz: 5079553215b584e04826f4e522e5b47587711e7493c389f587ec2202acc33a72a9f769d1155e11f746bbb69320a4d2a3bee587701b33877a558ddf467d7d967c
+  data.tar.gz: 0d86be9c1a11e988cbcd6549ae9eb55c0cde9126ab85f1f99f23f796100c158ee32401fe92e0a63b28bacee114cf3a15f2cf0af6b265bf3dbd03717ed44bd86d

data/README.md

@@ -1 +1,52 @@
-# tangram-ruby
+# Tangram + Ruby
+
+- [Watch the Video](https://www.tangramhq.com)
+- [Follow the Getting Started guide](https://www.tangramhq.com/docs/getting-started)
+
+The Tangram Ruby library makes it easy to make predictions with your Tangram machine learning model from Ruby.
+
+## Usage
+
+```
+$ gem install tangram
+```
+
+```ruby
+require 'tangram'
+
+model = Tangram::Model.from_file('./heart-disease.tangram')
+
+input = {
+	age: 63,
+  gender: 'male',
+  # ...
+}
+
+output = model.predict(input)
+
+puts(output)
+```
+
+For more information, follow the [Getting Started guide](https://www.tangramhq.com/docs/getting-started).
+
+## Examples
+
+This repo contains two examples, [examples/predict]([examples/predict]) and [examples/monitor](examples/monitor).
+
+### Predict
+
+This example demonstrates loading a model from a `.tangram` file and making a prediction.
+
+### Monitor
+
+This example demonstrates logging predictions and true values to the Tangram reporting and monitoring app. Before running the example, upload the `heart-disease.tangram` file in [examples/monitor/heart-disease.tangram](examples/monitor/heart-disease.tangram) to either https://app.tangramhq.com or your private instance. Then generate a token by clicking the "Tokens" link on the right side of the top bar.
+
+Then you can run the example:
+
+```
+$ TANGRAM_TOKEN=<YOUR TOKEN HERE> ruby examples/monitor/main.rb
+```
+
+Now if you refresh the production stats or production metrics tabs for the model you uploaded, you should see predictions and true values being reported.
+
+For more information on reporting and monitoring, follow the [Getting Started guide](https://www.tangramhq.com/docs/getting-started).

data/examples/monitor/main.rb

@@ -0,0 +1,52 @@
+require 'tangram'
+
+# Go to https://app.tangramhq.com or your private instance, upload the `heart-disease.tangram` file adjacent to this file, generate a token, and pass it as an environment variable to this script.
+token = ENV['TANGRAM_TOKEN']
+if token.nil?
+	raise 'TANGRAM_TOKEN environment variable not set'
+end
+base_url = ENV['TANGRAM_BASE_URL'] || 'https://app.tangramhq.com'
+
+# Get the path to the `.tangram` file.
+model_path = File.join(File.dirname(__FILE__), 'heart-disease.tangram')
+# Load the model from the file and set the Tangram API token and base url.
+model = Tangram::Model.from_file(model_path, token: token, base_url: base_url)
+
+# Create an example input matching the schema of the CSV file the model was trained on. Here the data is just hard-coded, but in your application you will probably get this from a database or user input.
+input = {
+	age: 63,
+	gender: 'male',
+	chest_pain: 'typical angina',
+	resting_blood_pressure: 145,
+	cholesterol: 233,
+	fasting_blood_sugar_greater_than_120: 'true',
+	resting_ecg_result: 'probable or definite left ventricular hypertrophy',
+	exercise_max_heart_rate: 150,
+	exercise_induced_angina: 'no',
+	exercise_st_depression: 2.3,
+	exercise_st_slope: 'downsloping',
+	fluoroscopy_vessels_colored: 0,
+	thallium_stress_test: 'fixed defect',
+}
+
+# Make the prediction using a custom threshold chosen on the "Tuning" page of the Tangram reporting and monitoring app.
+options = { threshold: 0.25 }
+output = model.predict(input, options: options)
+
+# Make the prediction using a custom threshold chosen on the "Tuning" page of the Tangram reporting and monitoring app.
+puts('Input:', input)
+puts('Output:', output)
+
+# Log the prediction. This will allow us to view production stats in the Tangram reporting and monitoring app.
+model.log_prediction(
+	identifier: 'John Doe',
+	options: options,
+	input: input,
+	output: output,
+)
+
+# Later on, if we get an official diagnosis for the patient, we can log the true value for the prior prediction. Make sure to match the `identifier` from the former prediction.
+model.log_true_value(
+	identifier: 'John Doe',
+	true_value: 'Positive',
+)

data/examples/predict/main.rb

@@ -0,0 +1,30 @@
+require 'tangram'
+
+# Get the path to the .tangram file.
+model_path = File.join(File.dirname(__FILE__), 'heart-disease.tangram')
+# Load the model from the file.
+model = Tangram::Model.from_file(model_path)
+
+# Create an example input matching the schema of the CSV file the model was trained on. Here the data is just hard-coded, but in your application you will probably get this from a database or user input.
+input = {
+	age: 63,
+	gender: 'male',
+	chest_pain: 'typical angina',
+	resting_blood_pressure: 145,
+	cholesterol: 233,
+	fasting_blood_sugar_greater_than_120: 'true',
+	resting_ecg_result: 'probable or definite left ventricular hypertrophy',
+	exercise_max_heart_rate: 150,
+	exercise_induced_angina: 'no',
+	exercise_st_depression: 2.3,
+	exercise_st_slope: 'downsloping',
+	fluoroscopy_vessels_colored: 0,
+	thallium_stress_test: 'fixed defect',
+}
+
+# Make the prediction!
+output = model.predict(input)
+
+# Print out the input and output.
+puts('Input:', input)
+puts('Output:', output)

data/lib/tangram/libtangram.rb

@@ -5,13 +5,13 @@ module LibTangram
   cpu = RbConfig::CONFIG['host_cpu']
   os = RbConfig::CONFIG['host_os']
   if cpu == 'x86_64' and os =~ /linux/
-    library_name = 'libtangram-0.1.0-alpha.4-linux-x86_64.so'
+    library_name = 'libtangram-0.1.0-linux-x86_64.so'
   elsif cpu == 'x86_64' and os =~ /darwin/
-    library_name = 'libtangram-0.1.0-alpha.4-macos-x86_64.dylib'
+    library_name = 'libtangram-0.1.0-macos-x86_64.dylib'
   elsif cpu == 'x86_64' and os =~ /mingw/
-    library_name = 'tangram-0.1.0-alpha.4-windows-x86_64.dll'
+    library_name = 'tangram-0.1.0-windows-x86_64.dll'
   else
-    raise 'tangram-ruby does not yet support your combination of operating system and CPU architecture.'
+    raise 'tangram-ruby does not yet support your combination of operating system and CPU architecture. Want support for your platform? Get in touch at help@tangramhq.com.'
   end
   extend FFI::Library
   ffi_lib File.expand_path("#{library_name}", __dir__)

data/lib/tangram/model.rb

@@ -1,18 +1,23 @@
-require 'tangram/libtangram'
 require 'json'
+require 'net/http'
+require 'tangram/libtangram'
 
 module Tangram
   class Model
-    def self.from_file(model_path)
+
+    def self.from_file(model_path, base_url: nil, token: nil)
       model_data = IO.binread(model_path)
-      self.from_data(model_data)
+      self.from_data(model_data, base_url: base_url, token: token)
     end
 
-    def self.from_data(model_data)
-      self.new(model_data)
+    def self.from_data(model_data, base_url: nil, token: nil)
+      self.new(model_data, base_url: base_url, token: token)
     end
 
-    def initialize(model_data)
+    def initialize(model_data, base_url: nil, token: nil)
+      @base_url = base_url.nil? ? 'https://app.tangramhq.com' : base_url
+      @token = token
+      @log_queue = []
       model_ptr = FFI::MemoryPointer.new(:pointer)
       result = LibTangram.tangram_model_load(model_data, model_data.size, model_ptr)
       if result != 0
@@ -21,7 +26,18 @@ module Tangram
       @model = FFI::AutoPointer.new(model_ptr.read_pointer, LibTangram.method(:tangram_model_free))
     end
 
-    def task
+    def id()
+      id_ptr = FFI::MemoryPointer.new(:pointer)
+      result = LibTangram.tangram_model_id(@model, id_ptr)
+      if result != 0
+        raise 'tangram error'
+      end
+      id = id_ptr.read_pointer.read_string.force_encoding('utf-8')
+      LibTangram.tangram_string_free(id_ptr.read_pointer)
+      id
+    end
+
+    def task()
       task_ptr = FFI::MemoryPointer.new(:pointer)
       result = LibTangram.tangram_model_task(@model, task_ptr)
       if result != 0
@@ -32,7 +48,7 @@ module Tangram
       task
     end
 
-    def predict(input, options)
+    def predict(input, options: nil)
       input = JSON.unparse(input)
       unless options.nil?
         options = JSON.unparse(options)
@@ -49,5 +65,73 @@ module Tangram
       LibTangram.tangram_string_free(output_ptr.read_pointer)
       output
     end
+
+    def log_prediction(identifier:, options: nil, input:, output:)
+      self.log_event({
+        type: 'prediction',
+        modelId: self.id,
+        identifier: identifier,
+        options: options,
+        input: input,
+        output: output,
+      })
+    end
+
+    def enqueue_log_prediction(identifier:, options: nil, input:, output:)
+      self.log_queue.push({
+        type: 'prediction',
+        modelId: self.id,
+        identifier: identifier,
+        options: options,
+        input: input,
+        output: output,
+      })
+    end
+
+    def log_true_value(identifier:, true_value:)
+      self.log_event({
+        type: 'true_value',
+        modelId: self.id,
+        identifier: identifier,
+        trueValue: true_value,
+      })
+    end
+
+    def enqueue_log_true_value(identifier:, true_value:)
+      self.log_queue.push({
+        type: 'true_value',
+        modelId: self.id,
+        identifier: identifier,
+        trueValue: true_value,
+      })
+    end
+
+    def flush_log_queue()
+      self.log_events(@log_queue)
+      @log_queue = []
+    end
+
+    def log_event(event)
+      self.log_events([event])
+    end
+
+    def log_events(events)
+      if @token.nil?
+        raise 'Tangram cannot log events without a token. Make sure to pass a token to the model constructor.'
+      end
+      headers = {
+        'Content-Type': 'application/json',
+        'Authorization': 'Bearer ' + @token,
+      }
+      uri = URI(@base_url + '/api/track')
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri, headers)
+      request.body = events.to_json
+      response = http.request(request)
+      unless response.kind_of? Net::HTTPSuccess
+        raise response
+      end
+    end
+
   end
 end

data/tangram.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification.new do |s|
 	s.name        = "tangram"
-	s.version     = "0.1.0-alpha.7"
-	s.date        = "2019-11-22"
+	s.version     = "0.1.1"
 	s.summary     = "Tangram for Ruby"
 	s.description = "Make predictions with a Tangram model from your Ruby app. Learn more at https://www.tangramhq.com/."
 	s.authors     = ["Tangram"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tangram
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.7
+  version: 0.1.1
 platform: ruby
 authors:
 - Tangram
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -32,13 +32,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- examples/heart-disease/main.rb
+- examples/monitor/heart-disease.tangram
+- examples/monitor/main.rb
+- examples/predict/heart-disease.tangram
+- examples/predict/main.rb
 - lib/tangram.rb
-- lib/tangram/libtangram-0.1.0-alpha.4-linux-x86_64.so
-- lib/tangram/libtangram-0.1.0-alpha.4-macos-x86_64.dylib
+- lib/tangram/libtangram-0.1.0-linux-x86_64.so
+- lib/tangram/libtangram-0.1.0-macos-x86_64.dylib
 - lib/tangram/libtangram.rb
 - lib/tangram/model.rb
-- lib/tangram/tangram-0.1.0-alpha.4-windows-x86_64.dll
+- lib/tangram/tangram-0.1.0-windows-x86_64.dll
 - scripts/build
 - tangram.gemspec
 homepage: http://rubygems.org/gems/tangram
@@ -56,9 +59,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.6
 signing_key: 

data/examples/heart-disease/main.rb

@@ -1,25 +0,0 @@
-require 'tangram'
-
-model = Tangram::Model.from_file('./heart-disease.tangram')
-
-puts model.task
-
-input = {
-	age: 63,
-	gender: 'male',
-	chest_pain: 'typical angina',
-	resting_blood_pressure: 145,
-	cholesterol: 233,
-	fasting_blood_sugar_greater_than_120: 'true',
-	resting_ecg_result: 'probable or definite left ventricular hypertrophy',
-	exercise_max_heart_rate: 150,
-	exercise_induced_angina: 'no',
-	exercise_st_depression: 2.3,
-	exercise_st_slope: 'downsloping',
-	fluoroscopy_vessels_colored: 0,
-	thallium_stress_test: 'fixed defect',
-}
-
-output = model.predict(input)
-
-puts('Prediction:', output['className'])