/
predictor.html
646 lines (588 loc) · 29.1 KB
/
predictor.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>ktrain.tabular.predictor API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>ktrain.tabular.predictor</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from .. import utils as U
from ..imports import *
from ..predictor import Predictor
from .preprocessor import TabularPreprocessor
class TabularPredictor(Predictor):
"""
```
predictions for tabular data
```
"""
def __init__(self, model, preproc, batch_size=U.DEFAULT_BS):
if not isinstance(model, keras.Model):
raise ValueError("model must be of instance keras.Model")
if (
not isinstance(preproc, TabularPreprocessor)
and type(preproc).__name__ != "TabularPreprocessor"
):
raise ValueError("preproc must be a TabularPreprocessor object")
self.model = model
self.preproc = preproc
self.c = self.preproc.get_classes()
self.batch_size = batch_size
def get_classes(self):
return self.c
def predict(self, df, return_proba=False):
"""
```
Makes predictions for a test dataframe
Args:
df(pd.DataFrame): a pandas DataFrame in same format as DataFrame used for training model
return_proba(bool): If True, return probabilities instead of predicted class labels
```
"""
if not isinstance(df, pd.DataFrame):
raise ValueError("df must be a pd.DataFrame")
df = df.copy()
classification, multilabel = U.is_classifier(self.model)
# get predictions
tseq = self.preproc.preprocess_test(df, verbose=0)
tseq.batch_size = self.batch_size
preds = self.model.predict(tseq)
result = (
preds
if return_proba or multilabel or not self.c
else [self.c[np.argmax(pred)] for pred in preds]
)
if multilabel and not return_proba:
result = [list(zip(self.c, r)) for r in result]
return result
def _predict_shap(self, X):
n_cats = len(self.preproc.cat_names)
n_conts = len(self.preproc.cont_names)
# reformat for model
batch_x = [X[:, i : i + 1] for i in range(n_cats)] + [X[:, -n_conts:]]
result = self.model.predict(batch_x)
return result
def explain(
self,
test_df,
row_index=None,
row_num=None,
class_id=None,
background_size=50,
nsamples=500,
):
"""
```
Explain the prediction of an example using SHAP.
Args:
df(pd.DataFrame): a pd.DataFrame of test data is same format as original training data DataFrame
The DataFrame does NOT need to contain all the original label columns
(e.g., the Survived column in Kaggle's Titatnic dataset) but MUST contain
all the original predictor columns (e.g., un-normalized numerical variables, categorical
variables as strings).
row_index(int): index of row in DataFrame to explain (e.g., PassengerID in Titanic dataset).
mutually-exclusive with row_id
row_num(int): raw row number in DataFrame to explain (i.e., 0=first row, 1=second rows, etc.)
mutually-exclusive with row_index
class_id(int): Only required for classification
background_size(int): size of background data (SHAP parameter)
nsamples(int): number of samples (SHAP parameter)
```
"""
try:
import shap
except ImportError:
msg = (
"TabularPredictor.explain requires shap library. Please install with: pip install shap. "
+ "Conda users should use this command instead: conda install -c conda-forge shap"
)
warnings.warn(msg)
return
classification, multilabel = U.is_classifier(self.model)
if classification and class_id is None:
raise ValueError(
"For classification models, please supply the class_id of the class you would like to explain."
+ "It should be an index into the list returned by predictor.get_classes()."
)
f = self._predict_shap
# prune dataframe
df_display = test_df.copy()
df_display = df_display[self.preproc.pc]
# add synthetic labels
for lab in self.preproc.lc:
df_display[lab] = np.zeros(df_display.shape[0], dtype=int)
# convert DataFrame to TabularDataset with processed/normalized independent variables
tabseq = self.preproc.preprocess_test(df_display, verbose=0)
tabseq.batch_size = df_display.shape[0]
df = pd.DataFrame(
data=np.concatenate(tabseq[0][0], axis=1),
columns=tabseq.cat_columns + tabseq.cont_columns,
index=df_display.index,
)
# add new auto-engineered feature columns
for col in [self.preproc.na_names + self.preproc.date_names]:
df_display[col] = df[col]
# sort display df correctly
df_display = df_display[tabseq.cat_columns + tabseq.cont_columns]
# select row
if row_num is not None and row_index is not None:
raise ValueError(
"row_num and row_index are mutually exclusive with eachother."
)
if row_index is not None:
df_row = df[df.index.isin([row_index])].iloc[0, :]
df_display_row = df_display[df_display.index.isin([row_index])].iloc[0, :]
r_key = "row_index" if df.index.name is None else df.index.name
r_val = row_index
elif row_num is not None:
df_row = df.iloc[row_num, :]
df_display_row = df_display.iloc[row_num, :]
r_key = "row_num"
r_val = row_num
# print(df_row)
# print(df_display_row)
# shap
explainer = shap.KernelExplainer(f, df.iloc[:background_size, :])
shap_values = explainer.shap_values(df_row, nsamples=nsamples, l1_reg="aic")
expected_value = explainer.expected_value
if not np.issubdtype(type(explainer.expected_value), np.floating):
expected_value = explainer.expected_value[
0 if class_id is None else class_id
]
if type(shap_values) == list:
shap_values = shap_values[0 if class_id is None else class_id]
if classification:
print(
"Explanation for class = %s (%s=%s): "
% (self.get_classes()[class_id], r_key, r_val)
)
plt.show(
shap.force_plot(
expected_value, shap_values, df_display_row, matplotlib=True
)
)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="ktrain.tabular.predictor.TabularPredictor"><code class="flex name class">
<span>class <span class="ident">TabularPredictor</span></span>
<span>(</span><span>model, preproc, batch_size=32)</span>
</code></dt>
<dd>
<div class="desc"><pre><code>predictions for tabular data
</code></pre></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class TabularPredictor(Predictor):
"""
```
predictions for tabular data
```
"""
def __init__(self, model, preproc, batch_size=U.DEFAULT_BS):
if not isinstance(model, keras.Model):
raise ValueError("model must be of instance keras.Model")
if (
not isinstance(preproc, TabularPreprocessor)
and type(preproc).__name__ != "TabularPreprocessor"
):
raise ValueError("preproc must be a TabularPreprocessor object")
self.model = model
self.preproc = preproc
self.c = self.preproc.get_classes()
self.batch_size = batch_size
def get_classes(self):
return self.c
def predict(self, df, return_proba=False):
"""
```
Makes predictions for a test dataframe
Args:
df(pd.DataFrame): a pandas DataFrame in same format as DataFrame used for training model
return_proba(bool): If True, return probabilities instead of predicted class labels
```
"""
if not isinstance(df, pd.DataFrame):
raise ValueError("df must be a pd.DataFrame")
df = df.copy()
classification, multilabel = U.is_classifier(self.model)
# get predictions
tseq = self.preproc.preprocess_test(df, verbose=0)
tseq.batch_size = self.batch_size
preds = self.model.predict(tseq)
result = (
preds
if return_proba or multilabel or not self.c
else [self.c[np.argmax(pred)] for pred in preds]
)
if multilabel and not return_proba:
result = [list(zip(self.c, r)) for r in result]
return result
def _predict_shap(self, X):
n_cats = len(self.preproc.cat_names)
n_conts = len(self.preproc.cont_names)
# reformat for model
batch_x = [X[:, i : i + 1] for i in range(n_cats)] + [X[:, -n_conts:]]
result = self.model.predict(batch_x)
return result
def explain(
self,
test_df,
row_index=None,
row_num=None,
class_id=None,
background_size=50,
nsamples=500,
):
"""
```
Explain the prediction of an example using SHAP.
Args:
df(pd.DataFrame): a pd.DataFrame of test data is same format as original training data DataFrame
The DataFrame does NOT need to contain all the original label columns
(e.g., the Survived column in Kaggle's Titatnic dataset) but MUST contain
all the original predictor columns (e.g., un-normalized numerical variables, categorical
variables as strings).
row_index(int): index of row in DataFrame to explain (e.g., PassengerID in Titanic dataset).
mutually-exclusive with row_id
row_num(int): raw row number in DataFrame to explain (i.e., 0=first row, 1=second rows, etc.)
mutually-exclusive with row_index
class_id(int): Only required for classification
background_size(int): size of background data (SHAP parameter)
nsamples(int): number of samples (SHAP parameter)
```
"""
try:
import shap
except ImportError:
msg = (
"TabularPredictor.explain requires shap library. Please install with: pip install shap. "
+ "Conda users should use this command instead: conda install -c conda-forge shap"
)
warnings.warn(msg)
return
classification, multilabel = U.is_classifier(self.model)
if classification and class_id is None:
raise ValueError(
"For classification models, please supply the class_id of the class you would like to explain."
+ "It should be an index into the list returned by predictor.get_classes()."
)
f = self._predict_shap
# prune dataframe
df_display = test_df.copy()
df_display = df_display[self.preproc.pc]
# add synthetic labels
for lab in self.preproc.lc:
df_display[lab] = np.zeros(df_display.shape[0], dtype=int)
# convert DataFrame to TabularDataset with processed/normalized independent variables
tabseq = self.preproc.preprocess_test(df_display, verbose=0)
tabseq.batch_size = df_display.shape[0]
df = pd.DataFrame(
data=np.concatenate(tabseq[0][0], axis=1),
columns=tabseq.cat_columns + tabseq.cont_columns,
index=df_display.index,
)
# add new auto-engineered feature columns
for col in [self.preproc.na_names + self.preproc.date_names]:
df_display[col] = df[col]
# sort display df correctly
df_display = df_display[tabseq.cat_columns + tabseq.cont_columns]
# select row
if row_num is not None and row_index is not None:
raise ValueError(
"row_num and row_index are mutually exclusive with eachother."
)
if row_index is not None:
df_row = df[df.index.isin([row_index])].iloc[0, :]
df_display_row = df_display[df_display.index.isin([row_index])].iloc[0, :]
r_key = "row_index" if df.index.name is None else df.index.name
r_val = row_index
elif row_num is not None:
df_row = df.iloc[row_num, :]
df_display_row = df_display.iloc[row_num, :]
r_key = "row_num"
r_val = row_num
# print(df_row)
# print(df_display_row)
# shap
explainer = shap.KernelExplainer(f, df.iloc[:background_size, :])
shap_values = explainer.shap_values(df_row, nsamples=nsamples, l1_reg="aic")
expected_value = explainer.expected_value
if not np.issubdtype(type(explainer.expected_value), np.floating):
expected_value = explainer.expected_value[
0 if class_id is None else class_id
]
if type(shap_values) == list:
shap_values = shap_values[0 if class_id is None else class_id]
if classification:
print(
"Explanation for class = %s (%s=%s): "
% (self.get_classes()[class_id], r_key, r_val)
)
plt.show(
shap.force_plot(
expected_value, shap_values, df_display_row, matplotlib=True
)
)</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="ktrain.predictor.Predictor" href="../predictor.html#ktrain.predictor.Predictor">Predictor</a></li>
<li>abc.ABC</li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="ktrain.tabular.predictor.TabularPredictor.explain"><code class="name flex">
<span>def <span class="ident">explain</span></span>(<span>self, test_df, row_index=None, row_num=None, class_id=None, background_size=50, nsamples=500)</span>
</code></dt>
<dd>
<div class="desc"><pre><code>Explain the prediction of an example using SHAP.
Args:
df(pd.DataFrame): a pd.DataFrame of test data is same format as original training data DataFrame
The DataFrame does NOT need to contain all the original label columns
(e.g., the Survived column in Kaggle's Titatnic dataset) but MUST contain
all the original predictor columns (e.g., un-normalized numerical variables, categorical
variables as strings).
row_index(int): index of row in DataFrame to explain (e.g., PassengerID in Titanic dataset).
mutually-exclusive with row_id
row_num(int): raw row number in DataFrame to explain (i.e., 0=first row, 1=second rows, etc.)
mutually-exclusive with row_index
class_id(int): Only required for classification
background_size(int): size of background data (SHAP parameter)
nsamples(int): number of samples (SHAP parameter)
</code></pre></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def explain(
self,
test_df,
row_index=None,
row_num=None,
class_id=None,
background_size=50,
nsamples=500,
):
"""
```
Explain the prediction of an example using SHAP.
Args:
df(pd.DataFrame): a pd.DataFrame of test data is same format as original training data DataFrame
The DataFrame does NOT need to contain all the original label columns
(e.g., the Survived column in Kaggle's Titatnic dataset) but MUST contain
all the original predictor columns (e.g., un-normalized numerical variables, categorical
variables as strings).
row_index(int): index of row in DataFrame to explain (e.g., PassengerID in Titanic dataset).
mutually-exclusive with row_id
row_num(int): raw row number in DataFrame to explain (i.e., 0=first row, 1=second rows, etc.)
mutually-exclusive with row_index
class_id(int): Only required for classification
background_size(int): size of background data (SHAP parameter)
nsamples(int): number of samples (SHAP parameter)
```
"""
try:
import shap
except ImportError:
msg = (
"TabularPredictor.explain requires shap library. Please install with: pip install shap. "
+ "Conda users should use this command instead: conda install -c conda-forge shap"
)
warnings.warn(msg)
return
classification, multilabel = U.is_classifier(self.model)
if classification and class_id is None:
raise ValueError(
"For classification models, please supply the class_id of the class you would like to explain."
+ "It should be an index into the list returned by predictor.get_classes()."
)
f = self._predict_shap
# prune dataframe
df_display = test_df.copy()
df_display = df_display[self.preproc.pc]
# add synthetic labels
for lab in self.preproc.lc:
df_display[lab] = np.zeros(df_display.shape[0], dtype=int)
# convert DataFrame to TabularDataset with processed/normalized independent variables
tabseq = self.preproc.preprocess_test(df_display, verbose=0)
tabseq.batch_size = df_display.shape[0]
df = pd.DataFrame(
data=np.concatenate(tabseq[0][0], axis=1),
columns=tabseq.cat_columns + tabseq.cont_columns,
index=df_display.index,
)
# add new auto-engineered feature columns
for col in [self.preproc.na_names + self.preproc.date_names]:
df_display[col] = df[col]
# sort display df correctly
df_display = df_display[tabseq.cat_columns + tabseq.cont_columns]
# select row
if row_num is not None and row_index is not None:
raise ValueError(
"row_num and row_index are mutually exclusive with eachother."
)
if row_index is not None:
df_row = df[df.index.isin([row_index])].iloc[0, :]
df_display_row = df_display[df_display.index.isin([row_index])].iloc[0, :]
r_key = "row_index" if df.index.name is None else df.index.name
r_val = row_index
elif row_num is not None:
df_row = df.iloc[row_num, :]
df_display_row = df_display.iloc[row_num, :]
r_key = "row_num"
r_val = row_num
# print(df_row)
# print(df_display_row)
# shap
explainer = shap.KernelExplainer(f, df.iloc[:background_size, :])
shap_values = explainer.shap_values(df_row, nsamples=nsamples, l1_reg="aic")
expected_value = explainer.expected_value
if not np.issubdtype(type(explainer.expected_value), np.floating):
expected_value = explainer.expected_value[
0 if class_id is None else class_id
]
if type(shap_values) == list:
shap_values = shap_values[0 if class_id is None else class_id]
if classification:
print(
"Explanation for class = %s (%s=%s): "
% (self.get_classes()[class_id], r_key, r_val)
)
plt.show(
shap.force_plot(
expected_value, shap_values, df_display_row, matplotlib=True
)
)</code></pre>
</details>
</dd>
<dt id="ktrain.tabular.predictor.TabularPredictor.get_classes"><code class="name flex">
<span>def <span class="ident">get_classes</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_classes(self):
return self.c</code></pre>
</details>
</dd>
<dt id="ktrain.tabular.predictor.TabularPredictor.predict"><code class="name flex">
<span>def <span class="ident">predict</span></span>(<span>self, df, return_proba=False)</span>
</code></dt>
<dd>
<div class="desc"><pre><code>Makes predictions for a test dataframe
Args:
df(pd.DataFrame): a pandas DataFrame in same format as DataFrame used for training model
return_proba(bool): If True, return probabilities instead of predicted class labels
</code></pre></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def predict(self, df, return_proba=False):
"""
```
Makes predictions for a test dataframe
Args:
df(pd.DataFrame): a pandas DataFrame in same format as DataFrame used for training model
return_proba(bool): If True, return probabilities instead of predicted class labels
```
"""
if not isinstance(df, pd.DataFrame):
raise ValueError("df must be a pd.DataFrame")
df = df.copy()
classification, multilabel = U.is_classifier(self.model)
# get predictions
tseq = self.preproc.preprocess_test(df, verbose=0)
tseq.batch_size = self.batch_size
preds = self.model.predict(tseq)
result = (
preds
if return_proba or multilabel or not self.c
else [self.c[np.argmax(pred)] for pred in preds]
)
if multilabel and not return_proba:
result = [list(zip(self.c, r)) for r in result]
return result</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="ktrain.predictor.Predictor" href="../predictor.html#ktrain.predictor.Predictor">Predictor</a></b></code>:
<ul class="hlist">
<li><code><a title="ktrain.predictor.Predictor.create_onnx_session" href="../predictor.html#ktrain.predictor.Predictor.create_onnx_session">create_onnx_session</a></code></li>
<li><code><a title="ktrain.predictor.Predictor.export_model_to_onnx" href="../predictor.html#ktrain.predictor.Predictor.export_model_to_onnx">export_model_to_onnx</a></code></li>
<li><code><a title="ktrain.predictor.Predictor.export_model_to_tflite" href="../predictor.html#ktrain.predictor.Predictor.export_model_to_tflite">export_model_to_tflite</a></code></li>
<li><code><a title="ktrain.predictor.Predictor.save" href="../predictor.html#ktrain.predictor.Predictor.save">save</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="ktrain.tabular" href="index.html">ktrain.tabular</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="ktrain.tabular.predictor.TabularPredictor" href="#ktrain.tabular.predictor.TabularPredictor">TabularPredictor</a></code></h4>
<ul class="">
<li><code><a title="ktrain.tabular.predictor.TabularPredictor.explain" href="#ktrain.tabular.predictor.TabularPredictor.explain">explain</a></code></li>
<li><code><a title="ktrain.tabular.predictor.TabularPredictor.get_classes" href="#ktrain.tabular.predictor.TabularPredictor.get_classes">get_classes</a></code></li>
<li><code><a title="ktrain.tabular.predictor.TabularPredictor.predict" href="#ktrain.tabular.predictor.TabularPredictor.predict">predict</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>