tangram 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab4f830a6691879402e6bc63d0433c864fb02f0852c818b881857ebc2e0fb25
-  data.tar.gz: 0f7664501b24b5d87d55b593e57c90c8c59a3238cb59323152a4e6a1525be1b0
+  metadata.gz: 67aee1607ea98442ef594465a0b462997fa5d64eb9aa121a534776ad1ed81af9
+  data.tar.gz: 05e82018a2dc79b99411389b5b61c00cc570995b8852c463138b3242a4adf747
 SHA512:
-  metadata.gz: fd6b1409b94794dbc7c62d03650ac99fc4537f11f0a1b0422e9b1d6d6472e707ee0c9185f86e6e8ad058505d2efe3df46d8f0e7292afdd023949cab8a500adb7
-  data.tar.gz: f0c87e1c2e13f05b2bbdeeb909a8ee0e04b679036b11763da9eec6a40af981316d476500c684ccfa0d20caa974904a827c094a0050786577ca6be86abced8b0a
+  metadata.gz: 46d36873b116a8c4d5b39165f6eae6090f30d50fe617c39e69ee6eb469585e66169b1723218562c125a4b390f9f0434fb580b5e051996d0ebb2e770419794556
+  data.tar.gz: 2686d35491d8dafb53eded4107e512c62bbb44681567ae8aaa8bea0d22b964ff3efc5926207459084eb5d2d150d7fc0ee6d24a80533894e1014322c16da4b323

data/Gemfile.lock

@@ -12,4 +12,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -3,7 +3,7 @@
 - [Watch the Video](https://www.tangram.xyz)
 - [Read the Docs](https://www.tangram.xyz/docs)
 
-The Tangram Ruby gem makes it easy to make predictions with your Tangram machine learning model from Ruby.
+The Tangram Ruby library makes it easy to make predictions with your Tangram machine learning model from Ruby.
 
 ## Usage
 
@@ -29,32 +29,8 @@ For more information, [read the docs](https://www.tangram.xyz/docs).
 
 ## Platform Support
 
-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).
+Tangram for Ruby is currently supported on Linux, macOS, and Windows with ARM64 and 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
 
-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.
-
-To run the example:
-
-```
-$ ruby examples/basic.rb
-```
-
-### Advanced
-
-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.
-
-To run the example:
-
-```
-$ 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.
-
-For more information, [read the docs](https://www.tangram.xyz/docs).
+The source for this package contains a number of examples in the `examples` directory. Each example has a `README.md` explaining how to run it.

data/docs/Tangram.html

@@ -101,7 +101,7 @@
     
   
     
-      <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>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Tangram/BagOfWordsCosineSimilarityFeatureContribution.html" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution (class)">BagOfWordsCosineSimilarityFeatureContribution</a></span>, <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>
@@ -117,9 +117,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 12 10:45:10 2021 by
+  Generated on Thu Jul  1 17:11:32 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.6.7).
+  0.9.26 (ruby-2.7.3).
 </div>
 
     </div>

data/docs/Tangram/BagOfWordsCosineSimilarityFeatureContribution.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::BagOfWordsCosineSimilarityFeatureContribution
+  
+    &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::BagOfWordsCosineSimilarityFeatureContribution";
+  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">BagOfWordsCosineSimilarityFeatureContribution</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::BagOfWordsCosineSimilarityFeatureContribution
+  
+  
+  
+</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::BagOfWordsCosineSimilarityFeatureContribution</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 cosine similarity 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_a-instance_method" title="#column_name_a (instance method)">#<strong>column_name_a</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 a for the feature group.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#column_name_b-instance_method" title="#column_name_b (instance method)">#<strong>column_name_b</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 b 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>
+
+    
+  </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_a:, column_name_b:, feature_contribution_value:, feature_value:)  &#x21d2; BagOfWordsCosineSimilarityFeatureContribution </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>A new instance of BagOfWordsCosineSimilarityFeatureContribution.</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_a:, column_name_b:, feature_contribution_value:, feature_value:)  &#x21d2; <tt><span class='object_link'><a href="" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution (class)">BagOfWordsCosineSimilarityFeatureContribution</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a new instance of BagOfWordsCosineSimilarityFeatureContribution.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+200
+201
+202
+203
+204
+205</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 200</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>column_name_a:</span><span class='comma'>,</span> <span class='label'>column_name_b:</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_a</span> <span class='op'>=</span> <span class='id identifier rubyid_column_name_a'>column_name_a</span>
+  <span class='ivar'>@column_name_b</span> <span class='op'>=</span> <span class='id identifier rubyid_column_name_b'>column_name_b</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_a-instance_method">
+  
+    #<strong>column_name_a</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 a for the feature group.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+193
+194
+195</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 193</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_column_name_a'>column_name_a</span>
+  <span class='ivar'>@column_name_a</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="column_name_b-instance_method">
+  
+    #<strong>column_name_b</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 b for the feature group.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+195
+196
+197</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 195</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_column_name_b'>column_name_b</span>
+  <span class='ivar'>@column_name_b</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">
+
+
+199
+200
+201</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 199</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">
+
+
+197
+198
+199</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 197</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>
+    
+  </div>
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Jul  1 17:11:32 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-2.7.3).
+</div>
+
+    </div>
+  </body>
+</html>