tangram 0.1.3 → 0.3.0

data/scripts/build

@@ -1,5 +1,3 @@
-#!/usr/bin/env sh
-set -e
-
 gem build tangram.gemspec
-gem install *.gem
+mkdir -p dist
+mv *.gem dist

data/scripts/dev

@@ -0,0 +1,4 @@
+cargo build -p libtangram
+install -D ../../target/debug/libtangram.so lib/tangram/libtangram/x86_64-unknown-linux-gnu/libtangram.so
+scripts/build
+gem install dist/*

data/scripts/docs

@@ -0,0 +1 @@
+yard -m markdown -o docs

data/scripts/release

@@ -0,0 +1 @@
+gem publish dist/*

data/tangram.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
-	s.name        = "tangram"
-	s.version     = "0.1.3"
-	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"]
-	s.email       = "help@tangramhq.com"
-	s.files       = Dir['**/**'].grep_v(/.gem$/)
-	s.homepage    = "http://rubygems.org/gems/tangram"
-	s.license     = "MIT"
-	s.add_dependency 'ffi', '~> 1'
+  s.name = "tangram"
+  s.version = "0.3.0"
+  s.summary = "Tangram for Ruby"
+  s.description = "Make predictions with a Tangram model from your Ruby app. Learn more at https://www.tangram.xyz/."
+  s.authors = ["Tangram"]
+  s.email = "help@tangram.xyz"
+  s.files = Dir["**/**"].grep_v(/.gem$/)
+  s.homepage = "http://rubygems.org/gems/tangram"
+  s.license = "MIT"
+  s.add_dependency "ffi", "~> 1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tangram
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Tangram
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -25,31 +25,66 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 description: Make predictions with a Tangram model from your Ruby app. Learn more
-  at https://www.tangramhq.com/.
-email: help@tangramhq.com
+  at https://www.tangram.xyz/.
+email: help@tangram.xyz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- examples/monitor/heart-disease.tangram
-- examples/monitor/main.rb
-- examples/predict/heart-disease.tangram
-- examples/predict/main.rb
+- docs/Tangram.html
+- docs/Tangram/BagOfWordsFeatureContribution.html
+- docs/Tangram/Bigram.html
+- docs/Tangram/BinaryClassificationPredictOutput.html
+- docs/Tangram/FeatureContributions.html
+- docs/Tangram/IdentityFeatureContribution.html
+- docs/Tangram/LibTangram.html
+- docs/Tangram/LibTangram/TangramStringView.html
+- docs/Tangram/LoadModelOptions.html
+- docs/Tangram/Model.html
+- docs/Tangram/MulticlassClassificationPredictOutput.html
+- docs/Tangram/NormalizedFeatureContribution.html
+- docs/Tangram/OneHotEncodedFeatureContribution.html
+- docs/Tangram/PredictOptions.html
+- docs/Tangram/RegressionPredictOutput.html
+- docs/Tangram/Unigram.html
+- docs/Tangram/WordEmbeddingFeatureContribution.html
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
+- examples/advanced.rb
+- examples/basic.rb
+- examples/heart_disease.tangram
 - lib/tangram.rb
-- lib/tangram/libtangram-0.1.3-linux-x86_64.so
-- lib/tangram/libtangram-0.1.3-macos-x86_64.dylib
-- lib/tangram/libtangram.rb
-- lib/tangram/model.rb
-- lib/tangram/tangram-0.1.3-windows-x86_64.dll
+- lib/tangram/libtangram/aarch64-apple-darwin/libtangram.dylib
+- lib/tangram/libtangram/x86_64-apple-darwin/libtangram.dylib
+- lib/tangram/libtangram/x86_64-pc-windows-msvc/tangram.dll
+- lib/tangram/libtangram/x86_64-unknown-linux-gnu/libtangram.so
+- lib/tangram/libtangram/x86_64-unknown-linux-musl/libtangram.so
+- lib/tangram/tangram.rb
 - scripts/build
+- scripts/dev
+- scripts/docs
+- scripts/fmt
+- scripts/release
 - tangram.gemspec
 homepage: http://rubygems.org/gems/tangram
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Tangram for Ruby
 test_files: []

data/examples/monitor/main.rb

@@ -1,52 +0,0 @@
-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

@@ -1,30 +0,0 @@
-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

@@ -1,24 +0,0 @@
-require 'ffi'
-require 'rbconfig'
-
-module LibTangram
-  cpu = RbConfig::CONFIG['host_cpu']
-  os = RbConfig::CONFIG['host_os']
-  if cpu == 'x86_64' and os =~ /linux/
-    library_name = 'libtangram-0.1.3-linux-x86_64.so'
-  elsif cpu == 'x86_64' and os =~ /darwin/
-    library_name = 'libtangram-0.1.3-macos-x86_64.dylib'
-  elsif cpu == 'x86_64' and os =~ /mingw/
-    library_name = 'tangram-0.1.3-windows-x86_64.dll'
-  else
-    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__)
-  attach_function :tangram_model_load, [:pointer, :uint, :pointer], :int
-  attach_function :tangram_model_id, [:pointer, :pointer], :int
-  attach_function :tangram_model_task, [:pointer, :pointer], :int
-  attach_function :tangram_model_predict, [:pointer, :pointer, :pointer, :pointer], :int
-  attach_function :tangram_string_free, [:pointer], :int
-  attach_function :tangram_model_free, [:pointer], :int
-end

data/lib/tangram/model.rb

@@ -1,133 +0,0 @@
-require 'json'
-require 'net/http'
-require 'tangram/libtangram'
-
-module Tangram
-  class Model
-
-    def self.from_file(model_path, base_url: nil, token: nil)
-      model_data = IO.binread(model_path)
-      self.from_data(model_data, base_url: base_url, token: token)
-    end
-
-    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, 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
-        raise 'tangram error'
-      end
-      @model = FFI::AutoPointer.new(model_ptr.read_pointer, LibTangram.method(:tangram_model_free))
-    end
-
-    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
-        raise 'tangram error'
-      end
-      task = task_ptr.read_pointer.read_string.force_encoding('utf-8')
-      LibTangram.tangram_string_free(task_ptr.read_pointer)
-      task
-    end
-
-    def predict(input, options: nil)
-      input = JSON.unparse(input)
-      unless options.nil?
-        options = JSON.unparse(options)
-      else
-        options = nil
-      end
-      output_ptr = FFI::MemoryPointer.new(:pointer)
-      result = LibTangram.tangram_model_predict(@model, input, options, output_ptr)
-      if result != 0
-        raise 'tangram error'
-      end
-      output = output_ptr.read_pointer.read_string.force_encoding('utf-8')
-      output = JSON.parse(output)
-      LibTangram.tangram_string_free(output_ptr.read_pointer)
-      output
-    end
-
-    def log_prediction(identifier:, options: nil, input:, output:)
-      self.log_event(self.prediction_event(identifier, options, input, output))
-    end
-
-    def enqueue_log_prediction(identifier:, options: nil, input:, output:)
-      self.log_queue.push(self.prediction_event(identifier, options, input, output))
-    end
-
-    def log_true_value(identifier:, true_value:)
-      self.log_event(self.true_value_event(identifier, true_value))
-    end
-
-    def enqueue_log_true_value(identifier:, true_value:)
-      self.log_queue.push(self.true_value_event(identifier, 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
-
-    def prediction_event(identifier:, options: nil, input:, output:)
-      return {
-        type: 'prediction',
-        modelId: self.id,
-        identifier: identifier,
-        options: options,
-        input: input,
-        output: output,
-      }
-    end
-
-    def true_value_event(identifier:, true_value:)
-      return {
-        type: 'true_value',
-        modelId: self.id,
-        identifier: identifier,
-        trueValue: true_value,
-      }
-    end
-
-  end
-end