tangram 0.4.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +3 -27
  4. data/docs/Tangram.html +3 -3
  5. data/docs/Tangram/BagOfWordsCosineSimilarityFeatureContribution.html +507 -0
  6. data/docs/Tangram/BagOfWordsFeatureContribution.html +2 -2
  7. data/docs/Tangram/Bigram.html +2 -2
  8. data/docs/Tangram/BinaryClassificationPredictOutput.html +2 -2
  9. data/docs/Tangram/FeatureContributions.html +2 -2
  10. data/docs/Tangram/IdentityFeatureContribution.html +2 -2
  11. data/docs/Tangram/LibTangram.html +3 -2
  12. data/docs/Tangram/LibTangram/TangramStringView.html +6 -6
  13. data/docs/Tangram/LoadModelOptions.html +2 -2
  14. data/docs/Tangram/Model.html +92 -92
  15. data/docs/Tangram/MulticlassClassificationPredictOutput.html +2 -2
  16. data/docs/Tangram/NormalizedFeatureContribution.html +2 -2
  17. data/docs/Tangram/OneHotEncodedFeatureContribution.html +2 -2
  18. data/docs/Tangram/PredictOptions.html +2 -2
  19. data/docs/Tangram/RegressionPredictOutput.html +2 -2
  20. data/docs/Tangram/Unigram.html +2 -2
  21. data/docs/Tangram/WordEmbeddingFeatureContribution.html +20 -20
  22. data/docs/_index.html +9 -2
  23. data/docs/class_list.html +1 -1
  24. data/docs/file.README.html +5 -27
  25. data/docs/index.html +5 -27
  26. data/docs/method_list.html +69 -29
  27. data/docs/top-level-namespace.html +2 -2
  28. data/examples/advanced/Gemfile +2 -0
  29. data/examples/advanced/Gemfile.lock +15 -0
  30. data/examples/advanced/README.md +14 -0
  31. data/examples/{heart_disease.tangram → advanced/heart_disease.tangram} +0 -0
  32. data/examples/{advanced.rb → advanced/main.rb} +0 -0
  33. data/examples/basic/Gemfile +2 -0
  34. data/examples/basic/Gemfile.lock +15 -0
  35. data/examples/basic/README.md +10 -0
  36. data/examples/basic/heart_disease.tangram +0 -0
  37. data/examples/{basic.rb → basic/main.rb} +0 -0
  38. data/lib/tangram/libtangram/aarch64-apple-darwin/libtangram.dylib +0 -0
  39. data/lib/tangram/libtangram/aarch64-unknown-linux-gnu/libtangram.so +0 -0
  40. data/lib/tangram/libtangram/aarch64-unknown-linux-musl/libtangram.so +0 -0
  41. data/lib/tangram/libtangram/x86_64-apple-darwin/libtangram.dylib +0 -0
  42. data/lib/tangram/libtangram/x86_64-pc-windows-msvc/tangram.dll +0 -0
  43. data/lib/tangram/libtangram/x86_64-unknown-linux-gnu/libtangram.so +0 -0
  44. data/lib/tangram/libtangram/x86_64-unknown-linux-musl/libtangram.so +0 -0
  45. data/tangram.gemspec +1 -1
  46. metadata +12 -4
@@ -411,9 +411,9 @@
411
411
  </div>
412
412
 
413
413
  <div id="footer">
414
- Generated on Wed May 12 10:45:10 2021 by
414
+ Generated on Thu Jul 1 17:11:32 2021 by
415
415
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
416
- 0.9.26 (ruby-2.6.7).
416
+ 0.9.26 (ruby-2.7.3).
417
417
  </div>
418
418
 
419
419
  </div>
@@ -281,9 +281,9 @@
281
281
  </div>
282
282
 
283
283
  <div id="footer">
284
- Generated on Wed May 12 10:45:10 2021 by
284
+ Generated on Thu Jul 1 17:11:32 2021 by
285
285
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
286
- 0.9.26 (ruby-2.6.7).
286
+ 0.9.26 (ruby-2.7.3).
287
287
  </div>
288
288
 
289
289
  </div>
@@ -269,14 +269,14 @@
269
269
  <pre class="lines">
270
270
 
271
271
 
272
- 198
273
- 199
274
- 200
275
- 201
276
- 202</pre>
272
+ 216
273
+ 217
274
+ 218
275
+ 219
276
+ 220</pre>
277
277
  </td>
278
278
  <td>
279
- <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 198</span>
279
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 216</span>
280
280
 
281
281
  <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'>value_index:</span><span class='comma'>,</span> <span class='label'>feature_contribution_value:</span><span class='rparen'>)</span>
282
282
  <span class='ivar'>@column_name</span> <span class='op'>=</span> <span class='id identifier rubyid_column_name'>column_name</span>
@@ -320,12 +320,12 @@
320
320
  <pre class="lines">
321
321
 
322
322
 
323
- 193
324
- 194
325
- 195</pre>
323
+ 211
324
+ 212
325
+ 213</pre>
326
326
  </td>
327
327
  <td>
328
- <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 193</span>
328
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 211</span>
329
329
 
330
330
  <span class='kw'>def</span> <span class='id identifier rubyid_column_name'>column_name</span>
331
331
  <span class='ivar'>@column_name</span>
@@ -362,12 +362,12 @@
362
362
  <pre class="lines">
363
363
 
364
364
 
365
- 197
366
- 198
367
- 199</pre>
365
+ 215
366
+ 216
367
+ 217</pre>
368
368
  </td>
369
369
  <td>
370
- <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 197</span>
370
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 215</span>
371
371
 
372
372
  <span class='kw'>def</span> <span class='id identifier rubyid_feature_contribution_value'>feature_contribution_value</span>
373
373
  <span class='ivar'>@feature_contribution_value</span>
@@ -404,12 +404,12 @@
404
404
  <pre class="lines">
405
405
 
406
406
 
407
- 195
408
- 196
409
- 197</pre>
407
+ 213
408
+ 214
409
+ 215</pre>
410
410
  </td>
411
411
  <td>
412
- <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 195</span>
412
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 213</span>
413
413
 
414
414
  <span class='kw'>def</span> <span class='id identifier rubyid_value_index'>value_index</span>
415
415
  <span class='ivar'>@value_index</span>
@@ -425,9 +425,9 @@
425
425
  </div>
426
426
 
427
427
  <div id="footer">
428
- Generated on Wed May 12 10:45:10 2021 by
428
+ Generated on Thu Jul 1 17:11:32 2021 by
429
429
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
430
- 0.9.26 (ruby-2.6.7).
430
+ 0.9.26 (ruby-2.7.3).
431
431
  </div>
432
432
 
433
433
  </div>
data/docs/_index.html CHANGED
@@ -80,6 +80,13 @@
80
80
  <li class="letter">B</li>
81
81
  <ul>
82
82
 
83
+ <li>
84
+ <span class='object_link'><a href="Tangram/BagOfWordsCosineSimilarityFeatureContribution.html" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution (class)">BagOfWordsCosineSimilarityFeatureContribution</a></span>
85
+
86
+ <small>(Tangram)</small>
87
+
88
+ </li>
89
+
83
90
  <li>
84
91
  <span class='object_link'><a href="Tangram/BagOfWordsFeatureContribution.html" title="Tangram::BagOfWordsFeatureContribution (class)">BagOfWordsFeatureContribution</a></span>
85
92
 
@@ -300,9 +307,9 @@
300
307
  </div>
301
308
 
302
309
  <div id="footer">
303
- Generated on Wed May 12 10:45:10 2021 by
310
+ Generated on Thu Jul 1 17:11:32 2021 by
304
311
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
305
- 0.9.26 (ruby-2.6.7).
312
+ 0.9.26 (ruby-2.7.3).
306
313
  </div>
307
314
 
308
315
  </div>
data/docs/class_list.html CHANGED
@@ -43,7 +43,7 @@
43
43
 
44
44
  <ul id="full_list" class="class">
45
45
  <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
46
- <li id='object_Tangram' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Tangram.html" title="Tangram (module)">Tangram</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Tangram::BagOfWordsFeatureContribution' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/BagOfWordsFeatureContribution.html" title="Tangram::BagOfWordsFeatureContribution (class)">BagOfWordsFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::Bigram' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/Bigram.html" title="Tangram::Bigram (class)">Bigram</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::BinaryClassificationPredictOutput' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/BinaryClassificationPredictOutput.html" title="Tangram::BinaryClassificationPredictOutput (class)">BinaryClassificationPredictOutput</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::FeatureContributions' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/FeatureContributions.html" title="Tangram::FeatureContributions (class)">FeatureContributions</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::IdentityFeatureContribution' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/IdentityFeatureContribution.html" title="Tangram::IdentityFeatureContribution (class)">IdentityFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::LibTangram' class='collapsed even'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Tangram/LibTangram.html" title="Tangram::LibTangram (module)">LibTangram</a></span><small class='search_info'>Tangram</small></div><ul><li id='object_Tangram::LibTangram::TangramStringView' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Tangram/LibTangram/TangramStringView.html" title="Tangram::LibTangram::TangramStringView (class)">TangramStringView</a></span> &lt; Struct<small class='search_info'>Tangram::LibTangram</small></div></li></ul></li><li id='object_Tangram::LoadModelOptions' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/LoadModelOptions.html" title="Tangram::LoadModelOptions (class)">LoadModelOptions</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::Model' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/Model.html" title="Tangram::Model (class)">Model</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::MulticlassClassificationPredictOutput' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/MulticlassClassificationPredictOutput.html" title="Tangram::MulticlassClassificationPredictOutput (class)">MulticlassClassificationPredictOutput</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::NormalizedFeatureContribution' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/NormalizedFeatureContribution.html" title="Tangram::NormalizedFeatureContribution (class)">NormalizedFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::OneHotEncodedFeatureContribution' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/OneHotEncodedFeatureContribution.html" title="Tangram::OneHotEncodedFeatureContribution (class)">OneHotEncodedFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::PredictOptions' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/PredictOptions.html" title="Tangram::PredictOptions (class)">PredictOptions</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::RegressionPredictOutput' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/RegressionPredictOutput.html" title="Tangram::RegressionPredictOutput (class)">RegressionPredictOutput</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::Unigram' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/Unigram.html" title="Tangram::Unigram (class)">Unigram</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::WordEmbeddingFeatureContribution' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/WordEmbeddingFeatureContribution.html" title="Tangram::WordEmbeddingFeatureContribution (class)">WordEmbeddingFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li></ul></li>
46
+ <li id='object_Tangram' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Tangram.html" title="Tangram (module)">Tangram</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Tangram::BagOfWordsCosineSimilarityFeatureContribution' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/BagOfWordsCosineSimilarityFeatureContribution.html" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution (class)">BagOfWordsCosineSimilarityFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::BagOfWordsFeatureContribution' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/BagOfWordsFeatureContribution.html" title="Tangram::BagOfWordsFeatureContribution (class)">BagOfWordsFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::Bigram' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/Bigram.html" title="Tangram::Bigram (class)">Bigram</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::BinaryClassificationPredictOutput' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/BinaryClassificationPredictOutput.html" title="Tangram::BinaryClassificationPredictOutput (class)">BinaryClassificationPredictOutput</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::FeatureContributions' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/FeatureContributions.html" title="Tangram::FeatureContributions (class)">FeatureContributions</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::IdentityFeatureContribution' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/IdentityFeatureContribution.html" title="Tangram::IdentityFeatureContribution (class)">IdentityFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::LibTangram' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Tangram/LibTangram.html" title="Tangram::LibTangram (module)">LibTangram</a></span><small class='search_info'>Tangram</small></div><ul><li id='object_Tangram::LibTangram::TangramStringView' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Tangram/LibTangram/TangramStringView.html" title="Tangram::LibTangram::TangramStringView (class)">TangramStringView</a></span> &lt; Struct<small class='search_info'>Tangram::LibTangram</small></div></li></ul></li><li id='object_Tangram::LoadModelOptions' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/LoadModelOptions.html" title="Tangram::LoadModelOptions (class)">LoadModelOptions</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::Model' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/Model.html" title="Tangram::Model (class)">Model</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::MulticlassClassificationPredictOutput' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/MulticlassClassificationPredictOutput.html" title="Tangram::MulticlassClassificationPredictOutput (class)">MulticlassClassificationPredictOutput</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::NormalizedFeatureContribution' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/NormalizedFeatureContribution.html" title="Tangram::NormalizedFeatureContribution (class)">NormalizedFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::OneHotEncodedFeatureContribution' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/OneHotEncodedFeatureContribution.html" title="Tangram::OneHotEncodedFeatureContribution (class)">OneHotEncodedFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::PredictOptions' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/PredictOptions.html" title="Tangram::PredictOptions (class)">PredictOptions</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::RegressionPredictOutput' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/RegressionPredictOutput.html" title="Tangram::RegressionPredictOutput (class)">RegressionPredictOutput</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::Unigram' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/Unigram.html" title="Tangram::Unigram (class)">Unigram</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li><li id='object_Tangram::WordEmbeddingFeatureContribution' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Tangram/WordEmbeddingFeatureContribution.html" title="Tangram::WordEmbeddingFeatureContribution (class)">WordEmbeddingFeatureContribution</a></span> &lt; Object<small class='search_info'>Tangram</small></div></li></ul></li>
47
47
 
48
48
  </ul>
49
49
  </div>
@@ -64,7 +64,7 @@
64
64
  <li><a href="https://www.tangram.xyz/docs">Read the Docs</a></li>
65
65
  </ul>
66
66
 
67
- <p>The Tangram Ruby gem makes it easy to make predictions with your Tangram machine learning model from Ruby.</p>
67
+ <p>The Tangram Ruby library makes it easy to make predictions with your Tangram machine learning model from Ruby.</p>
68
68
 
69
69
  <h2 id="usage">Usage</h2>
70
70
 
@@ -88,39 +88,17 @@
88
88
 
89
89
  <h2 id="platform-support">Platform Support</h2>
90
90
 
91
- <p>Tangram for Ruby is currently supported on Linux, macOS, and Windows with AMD64 CPUs. Are you interested in another platform? <a href="https://github.com/tangramxyz/tangram/issues/new">Open an issue</a> or send us an email at <a href="mailto:help@tangram.xyz">help@tangram.xyz</a>.</p>
91
+ <p>Tangram for Ruby is currently supported on Linux, macOS, and Windows with ARM64 and AMD64 CPUs. Are you interested in another platform? <a href="https://github.com/tangramxyz/tangram/issues/new">Open an issue</a> or send us an email at <a href="mailto:help@tangram.xyz">help@tangram.xyz</a>.</p>
92
92
 
93
93
  <h2 id="examples">Examples</h2>
94
94
 
95
- <p>The source for this gem contains two examples, <code>examples/predict</code> and <code>examples/monitor</code>.</p>
96
-
97
- <h3 id="basic">Basic</h3>
98
-
99
- <p>The basic example demonstrates loading a model from a <code>.tangram</code> file and making a prediction.</p>
100
-
101
- <p>To run the example:</p>
102
-
103
- <pre class="code ruby"><code class="ruby">$ ruby examples/basic.rb
104
- </code></pre>
105
-
106
- <h3 id="advanced">Advanced</h3>
107
-
108
- <p>The advanced example demonstrates logging predictions and true values to the Tangram app. Before running the example, run <code>tangram app</code> to start the app running locally, open <code>http://localhost:8080</code> in your browser, and upload the file <code>examples/heart_disease.tangram</code> to it.</p>
109
-
110
- <p>To run the example:</p>
111
-
112
- <pre class="code ruby"><code class="ruby">$ TANGRAM_URL=http://localhost:8080 ruby examples/advanced.rb
113
- </code></pre>
114
-
115
- <p>Now if you refresh the production stats or production metrics tabs for the model you uploaded, you should see predictions and true values.</p>
116
-
117
- <p>For more information, <a href="https://www.tangram.xyz/docs">read the docs</a>.</p>
95
+ <p>The source for this package contains a number of examples in the <code>examples</code> directory. Each example has a <code>README.md</code> explaining how to run it.</p>
118
96
  </div></div>
119
97
 
120
98
  <div id="footer">
121
- Generated on Wed May 12 10:45:10 2021 by
99
+ Generated on Thu Jul 1 17:11:32 2021 by
122
100
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
123
- 0.9.26 (ruby-2.6.7).
101
+ 0.9.26 (ruby-2.7.3).
124
102
  </div>
125
103
 
126
104
  </div>
data/docs/index.html CHANGED
@@ -64,7 +64,7 @@
64
64
  <li><a href="https://www.tangram.xyz/docs">Read the Docs</a></li>
65
65
  </ul>
66
66
 
67
- <p>The Tangram Ruby gem makes it easy to make predictions with your Tangram machine learning model from Ruby.</p>
67
+ <p>The Tangram Ruby library makes it easy to make predictions with your Tangram machine learning model from Ruby.</p>
68
68
 
69
69
  <h2 id="usage">Usage</h2>
70
70
 
@@ -88,39 +88,17 @@
88
88
 
89
89
  <h2 id="platform-support">Platform Support</h2>
90
90
 
91
- <p>Tangram for Ruby is currently supported on Linux, macOS, and Windows with AMD64 CPUs. Are you interested in another platform? <a href="https://github.com/tangramxyz/tangram/issues/new">Open an issue</a> or send us an email at <a href="mailto:help@tangram.xyz">help@tangram.xyz</a>.</p>
91
+ <p>Tangram for Ruby is currently supported on Linux, macOS, and Windows with ARM64 and AMD64 CPUs. Are you interested in another platform? <a href="https://github.com/tangramxyz/tangram/issues/new">Open an issue</a> or send us an email at <a href="mailto:help@tangram.xyz">help@tangram.xyz</a>.</p>
92
92
 
93
93
  <h2 id="examples">Examples</h2>
94
94
 
95
- <p>The source for this gem contains two examples, <code>examples/predict</code> and <code>examples/monitor</code>.</p>
96
-
97
- <h3 id="basic">Basic</h3>
98
-
99
- <p>The basic example demonstrates loading a model from a <code>.tangram</code> file and making a prediction.</p>
100
-
101
- <p>To run the example:</p>
102
-
103
- <pre class="code ruby"><code class="ruby">$ ruby examples/basic.rb
104
- </code></pre>
105
-
106
- <h3 id="advanced">Advanced</h3>
107
-
108
- <p>The advanced example demonstrates logging predictions and true values to the Tangram app. Before running the example, run <code>tangram app</code> to start the app running locally, open <code>http://localhost:8080</code> in your browser, and upload the file <code>examples/heart_disease.tangram</code> to it.</p>
109
-
110
- <p>To run the example:</p>
111
-
112
- <pre class="code ruby"><code class="ruby">$ TANGRAM_URL=http://localhost:8080 ruby examples/advanced.rb
113
- </code></pre>
114
-
115
- <p>Now if you refresh the production stats or production metrics tabs for the model you uploaded, you should see predictions and true values.</p>
116
-
117
- <p>For more information, <a href="https://www.tangram.xyz/docs">read the docs</a>.</p>
95
+ <p>The source for this package contains a number of examples in the <code>examples</code> directory. Each example has a <code>README.md</code> explaining how to run it.</p>
118
96
  </div></div>
119
97
 
120
98
  <div id="footer">
121
- Generated on Wed May 12 10:45:10 2021 by
99
+ Generated on Thu Jul 1 17:11:32 2021 by
122
100
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
123
- 0.9.26 (ruby-2.6.7).
101
+ 0.9.26 (ruby-2.7.3).
124
102
  </div>
125
103
 
126
104
  </div>
@@ -108,6 +108,22 @@
108
108
  </li>
109
109
 
110
110
 
111
+ <li class="odd ">
112
+ <div class="item">
113
+ <span class='object_link'><a href="Tangram/BagOfWordsCosineSimilarityFeatureContribution.html#column_name_a-instance_method" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution#column_name_a (method)">#column_name_a</a></span>
114
+ <small>Tangram::BagOfWordsCosineSimilarityFeatureContribution</small>
115
+ </div>
116
+ </li>
117
+
118
+
119
+ <li class="even ">
120
+ <div class="item">
121
+ <span class='object_link'><a href="Tangram/BagOfWordsCosineSimilarityFeatureContribution.html#column_name_b-instance_method" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution#column_name_b (method)">#column_name_b</a></span>
122
+ <small>Tangram::BagOfWordsCosineSimilarityFeatureContribution</small>
123
+ </div>
124
+ </li>
125
+
126
+
111
127
  <li class="odd ">
112
128
  <div class="item">
113
129
  <span class='object_link'><a href="Tangram/PredictOptions.html#compute_feature_contributions-instance_method" title="Tangram::PredictOptions#compute_feature_contributions (method)">#compute_feature_contributions</a></span>
@@ -173,6 +189,14 @@
173
189
 
174
190
 
175
191
  <li class="odd ">
192
+ <div class="item">
193
+ <span class='object_link'><a href="Tangram/BagOfWordsCosineSimilarityFeatureContribution.html#feature_contribution_value-instance_method" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution#feature_contribution_value (method)">#feature_contribution_value</a></span>
194
+ <small>Tangram::BagOfWordsCosineSimilarityFeatureContribution</small>
195
+ </div>
196
+ </li>
197
+
198
+
199
+ <li class="even ">
176
200
  <div class="item">
177
201
  <span class='object_link'><a href="Tangram/WordEmbeddingFeatureContribution.html#feature_contribution_value-instance_method" title="Tangram::WordEmbeddingFeatureContribution#feature_contribution_value (method)">#feature_contribution_value</a></span>
178
202
  <small>Tangram::WordEmbeddingFeatureContribution</small>
@@ -180,7 +204,7 @@
180
204
  </li>
181
205
 
182
206
 
183
- <li class="even ">
207
+ <li class="odd ">
184
208
  <div class="item">
185
209
  <span class='object_link'><a href="Tangram/RegressionPredictOutput.html#feature_contributions-instance_method" title="Tangram::RegressionPredictOutput#feature_contributions (method)">#feature_contributions</a></span>
186
210
  <small>Tangram::RegressionPredictOutput</small>
@@ -188,7 +212,7 @@
188
212
  </li>
189
213
 
190
214
 
191
- <li class="odd ">
215
+ <li class="even ">
192
216
  <div class="item">
193
217
  <span class='object_link'><a href="Tangram/BinaryClassificationPredictOutput.html#feature_contributions-instance_method" title="Tangram::BinaryClassificationPredictOutput#feature_contributions (method)">#feature_contributions</a></span>
194
218
  <small>Tangram::BinaryClassificationPredictOutput</small>
@@ -196,7 +220,7 @@
196
220
  </li>
197
221
 
198
222
 
199
- <li class="even ">
223
+ <li class="odd ">
200
224
  <div class="item">
201
225
  <span class='object_link'><a href="Tangram/MulticlassClassificationPredictOutput.html#feature_contributions-instance_method" title="Tangram::MulticlassClassificationPredictOutput#feature_contributions (method)">#feature_contributions</a></span>
202
226
  <small>Tangram::MulticlassClassificationPredictOutput</small>
@@ -204,7 +228,7 @@
204
228
  </li>
205
229
 
206
230
 
207
- <li class="odd ">
231
+ <li class="even ">
208
232
  <div class="item">
209
233
  <span class='object_link'><a href="Tangram/IdentityFeatureContribution.html#feature_value-instance_method" title="Tangram::IdentityFeatureContribution#feature_value (method)">#feature_value</a></span>
210
234
  <small>Tangram::IdentityFeatureContribution</small>
@@ -212,7 +236,7 @@
212
236
  </li>
213
237
 
214
238
 
215
- <li class="even ">
239
+ <li class="odd ">
216
240
  <div class="item">
217
241
  <span class='object_link'><a href="Tangram/NormalizedFeatureContribution.html#feature_value-instance_method" title="Tangram::NormalizedFeatureContribution#feature_value (method)">#feature_value</a></span>
218
242
  <small>Tangram::NormalizedFeatureContribution</small>
@@ -220,7 +244,7 @@
220
244
  </li>
221
245
 
222
246
 
223
- <li class="odd ">
247
+ <li class="even ">
224
248
  <div class="item">
225
249
  <span class='object_link'><a href="Tangram/OneHotEncodedFeatureContribution.html#feature_value-instance_method" title="Tangram::OneHotEncodedFeatureContribution#feature_value (method)">#feature_value</a></span>
226
250
  <small>Tangram::OneHotEncodedFeatureContribution</small>
@@ -228,7 +252,7 @@
228
252
  </li>
229
253
 
230
254
 
231
- <li class="even ">
255
+ <li class="odd ">
232
256
  <div class="item">
233
257
  <span class='object_link'><a href="Tangram/BagOfWordsFeatureContribution.html#feature_value-instance_method" title="Tangram::BagOfWordsFeatureContribution#feature_value (method)">#feature_value</a></span>
234
258
  <small>Tangram::BagOfWordsFeatureContribution</small>
@@ -236,6 +260,14 @@
236
260
  </li>
237
261
 
238
262
 
263
+ <li class="even ">
264
+ <div class="item">
265
+ <span class='object_link'><a href="Tangram/BagOfWordsCosineSimilarityFeatureContribution.html#feature_value-instance_method" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution#feature_value (method)">#feature_value</a></span>
266
+ <small>Tangram::BagOfWordsCosineSimilarityFeatureContribution</small>
267
+ </div>
268
+ </li>
269
+
270
+
239
271
  <li class="odd ">
240
272
  <div class="item">
241
273
  <span class='object_link'><a href="Tangram/Model.html#flush_log_queue-instance_method" title="Tangram::Model#flush_log_queue (method)">#flush_log_queue</a></span>
@@ -365,6 +397,14 @@
365
397
 
366
398
 
367
399
  <li class="odd ">
400
+ <div class="item">
401
+ <span class='object_link'><a href="Tangram/BagOfWordsCosineSimilarityFeatureContribution.html#initialize-instance_method" title="Tangram::BagOfWordsCosineSimilarityFeatureContribution#initialize (method)">#initialize</a></span>
402
+ <small>Tangram::BagOfWordsCosineSimilarityFeatureContribution</small>
403
+ </div>
404
+ </li>
405
+
406
+
407
+ <li class="even ">
368
408
  <div class="item">
369
409
  <span class='object_link'><a href="Tangram/WordEmbeddingFeatureContribution.html#initialize-instance_method" title="Tangram::WordEmbeddingFeatureContribution#initialize (method)">#initialize</a></span>
370
410
  <small>Tangram::WordEmbeddingFeatureContribution</small>
@@ -372,7 +412,7 @@
372
412
  </li>
373
413
 
374
414
 
375
- <li class="even ">
415
+ <li class="odd ">
376
416
  <div class="item">
377
417
  <span class='object_link'><a href="Tangram/Model.html#initialize-instance_method" title="Tangram::Model#initialize (method)">#initialize</a></span>
378
418
  <small>Tangram::Model</small>
@@ -380,7 +420,7 @@
380
420
  </li>
381
421
 
382
422
 
383
- <li class="odd ">
423
+ <li class="even ">
384
424
  <div class="item">
385
425
  <span class='object_link'><a href="Tangram/LibTangram/TangramStringView.html#into_string-instance_method" title="Tangram::LibTangram::TangramStringView#into_string (method)">#into_string</a></span>
386
426
  <small>Tangram::LibTangram::TangramStringView</small>
@@ -388,7 +428,7 @@
388
428
  </li>
389
429
 
390
430
 
391
- <li class="even ">
431
+ <li class="odd ">
392
432
  <div class="item">
393
433
  <span class='object_link'><a href="Tangram/Model.html#log_prediction-instance_method" title="Tangram::Model#log_prediction (method)">#log_prediction</a></span>
394
434
  <small>Tangram::Model</small>
@@ -396,7 +436,7 @@
396
436
  </li>
397
437
 
398
438
 
399
- <li class="odd ">
439
+ <li class="even ">
400
440
  <div class="item">
401
441
  <span class='object_link'><a href="Tangram/Model.html#log_true_value-instance_method" title="Tangram::Model#log_true_value (method)">#log_true_value</a></span>
402
442
  <small>Tangram::Model</small>
@@ -404,7 +444,7 @@
404
444
  </li>
405
445
 
406
446
 
407
- <li class="even ">
447
+ <li class="odd ">
408
448
  <div class="item">
409
449
  <span class='object_link'><a href="Tangram/BagOfWordsFeatureContribution.html#ngram-instance_method" title="Tangram::BagOfWordsFeatureContribution#ngram (method)">#ngram</a></span>
410
450
  <small>Tangram::BagOfWordsFeatureContribution</small>
@@ -412,7 +452,7 @@
412
452
  </li>
413
453
 
414
454
 
415
- <li class="odd ">
455
+ <li class="even ">
416
456
  <div class="item">
417
457
  <span class='object_link'><a href="Tangram/FeatureContributions.html#output-instance_method" title="Tangram::FeatureContributions#output (method)">#output</a></span>
418
458
  <small>Tangram::FeatureContributions</small>
@@ -420,7 +460,7 @@
420
460
  </li>
421
461
 
422
462
 
423
- <li class="even ">
463
+ <li class="odd ">
424
464
  <div class="item">
425
465
  <span class='object_link'><a href="Tangram/Model.html#predict-instance_method" title="Tangram::Model#predict (method)">#predict</a></span>
426
466
  <small>Tangram::Model</small>
@@ -428,7 +468,7 @@
428
468
  </li>
429
469
 
430
470
 
431
- <li class="odd ">
471
+ <li class="even ">
432
472
  <div class="item">
433
473
  <span class='object_link'><a href="Tangram/MulticlassClassificationPredictOutput.html#probabilities-instance_method" title="Tangram::MulticlassClassificationPredictOutput#probabilities (method)">#probabilities</a></span>
434
474
  <small>Tangram::MulticlassClassificationPredictOutput</small>
@@ -436,7 +476,7 @@
436
476
  </li>
437
477
 
438
478
 
439
- <li class="even ">
479
+ <li class="odd ">
440
480
  <div class="item">
441
481
  <span class='object_link'><a href="Tangram/BinaryClassificationPredictOutput.html#probability-instance_method" title="Tangram::BinaryClassificationPredictOutput#probability (method)">#probability</a></span>
442
482
  <small>Tangram::BinaryClassificationPredictOutput</small>
@@ -444,7 +484,7 @@
444
484
  </li>
445
485
 
446
486
 
447
- <li class="odd ">
487
+ <li class="even ">
448
488
  <div class="item">
449
489
  <span class='object_link'><a href="Tangram/MulticlassClassificationPredictOutput.html#probability-instance_method" title="Tangram::MulticlassClassificationPredictOutput#probability (method)">#probability</a></span>
450
490
  <small>Tangram::MulticlassClassificationPredictOutput</small>
@@ -452,7 +492,7 @@
452
492
  </li>
453
493
 
454
494
 
455
- <li class="even ">
495
+ <li class="odd ">
456
496
  <div class="item">
457
497
  <span class='object_link'><a href="Tangram/LoadModelOptions.html#tangram_url-instance_method" title="Tangram::LoadModelOptions#tangram_url (method)">#tangram_url</a></span>
458
498
  <small>Tangram::LoadModelOptions</small>
@@ -460,7 +500,7 @@
460
500
  </li>
461
501
 
462
502
 
463
- <li class="odd ">
503
+ <li class="even ">
464
504
  <div class="item">
465
505
  <span class='object_link'><a href="Tangram/PredictOptions.html#threshold-instance_method" title="Tangram::PredictOptions#threshold (method)">#threshold</a></span>
466
506
  <small>Tangram::PredictOptions</small>
@@ -468,7 +508,7 @@
468
508
  </li>
469
509
 
470
510
 
471
- <li class="even ">
511
+ <li class="odd ">
472
512
  <div class="item">
473
513
  <span class='object_link'><a href="Tangram/PredictOptions.html#to_json-instance_method" title="Tangram::PredictOptions#to_json (method)">#to_json</a></span>
474
514
  <small>Tangram::PredictOptions</small>
@@ -476,7 +516,7 @@
476
516
  </li>
477
517
 
478
518
 
479
- <li class="odd ">
519
+ <li class="even ">
480
520
  <div class="item">
481
521
  <span class='object_link'><a href="Tangram/RegressionPredictOutput.html#to_json-instance_method" title="Tangram::RegressionPredictOutput#to_json (method)">#to_json</a></span>
482
522
  <small>Tangram::RegressionPredictOutput</small>
@@ -484,7 +524,7 @@
484
524
  </li>
485
525
 
486
526
 
487
- <li class="even ">
527
+ <li class="odd ">
488
528
  <div class="item">
489
529
  <span class='object_link'><a href="Tangram/BinaryClassificationPredictOutput.html#to_json-instance_method" title="Tangram::BinaryClassificationPredictOutput#to_json (method)">#to_json</a></span>
490
530
  <small>Tangram::BinaryClassificationPredictOutput</small>
@@ -492,7 +532,7 @@
492
532
  </li>
493
533
 
494
534
 
495
- <li class="odd ">
535
+ <li class="even ">
496
536
  <div class="item">
497
537
  <span class='object_link'><a href="Tangram/MulticlassClassificationPredictOutput.html#to_json-instance_method" title="Tangram::MulticlassClassificationPredictOutput#to_json (method)">#to_json</a></span>
498
538
  <small>Tangram::MulticlassClassificationPredictOutput</small>
@@ -500,7 +540,7 @@
500
540
  </li>
501
541
 
502
542
 
503
- <li class="even ">
543
+ <li class="odd ">
504
544
  <div class="item">
505
545
  <span class='object_link'><a href="Tangram/Unigram.html#token-instance_method" title="Tangram::Unigram#token (method)">#token</a></span>
506
546
  <small>Tangram::Unigram</small>
@@ -508,7 +548,7 @@
508
548
  </li>
509
549
 
510
550
 
511
- <li class="odd ">
551
+ <li class="even ">
512
552
  <div class="item">
513
553
  <span class='object_link'><a href="Tangram/Bigram.html#token_a-instance_method" title="Tangram::Bigram#token_a (method)">#token_a</a></span>
514
554
  <small>Tangram::Bigram</small>
@@ -516,7 +556,7 @@
516
556
  </li>
517
557
 
518
558
 
519
- <li class="even ">
559
+ <li class="odd ">
520
560
  <div class="item">
521
561
  <span class='object_link'><a href="Tangram/Bigram.html#token_b-instance_method" title="Tangram::Bigram#token_b (method)">#token_b</a></span>
522
562
  <small>Tangram::Bigram</small>
@@ -524,7 +564,7 @@
524
564
  </li>
525
565
 
526
566
 
527
- <li class="odd ">
567
+ <li class="even ">
528
568
  <div class="item">
529
569
  <span class='object_link'><a href="Tangram/RegressionPredictOutput.html#value-instance_method" title="Tangram::RegressionPredictOutput#value (method)">#value</a></span>
530
570
  <small>Tangram::RegressionPredictOutput</small>
@@ -532,7 +572,7 @@
532
572
  </li>
533
573
 
534
574
 
535
- <li class="even ">
575
+ <li class="odd ">
536
576
  <div class="item">
537
577
  <span class='object_link'><a href="Tangram/WordEmbeddingFeatureContribution.html#value_index-instance_method" title="Tangram::WordEmbeddingFeatureContribution#value_index (method)">#value_index</a></span>
538
578
  <small>Tangram::WordEmbeddingFeatureContribution</small>
@@ -540,7 +580,7 @@
540
580
  </li>
541
581
 
542
582
 
543
- <li class="odd ">
583
+ <li class="even ">
544
584
  <div class="item">
545
585
  <span class='object_link'><a href="Tangram/OneHotEncodedFeatureContribution.html#variant-instance_method" title="Tangram::OneHotEncodedFeatureContribution#variant (method)">#variant</a></span>
546
586
  <small>Tangram::OneHotEncodedFeatureContribution</small>