tangram 0.6.1 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/docs/Tangram.html +4 -3
  4. data/docs/Tangram/BagOfWordsCosineSimilarityFeatureContribution.html +24 -13
  5. data/docs/Tangram/BagOfWordsFeatureContribution.html +24 -13
  6. data/docs/Tangram/Bigram.html +16 -9
  7. data/docs/Tangram/BinaryClassificationPredictOutput.html +20 -11
  8. data/docs/Tangram/FeatureContributions.html +20 -11
  9. data/docs/Tangram/IdentityFeatureContribution.html +20 -11
  10. data/docs/Tangram/LibTangram.html +2 -2
  11. data/docs/Tangram/LibTangram/TangramStringView.html +2 -2
  12. data/docs/Tangram/LoadModelOptions.html +12 -7
  13. data/docs/Tangram/Model.html +83 -43
  14. data/docs/Tangram/MulticlassClassificationPredictOutput.html +24 -13
  15. data/docs/Tangram/NormalizedFeatureContribution.html +20 -11
  16. data/docs/Tangram/OneHotEncodedFeatureContribution.html +24 -13
  17. data/docs/Tangram/PredictOptions.html +16 -9
  18. data/docs/Tangram/RegressionPredictOutput.html +16 -9
  19. data/docs/Tangram/Unigram.html +12 -7
  20. data/docs/Tangram/WordEmbeddingFeatureContribution.html +20 -11
  21. data/docs/_index.html +2 -2
  22. data/docs/file.README.html +14 -13
  23. data/docs/index.html +14 -13
  24. data/docs/top-level-namespace.html +2 -2
  25. data/examples/advanced/README.md +1 -1
  26. data/examples/advanced/main.rb +1 -1
  27. data/lib/tangram/libtangram/aarch64-apple-darwin/libtangram.dylib +0 -0
  28. data/lib/tangram/libtangram/aarch64-unknown-linux-gnu/libtangram.so +0 -0
  29. data/lib/tangram/libtangram/aarch64-unknown-linux-musl/libtangram.so +0 -0
  30. data/lib/tangram/libtangram/x86_64-apple-darwin/libtangram.dylib +0 -0
  31. data/lib/tangram/libtangram/x86_64-pc-windows-msvc/tangram.dll +0 -0
  32. data/lib/tangram/libtangram/x86_64-unknown-linux-gnu/libtangram.so +0 -0
  33. data/lib/tangram/libtangram/x86_64-unknown-linux-musl/libtangram.so +0 -0
  34. data/lib/tangram/tangram.rb +4 -4
  35. data/tangram.gemspec +4 -4
  36. metadata +4 -4
@@ -101,7 +101,8 @@
101
101
 
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
- <p><code>predict</code> outputs <code>MulticlassClassificationPredictOutput</code> when the model&#39;s task is multiclass classification.</p>
104
+
105
+ <p><code>predict</code> outputs <code>MulticlassClassificationPredictOutput</code> when the model&#39;s task is multiclass classification.</p>
105
106
 
106
107
 
107
108
  </div>
@@ -138,7 +139,8 @@
138
139
 
139
140
 
140
141
 
141
- <span class="summary_desc"><div class='inline'><p>This is the name of the predicted class.</p>
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>This is the name of the predicted class.</p>
142
144
  </div></span>
143
145
 
144
146
  </li>
@@ -166,7 +168,8 @@
166
168
 
167
169
 
168
170
 
169
- <span class="summary_desc"><div class='inline'><p>If computing feature contributions was enabled in the predict options, this value will explain the model&#39;s output, showing how much each feature contributed to the output.</p>
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>If computing feature contributions was enabled in the predict options, this value will explain the model&#39;s output, showing how much each feature contributed to the output.</p>
170
173
  </div></span>
171
174
 
172
175
  </li>
@@ -194,7 +197,8 @@
194
197
 
195
198
 
196
199
 
197
- <span class="summary_desc"><div class='inline'><p>This value maps from class names to the probability the model assigned to each class.</p>
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>This value maps from class names to the probability the model assigned to each class.</p>
198
202
  </div></span>
199
203
 
200
204
  </li>
@@ -222,7 +226,8 @@
222
226
 
223
227
 
224
228
 
225
- <span class="summary_desc"><div class='inline'><p>This is the probability the model assigned to the predicted class.</p>
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>This is the probability the model assigned to the predicted class.</p>
226
231
  </div></span>
227
232
 
228
233
  </li>
@@ -260,7 +265,8 @@
260
265
 
261
266
 
262
267
 
263
- <span class="summary_desc"><div class='inline'><p>A new instance of MulticlassClassificationPredictOutput.</p>
268
+ <span class="summary_desc"><div class='inline'>
269
+ <p>A new instance of MulticlassClassificationPredictOutput.</p>
264
270
  </div></span>
265
271
 
266
272
  </li>
@@ -305,7 +311,8 @@
305
311
 
306
312
  </h3><div class="docstring">
307
313
  <div class="discussion">
308
- <p>Returns a new instance of MulticlassClassificationPredictOutput.</p>
314
+
315
+ <p>Returns a new instance of MulticlassClassificationPredictOutput.</p>
309
316
 
310
317
 
311
318
  </div>
@@ -358,7 +365,8 @@
358
365
 
359
366
  </h3><div class="docstring">
360
367
  <div class="discussion">
361
- <p>This is the name of the predicted class.</p>
368
+
369
+ <p>This is the name of the predicted class.</p>
362
370
 
363
371
 
364
372
  </div>
@@ -400,7 +408,8 @@
400
408
 
401
409
  </h3><div class="docstring">
402
410
  <div class="discussion">
403
- <p>If computing feature contributions was enabled in the predict options, this value will explain the model&#39;s output, showing how much each feature contributed to the output. This value maps from class names to <code>FeatureContributions</code> values for each class. The class with the <code>FeatureContributions</code> value with the highest <code>output_value</code> is the predicted class.</p>
411
+
412
+ <p>If computing feature contributions was enabled in the predict options, this value will explain the model&#39;s output, showing how much each feature contributed to the output. This value maps from class names to <code>FeatureContributions</code> values for each class. The class with the <code>FeatureContributions</code> value with the highest <code>output_value</code> is the predicted class.</p>
404
413
 
405
414
 
406
415
  </div>
@@ -442,7 +451,8 @@
442
451
 
443
452
  </h3><div class="docstring">
444
453
  <div class="discussion">
445
- <p>This value maps from class names to the probability the model assigned to each class.</p>
454
+
455
+ <p>This value maps from class names to the probability the model assigned to each class.</p>
446
456
 
447
457
 
448
458
  </div>
@@ -484,7 +494,8 @@
484
494
 
485
495
  </h3><div class="docstring">
486
496
  <div class="discussion">
487
- <p>This is the probability the model assigned to the predicted class.</p>
497
+
498
+ <p>This is the probability the model assigned to the predicted class.</p>
488
499
 
489
500
 
490
501
  </div>
@@ -555,9 +566,9 @@
555
566
  </div>
556
567
 
557
568
  <div id="footer">
558
- Generated on Thu Jul 15 14:34:34 2021 by
569
+ Generated on Mon Jul 26 14:54:00 2021 by
559
570
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
560
- 0.9.26 (ruby-2.7.3).
571
+ 0.9.26 (ruby-2.7.4).
561
572
  </div>
562
573
 
563
574
  </div>
@@ -101,7 +101,8 @@
101
101
 
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
- <p>This describes the contribution of a feature from a normalized feature group.</p>
104
+
105
+ <p>This describes the contribution of a feature from a normalized feature group.</p>
105
106
 
106
107
 
107
108
  </div>
@@ -138,7 +139,8 @@
138
139
 
139
140
 
140
141
 
141
- <span class="summary_desc"><div class='inline'><p>This is the name of the source column for the feature group.</p>
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>This is the name of the source column for the feature group.</p>
142
144
  </div></span>
143
145
 
144
146
  </li>
@@ -166,7 +168,8 @@
166
168
 
167
169
 
168
170
 
169
- <span class="summary_desc"><div class='inline'><p>This is the amount that the feature contributed to the output.</p>
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>This is the amount that the feature contributed to the output.</p>
170
173
  </div></span>
171
174
 
172
175
  </li>
@@ -194,7 +197,8 @@
194
197
 
195
198
 
196
199
 
197
- <span class="summary_desc"><div class='inline'><p>This is the value of the feature.</p>
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>This is the value of the feature.</p>
198
202
  </div></span>
199
203
 
200
204
  </li>
@@ -232,7 +236,8 @@
232
236
 
233
237
 
234
238
 
235
- <span class="summary_desc"><div class='inline'><p>A new instance of NormalizedFeatureContribution.</p>
239
+ <span class="summary_desc"><div class='inline'>
240
+ <p>A new instance of NormalizedFeatureContribution.</p>
236
241
  </div></span>
237
242
 
238
243
  </li>
@@ -255,7 +260,8 @@
255
260
 
256
261
  </h3><div class="docstring">
257
262
  <div class="discussion">
258
- <p>Returns a new instance of NormalizedFeatureContribution.</p>
263
+
264
+ <p>Returns a new instance of NormalizedFeatureContribution.</p>
259
265
 
260
266
 
261
267
  </div>
@@ -306,7 +312,8 @@
306
312
 
307
313
  </h3><div class="docstring">
308
314
  <div class="discussion">
309
- <p>This is the name of the source column for the feature group.</p>
315
+
316
+ <p>This is the name of the source column for the feature group.</p>
310
317
 
311
318
 
312
319
  </div>
@@ -348,7 +355,8 @@
348
355
 
349
356
  </h3><div class="docstring">
350
357
  <div class="discussion">
351
- <p>This is the amount that the feature contributed to the output.</p>
358
+
359
+ <p>This is the amount that the feature contributed to the output.</p>
352
360
 
353
361
 
354
362
  </div>
@@ -390,7 +398,8 @@
390
398
 
391
399
  </h3><div class="docstring">
392
400
  <div class="discussion">
393
- <p>This is the value of the feature.</p>
401
+
402
+ <p>This is the value of the feature.</p>
394
403
 
395
404
 
396
405
  </div>
@@ -425,9 +434,9 @@
425
434
  </div>
426
435
 
427
436
  <div id="footer">
428
- Generated on Thu Jul 15 14:34:34 2021 by
437
+ Generated on Mon Jul 26 14:54:00 2021 by
429
438
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
430
- 0.9.26 (ruby-2.7.3).
439
+ 0.9.26 (ruby-2.7.4).
431
440
  </div>
432
441
 
433
442
  </div>
@@ -101,7 +101,8 @@
101
101
 
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
- <p>This describes the contribution of a feature from a one hot encoded feature group.</p>
104
+
105
+ <p>This describes the contribution of a feature from a one hot encoded feature group.</p>
105
106
 
106
107
 
107
108
  </div>
@@ -138,7 +139,8 @@
138
139
 
139
140
 
140
141
 
141
- <span class="summary_desc"><div class='inline'><p>This is the name of the source column for the feature group.</p>
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>This is the name of the source column for the feature group.</p>
142
144
  </div></span>
143
145
 
144
146
  </li>
@@ -166,7 +168,8 @@
166
168
 
167
169
 
168
170
 
169
- <span class="summary_desc"><div class='inline'><p>This is the amount that the feature contributed to the output.b.</p>
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>This is the amount that the feature contributed to the output.b.</p>
170
173
  </div></span>
171
174
 
172
175
  </li>
@@ -194,7 +197,8 @@
194
197
 
195
198
 
196
199
 
197
- <span class="summary_desc"><div class='inline'><p>This is the value of the feature.</p>
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>This is the value of the feature.</p>
198
202
  </div></span>
199
203
 
200
204
  </li>
@@ -222,7 +226,8 @@
222
226
 
223
227
 
224
228
 
225
- <span class="summary_desc"><div class='inline'><p>This is the enum variant the feature indicates the presence of.</p>
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>This is the enum variant the feature indicates the presence of.</p>
226
231
  </div></span>
227
232
 
228
233
  </li>
@@ -260,7 +265,8 @@
260
265
 
261
266
 
262
267
 
263
- <span class="summary_desc"><div class='inline'><p>A new instance of OneHotEncodedFeatureContribution.</p>
268
+ <span class="summary_desc"><div class='inline'>
269
+ <p>A new instance of OneHotEncodedFeatureContribution.</p>
264
270
  </div></span>
265
271
 
266
272
  </li>
@@ -283,7 +289,8 @@
283
289
 
284
290
  </h3><div class="docstring">
285
291
  <div class="discussion">
286
- <p>Returns a new instance of OneHotEncodedFeatureContribution.</p>
292
+
293
+ <p>Returns a new instance of OneHotEncodedFeatureContribution.</p>
287
294
 
288
295
 
289
296
  </div>
@@ -336,7 +343,8 @@
336
343
 
337
344
  </h3><div class="docstring">
338
345
  <div class="discussion">
339
- <p>This is the name of the source column for the feature group.</p>
346
+
347
+ <p>This is the name of the source column for the feature group.</p>
340
348
 
341
349
 
342
350
  </div>
@@ -378,7 +386,8 @@
378
386
 
379
387
  </h3><div class="docstring">
380
388
  <div class="discussion">
381
- <p>This is the amount that the feature contributed to the output.b</p>
389
+
390
+ <p>This is the amount that the feature contributed to the output.b</p>
382
391
 
383
392
 
384
393
  </div>
@@ -420,7 +429,8 @@
420
429
 
421
430
  </h3><div class="docstring">
422
431
  <div class="discussion">
423
- <p>This is the value of the feature.</p>
432
+
433
+ <p>This is the value of the feature.</p>
424
434
 
425
435
 
426
436
  </div>
@@ -462,7 +472,8 @@
462
472
 
463
473
  </h3><div class="docstring">
464
474
  <div class="discussion">
465
- <p>This is the enum variant the feature indicates the presence of.</p>
475
+
476
+ <p>This is the enum variant the feature indicates the presence of.</p>
466
477
 
467
478
 
468
479
  </div>
@@ -497,9 +508,9 @@
497
508
  </div>
498
509
 
499
510
  <div id="footer">
500
- Generated on Thu Jul 15 14:34:34 2021 by
511
+ Generated on Mon Jul 26 14:54:00 2021 by
501
512
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
502
- 0.9.26 (ruby-2.7.3).
513
+ 0.9.26 (ruby-2.7.4).
503
514
  </div>
504
515
 
505
516
  </div>
@@ -101,7 +101,8 @@
101
101
 
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
- <p>These are the options passed to <code>predict</code>.</p>
104
+
105
+ <p>These are the options passed to <code>predict</code>.</p>
105
106
 
106
107
 
107
108
  </div>
@@ -138,7 +139,8 @@
138
139
 
139
140
 
140
141
 
141
- <span class="summary_desc"><div class='inline'><p>Computing feature contributions is disabled by default.</p>
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>Computing feature contributions is disabled by default.</p>
142
144
  </div></span>
143
145
 
144
146
  </li>
@@ -166,7 +168,8 @@
166
168
 
167
169
 
168
170
 
169
- <span class="summary_desc"><div class='inline'><p>If your model is a binary classifier, use this field to make predictions using a threshold chosen on the tuning page of the app.</p>
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>If your model is a binary classifier, use this field to make predictions using a threshold chosen on the tuning page of the app.</p>
170
173
  </div></span>
171
174
 
172
175
  </li>
@@ -204,7 +207,8 @@
204
207
 
205
208
 
206
209
 
207
- <span class="summary_desc"><div class='inline'><p>A new instance of PredictOptions.</p>
210
+ <span class="summary_desc"><div class='inline'>
211
+ <p>A new instance of PredictOptions.</p>
208
212
  </div></span>
209
213
 
210
214
  </li>
@@ -249,7 +253,8 @@
249
253
 
250
254
  </h3><div class="docstring">
251
255
  <div class="discussion">
252
- <p>Returns a new instance of PredictOptions.</p>
256
+
257
+ <p>Returns a new instance of PredictOptions.</p>
253
258
 
254
259
 
255
260
  </div>
@@ -298,7 +303,8 @@
298
303
 
299
304
  </h3><div class="docstring">
300
305
  <div class="discussion">
301
- <p>Computing feature contributions is disabled by default. If you set this field to <code>true</code>, you will be able to access the feature contributions with the <code>feature_contributions</code> field of the predict output.</p>
306
+
307
+ <p>Computing feature contributions is disabled by default. If you set this field to <code>true</code>, you will be able to access the feature contributions with the <code>feature_contributions</code> field of the predict output.</p>
302
308
 
303
309
 
304
310
  </div>
@@ -340,7 +346,8 @@
340
346
 
341
347
  </h3><div class="docstring">
342
348
  <div class="discussion">
343
- <p>If your model is a binary classifier, use this field to make predictions using a threshold chosen on the tuning page of the app. The default value is <code>0.5</code>.</p>
349
+
350
+ <p>If your model is a binary classifier, use this field to make predictions using a threshold chosen on the tuning page of the app. The default value is <code>0.5</code>.</p>
344
351
 
345
352
 
346
353
  </div>
@@ -411,9 +418,9 @@
411
418
  </div>
412
419
 
413
420
  <div id="footer">
414
- Generated on Thu Jul 15 14:34:33 2021 by
421
+ Generated on Mon Jul 26 14:54:00 2021 by
415
422
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
416
- 0.9.26 (ruby-2.7.3).
423
+ 0.9.26 (ruby-2.7.4).
417
424
  </div>
418
425
 
419
426
  </div>
@@ -101,7 +101,8 @@
101
101
 
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
- <p><code>predict</code> outputs <code>RegressionPredictOutput</code> when the model&#39;s task is regression.</p>
104
+
105
+ <p><code>predict</code> outputs <code>RegressionPredictOutput</code> when the model&#39;s task is regression.</p>
105
106
 
106
107
 
107
108
  </div>
@@ -138,7 +139,8 @@
138
139
 
139
140
 
140
141
 
141
- <span class="summary_desc"><div class='inline'><p>If computing feature contributions was enabled in the predict options, this value will explain the model&#39;s output, showing how much each feature contributed to the output.</p>
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>If computing feature contributions was enabled in the predict options, this value will explain the model&#39;s output, showing how much each feature contributed to the output.</p>
142
144
  </div></span>
143
145
 
144
146
  </li>
@@ -166,7 +168,8 @@
166
168
 
167
169
 
168
170
 
169
- <span class="summary_desc"><div class='inline'><p>This is the predicted value.</p>
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>This is the predicted value.</p>
170
173
  </div></span>
171
174
 
172
175
  </li>
@@ -204,7 +207,8 @@
204
207
 
205
208
 
206
209
 
207
- <span class="summary_desc"><div class='inline'><p>A new instance of RegressionPredictOutput.</p>
210
+ <span class="summary_desc"><div class='inline'>
211
+ <p>A new instance of RegressionPredictOutput.</p>
208
212
  </div></span>
209
213
 
210
214
  </li>
@@ -249,7 +253,8 @@
249
253
 
250
254
  </h3><div class="docstring">
251
255
  <div class="discussion">
252
- <p>Returns a new instance of RegressionPredictOutput.</p>
256
+
257
+ <p>Returns a new instance of RegressionPredictOutput.</p>
253
258
 
254
259
 
255
260
  </div>
@@ -298,7 +303,8 @@
298
303
 
299
304
  </h3><div class="docstring">
300
305
  <div class="discussion">
301
- <p>If computing feature contributions was enabled in the predict options, this value will explain the model&#39;s output, showing how much each feature contributed to the output.</p>
306
+
307
+ <p>If computing feature contributions was enabled in the predict options, this value will explain the model&#39;s output, showing how much each feature contributed to the output.</p>
302
308
 
303
309
 
304
310
  </div>
@@ -340,7 +346,8 @@
340
346
 
341
347
  </h3><div class="docstring">
342
348
  <div class="discussion">
343
- <p>This is the predicted value.</p>
349
+
350
+ <p>This is the predicted value.</p>
344
351
 
345
352
 
346
353
  </div>
@@ -411,9 +418,9 @@
411
418
  </div>
412
419
 
413
420
  <div id="footer">
414
- Generated on Thu Jul 15 14:34:33 2021 by
421
+ Generated on Mon Jul 26 14:54:00 2021 by
415
422
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
416
- 0.9.26 (ruby-2.7.3).
423
+ 0.9.26 (ruby-2.7.4).
417
424
  </div>
418
425
 
419
426
  </div>