tangram 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cbbca9539d05f134e2e7ba0398b50c3610b567d5db99b39001b038c06035101
-  data.tar.gz: 5b85cfc70d5a9ee0d3b209b951a5aa63af344f447020bfc9b970358c365e2885
+  metadata.gz: 6e9ad90eec0aa379aa164d2e6afad538d26c7ad8dbfb1f83edac6fa98ffb7ef3
+  data.tar.gz: 820062630f2882b1f399348073bcacc536ce4be3e691fb70a4d4ee0aa86b15f3
 SHA512:
-  metadata.gz: 633884f7217d78f2ca19d6f1a29889c6e95e610a3ed93db2cf4210239590fb19f9df2d4d46feb7f5fe4b2366ef62f6ed012cc06130653e4003f4e5440548a1e4
-  data.tar.gz: ee6a7a299e53433e4feccf03d4710a69dce5fab905aabf65c79c36eec6c0e04aef3e9079be33a73c945d8addae8263378cbcef8c4360921b39b0fc9d69a3c1ca
+  metadata.gz: 7a1ed9abef3cba7e3546763e4d7f0927617af3a361901cbc9cb7a9b080872c1b449c779fe80bef520b20ef973721cbf6bcbf0e4b5eef839ad19649f45cc3d6c5
+  data.tar.gz: fe6666f9ff59015f47f5515afbfd30eabb794dba362d2b6cef56ac259840e542b34ecafe8711150ccdec5961c60b97c8fb39542ec4249c2f8807e99893b90391

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Tangram Inc
+Copyright (c) 2020 Tangram, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,9 +1,9 @@
-# Tangram + Ruby
+# Tangram for Ruby
 
-- [Watch the Video](https://www.tangramhq.com)
-- [Read the Docs](https://www.tangramhq.com/docs)
+- [Watch the Video](https://www.tangram.xyz)
+- [Read the Docs](https://www.tangram.xyz/docs)
 
-The Tangram Ruby library makes it easy to make predictions with your Tangram machine learning model from Ruby.
+The Tangram Ruby gem makes it easy to make predictions with your Tangram machine learning model from Ruby.
 
 ## Usage
 
@@ -14,43 +14,47 @@ $ gem install tangram
 ```ruby
 require 'tangram'
 
-model = Tangram::Model.from_file('./heart-disease.tangram')
+model = Tangram::Model.from_file('./heart_disease.tangram')
 
 input = {
-	age: 63,
+  age: 63,
   gender: 'male',
   # ...
 }
 
 output = model.predict(input)
-
-puts(output)
 ```
 
-For more information, [read the docs](https://www.tangramhq.com/docs).
+For more information, [read the docs](https://www.tangram.xyz/docs).
 
 ## Platform Support
 
-`tangram-ruby` is currently supported for Linux, macOS, and Windows on x64-64/amd64/x64 CPUs. Are you interested in another platform? Get in touch via email at help@tangramhq.com or with the chat bubble on our website at https://www.tangramhq.com.
+Tangram for Ruby is currently supported on Linux, macOS, and Windows with AMD64 CPUs. Are you interested in another platform? [Open an issue](https://github.com/tangramxyz/tangram/issues/new) or send us an email at [help@tangram.xyz](mailto:help@tangram.xyz).
 
 ## Examples
 
-This repo contains two examples, [examples/predict]([examples/predict]) and [examples/monitor](examples/monitor).
+The source for this gem contains two examples, `examples/predict` and `examples/monitor`.
+
+### Basic
+
+The basic example demonstrates loading a model from a `.tangram` file and making a prediction.
 
-### Predict
+To run the example:
 
-This example demonstrates loading a model from a `.tangram` file and making a prediction.
+```
+$ ruby examples/basic.rb
+```
 
-### Monitor
+### Advanced
 
-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.
+The advanced example demonstrates logging predictions and true values to the Tangram app. Before running the example, run `tangram app` to start the app running locally, open `http://localhost:8080` in your browser, and upload the file `examples/heart_disease.tangram` to it.
 
-Then you can run the example:
+To run the example:
 
 ```
-$ TANGRAM_TOKEN=<YOUR TOKEN HERE> ruby examples/monitor/main.rb
+$ TANGRAM_URL=http://localhost:8080 ruby examples/advanced.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.
+Now if you refresh the production stats or production metrics tabs for the model you uploaded, you should see predictions and true values.
 
-For more information on reporting and monitoring, [read the docs](https://www.tangramhq.com/docs).
+For more information, [read the docs](https://www.tangram.xyz/docs).

data/docs/Tangram.html

@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Tangram
+  
+    &mdash; Documentation by YARD 0.9.26
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "Tangram";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (T)</a> &raquo;
+    
+    
+    <span class="title">Tangram</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: Tangram
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/tangram/tangram.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This is the main module in the <code>tangram</code> gem.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Tangram/LibTangram.html" title="Tangram::LibTangram (module)">LibTangram</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Tangram/BagOfWordsFeatureContribution.html" title="Tangram::BagOfWordsFeatureContribution (class)">BagOfWordsFeatureContribution</a></span>, <span class='object_link'><a href="Tangram/Bigram.html" title="Tangram::Bigram (class)">Bigram</a></span>, <span class='object_link'><a href="Tangram/BinaryClassificationPredictOutput.html" title="Tangram::BinaryClassificationPredictOutput (class)">BinaryClassificationPredictOutput</a></span>, <span class='object_link'><a href="Tangram/FeatureContributions.html" title="Tangram::FeatureContributions (class)">FeatureContributions</a></span>, <span class='object_link'><a href="Tangram/IdentityFeatureContribution.html" title="Tangram::IdentityFeatureContribution (class)">IdentityFeatureContribution</a></span>, <span class='object_link'><a href="Tangram/LoadModelOptions.html" title="Tangram::LoadModelOptions (class)">LoadModelOptions</a></span>, <span class='object_link'><a href="Tangram/Model.html" title="Tangram::Model (class)">Model</a></span>, <span class='object_link'><a href="Tangram/MulticlassClassificationPredictOutput.html" title="Tangram::MulticlassClassificationPredictOutput (class)">MulticlassClassificationPredictOutput</a></span>, <span class='object_link'><a href="Tangram/NormalizedFeatureContribution.html" title="Tangram::NormalizedFeatureContribution (class)">NormalizedFeatureContribution</a></span>, <span class='object_link'><a href="Tangram/OneHotEncodedFeatureContribution.html" title="Tangram::OneHotEncodedFeatureContribution (class)">OneHotEncodedFeatureContribution</a></span>, <span class='object_link'><a href="Tangram/PredictOptions.html" title="Tangram::PredictOptions (class)">PredictOptions</a></span>, <span class='object_link'><a href="Tangram/RegressionPredictOutput.html" title="Tangram::RegressionPredictOutput (class)">RegressionPredictOutput</a></span>, <span class='object_link'><a href="Tangram/Unigram.html" title="Tangram::Unigram (class)">Unigram</a></span>, <span class='object_link'><a href="Tangram/WordEmbeddingFeatureContribution.html" title="Tangram::WordEmbeddingFeatureContribution (class)">WordEmbeddingFeatureContribution</a></span>
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Fri Apr 23 15:50:02 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-3.0.1).
+</div>
+
+    </div>
+  </body>
+</html>

data/docs/Tangram/BagOfWordsFeatureContribution.html

@@ -0,0 +1,507 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Tangram::BagOfWordsFeatureContribution
+  
+    &mdash; Documentation by YARD 0.9.26
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "Tangram::BagOfWordsFeatureContribution";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (B)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Tangram.html" title="Tangram (module)">Tangram</a></span></span>
+     &raquo; 
+    <span class="title">BagOfWordsFeatureContribution</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Class: Tangram::BagOfWordsFeatureContribution
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Tangram::BagOfWordsFeatureContribution</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/tangram/tangram.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This describes the contribution of a feature from a bag of words feature group.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#column_name-instance_method" title="#column_name (instance method)">#<strong>column_name</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>This is the name of the source column for the feature group.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#feature_contribution_value-instance_method" title="#feature_contribution_value (instance method)">#<strong>feature_contribution_value</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>This is the amount that the feature contributed to the output.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#feature_value-instance_method" title="#feature_value (instance method)">#<strong>feature_value</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>This is the value of the feature.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ngram-instance_method" title="#ngram (instance method)">#<strong>ngram</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>This is the ngram for the feature.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(column_name:, ngram:, feature_contribution_value:, feature_value:)  &#x21d2; BagOfWordsFeatureContribution </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>A new instance of BagOfWordsFeatureContribution.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>(column_name:, ngram:, feature_contribution_value:, feature_value:)  &#x21d2; <tt><span class='object_link'><a href="" title="Tangram::BagOfWordsFeatureContribution (class)">BagOfWordsFeatureContribution</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a new instance of BagOfWordsFeatureContribution.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+161
+162
+163
+164
+165
+166</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 161</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>column_name:</span><span class='comma'>,</span> <span class='label'>ngram:</span><span class='comma'>,</span> <span class='label'>feature_contribution_value:</span><span class='comma'>,</span> <span class='label'>feature_value:</span><span class='rparen'>)</span>
+  <span class='ivar'>@column_name</span> <span class='op'>=</span> <span class='id identifier rubyid_column_name'>column_name</span>
+  <span class='ivar'>@ngram</span> <span class='op'>=</span> <span class='id identifier rubyid_ngram'>ngram</span>
+  <span class='ivar'>@feature_contribution_value</span> <span class='op'>=</span> <span class='id identifier rubyid_feature_contribution_value'>feature_contribution_value</span>
+  <span class='ivar'>@feature_value</span> <span class='op'>=</span> <span class='id identifier rubyid_feature_value'>feature_value</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="column_name-instance_method">
+  
+    #<strong>column_name</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This is the name of the source column for the feature group.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+154
+155
+156</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 154</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_column_name'>column_name</span>
+  <span class='ivar'>@column_name</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="feature_contribution_value-instance_method">
+  
+    #<strong>feature_contribution_value</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This is the amount that the feature contributed to the output.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+160
+161
+162</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 160</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_feature_contribution_value'>feature_contribution_value</span>
+  <span class='ivar'>@feature_contribution_value</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="feature_value-instance_method">
+  
+    #<strong>feature_value</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This is the value of the feature.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+158
+159
+160</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 158</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_feature_value'>feature_value</span>
+  <span class='ivar'>@feature_value</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="ngram-instance_method">
+  
+    #<strong>ngram</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This is the ngram for the feature.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+156
+157
+158</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 156</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_ngram'>ngram</span>
+  <span class='ivar'>@ngram</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+</div>
+
+      <div id="footer">
+  Generated on Fri Apr 23 15:50:02 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-3.0.1).
+</div>
+
+    </div>
+  </body>
+</html>