modelfox 0.8.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 (53) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +3 -0
  3. data/Gemfile.lock +15 -0
  4. data/LICENSE +21 -0
  5. data/README.md +36 -0
  6. data/docs/Tangram/BagOfWordsCosineSimilarityFeatureContribution.html +518 -0
  7. data/docs/Tangram/BagOfWordsFeatureContribution.html +518 -0
  8. data/docs/Tangram/Bigram.html +370 -0
  9. data/docs/Tangram/BinaryClassificationPredictOutput.html +502 -0
  10. data/docs/Tangram/FeatureContributions.html +444 -0
  11. data/docs/Tangram/IdentityFeatureContribution.html +444 -0
  12. data/docs/Tangram/LibTangram/TangramStringView.html +193 -0
  13. data/docs/Tangram/LibTangram.html +161 -0
  14. data/docs/Tangram/LoadModelOptions.html +296 -0
  15. data/docs/Tangram/Model.html +1290 -0
  16. data/docs/Tangram/MulticlassClassificationPredictOutput.html +576 -0
  17. data/docs/Tangram/NormalizedFeatureContribution.html +444 -0
  18. data/docs/Tangram/OneHotEncodedFeatureContribution.html +518 -0
  19. data/docs/Tangram/PredictOptions.html +428 -0
  20. data/docs/Tangram/RegressionPredictOutput.html +428 -0
  21. data/docs/Tangram/Unigram.html +296 -0
  22. data/docs/Tangram/WordEmbeddingFeatureContribution.html +444 -0
  23. data/docs/Tangram.html +128 -0
  24. data/docs/_index.html +317 -0
  25. data/docs/class_list.html +51 -0
  26. data/docs/css/common.css +1 -0
  27. data/docs/css/full_list.css +58 -0
  28. data/docs/css/style.css +497 -0
  29. data/docs/file.README.html +107 -0
  30. data/docs/file_list.html +56 -0
  31. data/docs/frames.html +17 -0
  32. data/docs/index.html +107 -0
  33. data/docs/js/app.js +314 -0
  34. data/docs/js/full_list.js +216 -0
  35. data/docs/js/jquery.js +4 -0
  36. data/docs/method_list.html +595 -0
  37. data/docs/top-level-namespace.html +110 -0
  38. data/lib/modelfox/libmodelfox/aarch64-linux-gnu/libmodelfox.so +0 -0
  39. data/lib/modelfox/libmodelfox/aarch64-linux-musl/libmodelfox.so +0 -0
  40. data/lib/modelfox/libmodelfox/aarch64-macos/libmodelfox.dylib +0 -0
  41. data/lib/modelfox/libmodelfox/x86_64-linux-gnu/libmodelfox.so +0 -0
  42. data/lib/modelfox/libmodelfox/x86_64-linux-musl/libmodelfox.so +0 -0
  43. data/lib/modelfox/libmodelfox/x86_64-macos/libmodelfox.dylib +0 -0
  44. data/lib/modelfox/libmodelfox/x86_64-windows-msvc/modelfox.dll +0 -0
  45. data/lib/modelfox/modelfox.rb +895 -0
  46. data/lib/modelfox.rb +1 -0
  47. data/modelfox.gemspec +15 -0
  48. data/scripts/build +11 -0
  49. data/scripts/dev +6 -0
  50. data/scripts/docs +2 -0
  51. data/scripts/fmt +0 -0
  52. data/scripts/release +1 -0
  53. metadata +109 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 658ac6d94bd1d1ebf2865e1e6fa54565b4eadb80bd42b5c7b56bb4c895b539b5
4
+ data.tar.gz: 5b88fe23eff4599a70d6f77dcaf8439713f9a53db5833d8c1518d81ce4f63343
5
+ SHA512:
6
+ metadata.gz: c09ad57c1a7d71b01f01d8652f98e5a6f7e29bbcabe987a4e694f12174c38298e2db1ff3dee5202325ccaa49b4b3acc3e7fbb8c7fc8042e5eb3d0db836223866
7
+ data.tar.gz: 0c524ef5bf15f40db1109117e6e3d00618e637a5355dea6249467698c686b1000c6960b0ae7adc55c0cfb8e19d240e396a30bfb46a3ba6cb462b3c7609f66d7b
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source 'https://rubygems.org'
2
+ gem 'redcarpet'
3
+ gem 'yard'
data/Gemfile.lock ADDED
@@ -0,0 +1,15 @@
1
+ GEM
2
+ remote: https://rubygems.org/
3
+ specs:
4
+ redcarpet (3.5.1)
5
+ yard (0.9.26)
6
+
7
+ PLATFORMS
8
+ ruby
9
+
10
+ DEPENDENCIES
11
+ redcarpet
12
+ yard
13
+
14
+ BUNDLED WITH
15
+ 2.1.4
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020 ModelFox, Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,36 @@
1
+ # ModelFox for Ruby
2
+
3
+ - [Watch the Video](https://www.modelfox.dev)
4
+ - [Read the Docs](https://www.modelfox.dev/docs)
5
+
6
+ The ModelFox Ruby library makes it easy to make predictions with your ModelFox machine learning model from Ruby.
7
+
8
+ ## Usage
9
+
10
+ ```
11
+ $ gem install modelfox
12
+ ```
13
+
14
+ ```ruby
15
+ require 'modelfox'
16
+
17
+ model = ModelFox::Model.from_path('./heart_disease.modelfox')
18
+
19
+ input = {
20
+ age: 63,
21
+ gender: 'male',
22
+ # ...
23
+ }
24
+
25
+ output = model.predict(input)
26
+ ```
27
+
28
+ For more information, [read the docs](https://www.modelfox.dev/docs).
29
+
30
+ ## Platform Support
31
+
32
+ ModelFox 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/modelfoxdotdev/modelfox/issues/new) or send us an email at [help@modelfox.dev](mailto:help@modelfox.dev).
33
+
34
+ ## Examples
35
+
36
+ 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/BagOfWordsCosineSimilarityFeatureContribution.html ADDED
@@ -0,0 +1,518 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Tangram::BagOfWordsCosineSimilarityFeatureContribution
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Tangram::BagOfWordsCosineSimilarityFeatureContribution";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (B)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Tangram.html" title="Tangram (module)">Tangram</a></span></span>
41
+ &raquo;
42
+ <span class="title">BagOfWordsCosineSimilarityFeatureContribution</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Tangram::BagOfWordsCosineSimilarityFeatureContribution
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Tangram::BagOfWordsCosineSimilarityFeatureContribution</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/tangram/tangram.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>This describes the contribution of a feature from a bag of words cosine similarity feature group.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#column_name_a-instance_method" title="#column_name_a (instance method)">#<strong>column_name_a</strong> &#x21d2; Object </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+ <span class="note title readonly">readonly</span>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>This is the name of the source column a for the feature group.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#column_name_b-instance_method" title="#column_name_b (instance method)">#<strong>column_name_b</strong> &#x21d2; Object </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+ <span class="note title readonly">readonly</span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>This is the name of the source column b for the feature group.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#feature_contribution_value-instance_method" title="#feature_contribution_value (instance method)">#<strong>feature_contribution_value</strong> &#x21d2; Object </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+ <span class="note title readonly">readonly</span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>This is the amount that the feature contributed to the output.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#feature_value-instance_method" title="#feature_value (instance method)">#<strong>feature_value</strong> &#x21d2; Object </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+ <span class="note title readonly">readonly</span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>This is the value of the feature.</p>
231
+ </div></span>
232
+
233
+ </li>
234
+
235
+
236
+ </ul>
237
+
238
+
239
+
240
+
241
+
242
+ <h2>
243
+ Instance Method Summary
244
+ <small><a href="#" class="summary_toggle">collapse</a></small>
245
+ </h2>
246
+
247
+ <ul class="summary">
248
+
249
+ <li class="public ">
250
+ <span class="summary_signature">
251
+
252
+ <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>
253
+
254
+
255
+
256
+ </span>
257
+
258
+
259
+ <span class="note title constructor">constructor</span>
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+ <span class="summary_desc"><div class='inline'>
269
+ <p>A new instance of BagOfWordsCosineSimilarityFeatureContribution.</p>
270
+ </div></span>
271
+
272
+ </li>
273
+
274
+
275
+ </ul>
276
+
277
+
278
+ <div id="constructor_details" class="method_details_list">
279
+ <h2>Constructor Details</h2>
280
+
281
+ <div class="method_details first">
282
+ <h3 class="signature first" id="initialize-instance_method">
283
+
284
+ #<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>
285
+
286
+
287
+
288
+
289
+
290
+ </h3><div class="docstring">
291
+ <div class="discussion">
292
+
293
+ <p>Returns a new instance of BagOfWordsCosineSimilarityFeatureContribution.</p>
294
+
295
+
296
+ </div>
297
+ </div>
298
+ <div class="tags">
299
+
300
+
301
+ </div><table class="source_code">
302
+ <tr>
303
+ <td>
304
+ <pre class="lines">
305
+
306
+
307
+ 200
308
+ 201
309
+ 202
310
+ 203
311
+ 204
312
+ 205</pre>
313
+ </td>
314
+ <td>
315
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 200</span>
316
+
317
+ <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>
318
+ <span class='ivar'>@column_name_a</span> <span class='op'>=</span> <span class='id identifier rubyid_column_name_a'>column_name_a</span>
319
+ <span class='ivar'>@column_name_b</span> <span class='op'>=</span> <span class='id identifier rubyid_column_name_b'>column_name_b</span>
320
+ <span class='ivar'>@feature_contribution_value</span> <span class='op'>=</span> <span class='id identifier rubyid_feature_contribution_value'>feature_contribution_value</span>
321
+ <span class='ivar'>@feature_value</span> <span class='op'>=</span> <span class='id identifier rubyid_feature_value'>feature_value</span>
322
+ <span class='kw'>end</span></pre>
323
+ </td>
324
+ </tr>
325
+ </table>
326
+ </div>
327
+
328
+ </div>
329
+
330
+ <div id="instance_attr_details" class="attr_details">
331
+ <h2>Instance Attribute Details</h2>
332
+
333
+
334
+ <span id=""></span>
335
+ <div class="method_details first">
336
+ <h3 class="signature first" id="column_name_a-instance_method">
337
+
338
+ #<strong>column_name_a</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
339
+
340
+
341
+
342
+
343
+
344
+ </h3><div class="docstring">
345
+ <div class="discussion">
346
+
347
+ <p>This is the name of the source column a for the feature group.</p>
348
+
349
+
350
+ </div>
351
+ </div>
352
+ <div class="tags">
353
+
354
+
355
+ </div><table class="source_code">
356
+ <tr>
357
+ <td>
358
+ <pre class="lines">
359
+
360
+
361
+ 193
362
+ 194
363
+ 195</pre>
364
+ </td>
365
+ <td>
366
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 193</span>
367
+
368
+ <span class='kw'>def</span> <span class='id identifier rubyid_column_name_a'>column_name_a</span>
369
+ <span class='ivar'>@column_name_a</span>
370
+ <span class='kw'>end</span></pre>
371
+ </td>
372
+ </tr>
373
+ </table>
374
+ </div>
375
+
376
+
377
+ <span id=""></span>
378
+ <div class="method_details ">
379
+ <h3 class="signature " id="column_name_b-instance_method">
380
+
381
+ #<strong>column_name_b</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
382
+
383
+
384
+
385
+
386
+
387
+ </h3><div class="docstring">
388
+ <div class="discussion">
389
+
390
+ <p>This is the name of the source column b for the feature group.</p>
391
+
392
+
393
+ </div>
394
+ </div>
395
+ <div class="tags">
396
+
397
+
398
+ </div><table class="source_code">
399
+ <tr>
400
+ <td>
401
+ <pre class="lines">
402
+
403
+
404
+ 195
405
+ 196
406
+ 197</pre>
407
+ </td>
408
+ <td>
409
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 195</span>
410
+
411
+ <span class='kw'>def</span> <span class='id identifier rubyid_column_name_b'>column_name_b</span>
412
+ <span class='ivar'>@column_name_b</span>
413
+ <span class='kw'>end</span></pre>
414
+ </td>
415
+ </tr>
416
+ </table>
417
+ </div>
418
+
419
+
420
+ <span id=""></span>
421
+ <div class="method_details ">
422
+ <h3 class="signature " id="feature_contribution_value-instance_method">
423
+
424
+ #<strong>feature_contribution_value</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
425
+
426
+
427
+
428
+
429
+
430
+ </h3><div class="docstring">
431
+ <div class="discussion">
432
+
433
+ <p>This is the amount that the feature contributed to the output.</p>
434
+
435
+
436
+ </div>
437
+ </div>
438
+ <div class="tags">
439
+
440
+
441
+ </div><table class="source_code">
442
+ <tr>
443
+ <td>
444
+ <pre class="lines">
445
+
446
+
447
+ 199
448
+ 200
449
+ 201</pre>
450
+ </td>
451
+ <td>
452
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 199</span>
453
+
454
+ <span class='kw'>def</span> <span class='id identifier rubyid_feature_contribution_value'>feature_contribution_value</span>
455
+ <span class='ivar'>@feature_contribution_value</span>
456
+ <span class='kw'>end</span></pre>
457
+ </td>
458
+ </tr>
459
+ </table>
460
+ </div>
461
+
462
+
463
+ <span id=""></span>
464
+ <div class="method_details ">
465
+ <h3 class="signature " id="feature_value-instance_method">
466
+
467
+ #<strong>feature_value</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
468
+
469
+
470
+
471
+
472
+
473
+ </h3><div class="docstring">
474
+ <div class="discussion">
475
+
476
+ <p>This is the value of the feature.</p>
477
+
478
+
479
+ </div>
480
+ </div>
481
+ <div class="tags">
482
+
483
+
484
+ </div><table class="source_code">
485
+ <tr>
486
+ <td>
487
+ <pre class="lines">
488
+
489
+
490
+ 197
491
+ 198
492
+ 199</pre>
493
+ </td>
494
+ <td>
495
+ <pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 197</span>
496
+
497
+ <span class='kw'>def</span> <span class='id identifier rubyid_feature_value'>feature_value</span>
498
+ <span class='ivar'>@feature_value</span>
499
+ <span class='kw'>end</span></pre>
500
+ </td>
501
+ </tr>
502
+ </table>
503
+ </div>
504
+
505
+ </div>
506
+
507
+
508
+ </div>
509
+
510
+ <div id="footer">
511
+ Generated on Tue Aug 17 17:09:51 2021 by
512
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
513
+ 0.9.26 (ruby-2.7.4).
514
+ </div>
515
+
516
+ </div>
517
+ </body>
518
+ </html>