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.
- checksums.yaml +7 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +15 -0
- data/LICENSE +21 -0
- data/README.md +36 -0
- data/docs/Tangram/BagOfWordsCosineSimilarityFeatureContribution.html +518 -0
- data/docs/Tangram/BagOfWordsFeatureContribution.html +518 -0
- data/docs/Tangram/Bigram.html +370 -0
- data/docs/Tangram/BinaryClassificationPredictOutput.html +502 -0
- data/docs/Tangram/FeatureContributions.html +444 -0
- data/docs/Tangram/IdentityFeatureContribution.html +444 -0
- data/docs/Tangram/LibTangram/TangramStringView.html +193 -0
- data/docs/Tangram/LibTangram.html +161 -0
- data/docs/Tangram/LoadModelOptions.html +296 -0
- data/docs/Tangram/Model.html +1290 -0
- data/docs/Tangram/MulticlassClassificationPredictOutput.html +576 -0
- data/docs/Tangram/NormalizedFeatureContribution.html +444 -0
- data/docs/Tangram/OneHotEncodedFeatureContribution.html +518 -0
- data/docs/Tangram/PredictOptions.html +428 -0
- data/docs/Tangram/RegressionPredictOutput.html +428 -0
- data/docs/Tangram/Unigram.html +296 -0
- data/docs/Tangram/WordEmbeddingFeatureContribution.html +444 -0
- data/docs/Tangram.html +128 -0
- data/docs/_index.html +317 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +497 -0
- data/docs/file.README.html +107 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +107 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +595 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/modelfox/libmodelfox/aarch64-linux-gnu/libmodelfox.so +0 -0
- data/lib/modelfox/libmodelfox/aarch64-linux-musl/libmodelfox.so +0 -0
- data/lib/modelfox/libmodelfox/aarch64-macos/libmodelfox.dylib +0 -0
- data/lib/modelfox/libmodelfox/x86_64-linux-gnu/libmodelfox.so +0 -0
- data/lib/modelfox/libmodelfox/x86_64-linux-musl/libmodelfox.so +0 -0
- data/lib/modelfox/libmodelfox/x86_64-macos/libmodelfox.dylib +0 -0
- data/lib/modelfox/libmodelfox/x86_64-windows-msvc/modelfox.dll +0 -0
- data/lib/modelfox/modelfox.rb +895 -0
- data/lib/modelfox.rb +1 -0
- data/modelfox.gemspec +15 -0
- data/scripts/build +11 -0
- data/scripts/dev +6 -0
- data/scripts/docs +2 -0
- data/scripts/fmt +0 -0
- data/scripts/release +1 -0
- metadata +109 -0
|
@@ -0,0 +1,444 @@
|
|
|
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::FeatureContributions
|
|
8
|
+
|
|
9
|
+
— 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::FeatureContributions";
|
|
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 (F)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Tangram.html" title="Tangram (module)">Tangram</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">FeatureContributions</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::FeatureContributions
|
|
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::FeatureContributions</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 is a description of the feature contributions for the prediction if the task is regression or binary classification, or for a single class if the task is multiclass classification.</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="#baseline-instance_method" title="#baseline (instance method)">#<strong>baseline</strong> ⇒ 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 value the model would output if all features had baseline values.</p>
|
|
144
|
+
</div></span>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<li class="public ">
|
|
150
|
+
<span class="summary_signature">
|
|
151
|
+
|
|
152
|
+
<a href="#entries-instance_method" title="#entries (instance method)">#<strong>entries</strong> ⇒ 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 list will contain one entry for each of the model's features.</p>
|
|
173
|
+
</div></span>
|
|
174
|
+
|
|
175
|
+
</li>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<li class="public ">
|
|
179
|
+
<span class="summary_signature">
|
|
180
|
+
|
|
181
|
+
<a href="#output-instance_method" title="#output (instance method)">#<strong>output</strong> ⇒ 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 value the model output.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</ul>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<h2>
|
|
214
|
+
Instance Method Summary
|
|
215
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
216
|
+
</h2>
|
|
217
|
+
|
|
218
|
+
<ul class="summary">
|
|
219
|
+
|
|
220
|
+
<li class="public ">
|
|
221
|
+
<span class="summary_signature">
|
|
222
|
+
|
|
223
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(baseline:, output:, entries:) ⇒ FeatureContributions </a>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
</span>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class="note title constructor">constructor</span>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<span class="summary_desc"><div class='inline'>
|
|
240
|
+
<p>A new instance of FeatureContributions.</p>
|
|
241
|
+
</div></span>
|
|
242
|
+
|
|
243
|
+
</li>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
</ul>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<div id="constructor_details" class="method_details_list">
|
|
250
|
+
<h2>Constructor Details</h2>
|
|
251
|
+
|
|
252
|
+
<div class="method_details first">
|
|
253
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
254
|
+
|
|
255
|
+
#<strong>initialize</strong>(baseline:, output:, entries:) ⇒ <tt><span class='object_link'><a href="" title="Tangram::FeatureContributions (class)">FeatureContributions</a></span></tt>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
</h3><div class="docstring">
|
|
262
|
+
<div class="discussion">
|
|
263
|
+
|
|
264
|
+
<p>Returns a new instance of FeatureContributions.</p>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
</div>
|
|
268
|
+
</div>
|
|
269
|
+
<div class="tags">
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
</div><table class="source_code">
|
|
273
|
+
<tr>
|
|
274
|
+
<td>
|
|
275
|
+
<pre class="lines">
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
96
|
|
279
|
+
97
|
|
280
|
+
98
|
|
281
|
+
99
|
|
282
|
+
100</pre>
|
|
283
|
+
</td>
|
|
284
|
+
<td>
|
|
285
|
+
<pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 96</span>
|
|
286
|
+
|
|
287
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>baseline:</span><span class='comma'>,</span> <span class='label'>output:</span><span class='comma'>,</span> <span class='label'>entries:</span><span class='rparen'>)</span>
|
|
288
|
+
<span class='ivar'>@baseline</span> <span class='op'>=</span> <span class='id identifier rubyid_baseline'>baseline</span>
|
|
289
|
+
<span class='ivar'>@output</span> <span class='op'>=</span> <span class='id identifier rubyid_output'>output</span>
|
|
290
|
+
<span class='ivar'>@entries</span> <span class='op'>=</span> <span class='id identifier rubyid_entries'>entries</span>
|
|
291
|
+
<span class='kw'>end</span></pre>
|
|
292
|
+
</td>
|
|
293
|
+
</tr>
|
|
294
|
+
</table>
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
</div>
|
|
298
|
+
|
|
299
|
+
<div id="instance_attr_details" class="attr_details">
|
|
300
|
+
<h2>Instance Attribute Details</h2>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<span id=""></span>
|
|
304
|
+
<div class="method_details first">
|
|
305
|
+
<h3 class="signature first" id="baseline-instance_method">
|
|
306
|
+
|
|
307
|
+
#<strong>baseline</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
</h3><div class="docstring">
|
|
314
|
+
<div class="discussion">
|
|
315
|
+
|
|
316
|
+
<p>This is the value the model would output if all features had baseline values.</p>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
</div>
|
|
320
|
+
</div>
|
|
321
|
+
<div class="tags">
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
</div><table class="source_code">
|
|
325
|
+
<tr>
|
|
326
|
+
<td>
|
|
327
|
+
<pre class="lines">
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
91
|
|
331
|
+
92
|
|
332
|
+
93</pre>
|
|
333
|
+
</td>
|
|
334
|
+
<td>
|
|
335
|
+
<pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 91</span>
|
|
336
|
+
|
|
337
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_baseline'>baseline</span>
|
|
338
|
+
<span class='ivar'>@baseline</span>
|
|
339
|
+
<span class='kw'>end</span></pre>
|
|
340
|
+
</td>
|
|
341
|
+
</tr>
|
|
342
|
+
</table>
|
|
343
|
+
</div>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<span id=""></span>
|
|
347
|
+
<div class="method_details ">
|
|
348
|
+
<h3 class="signature " id="entries-instance_method">
|
|
349
|
+
|
|
350
|
+
#<strong>entries</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</h3><div class="docstring">
|
|
357
|
+
<div class="discussion">
|
|
358
|
+
|
|
359
|
+
<p>This list will contain one entry for each of the model's features. Note that features are computed from columns, so there will likely be more features than columns.</p>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
</div>
|
|
363
|
+
</div>
|
|
364
|
+
<div class="tags">
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
</div><table class="source_code">
|
|
368
|
+
<tr>
|
|
369
|
+
<td>
|
|
370
|
+
<pre class="lines">
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
95
|
|
374
|
+
96
|
|
375
|
+
97</pre>
|
|
376
|
+
</td>
|
|
377
|
+
<td>
|
|
378
|
+
<pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 95</span>
|
|
379
|
+
|
|
380
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_entries'>entries</span>
|
|
381
|
+
<span class='ivar'>@entries</span>
|
|
382
|
+
<span class='kw'>end</span></pre>
|
|
383
|
+
</td>
|
|
384
|
+
</tr>
|
|
385
|
+
</table>
|
|
386
|
+
</div>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<span id=""></span>
|
|
390
|
+
<div class="method_details ">
|
|
391
|
+
<h3 class="signature " id="output-instance_method">
|
|
392
|
+
|
|
393
|
+
#<strong>output</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</h3><div class="docstring">
|
|
400
|
+
<div class="discussion">
|
|
401
|
+
|
|
402
|
+
<p>This is the value the model output. Any difference from the <code>baseline_value</code> is because of the deviation of the features from their baseline values.</p>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
</div>
|
|
406
|
+
</div>
|
|
407
|
+
<div class="tags">
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
</div><table class="source_code">
|
|
411
|
+
<tr>
|
|
412
|
+
<td>
|
|
413
|
+
<pre class="lines">
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
93
|
|
417
|
+
94
|
|
418
|
+
95</pre>
|
|
419
|
+
</td>
|
|
420
|
+
<td>
|
|
421
|
+
<pre class="code"><span class="info file"># File 'lib/tangram/tangram.rb', line 93</span>
|
|
422
|
+
|
|
423
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_output'>output</span>
|
|
424
|
+
<span class='ivar'>@output</span>
|
|
425
|
+
<span class='kw'>end</span></pre>
|
|
426
|
+
</td>
|
|
427
|
+
</tr>
|
|
428
|
+
</table>
|
|
429
|
+
</div>
|
|
430
|
+
|
|
431
|
+
</div>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
</div>
|
|
435
|
+
|
|
436
|
+
<div id="footer">
|
|
437
|
+
Generated on Tue Aug 17 17:09:51 2021 by
|
|
438
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
439
|
+
0.9.26 (ruby-2.7.4).
|
|
440
|
+
</div>
|
|
441
|
+
|
|
442
|
+
</div>
|
|
443
|
+
</body>
|
|
444
|
+
</html>
|