forked from fastai/fastai
-
Notifications
You must be signed in to change notification settings - Fork 0
/
metrics.html
1231 lines (866 loc) · 84.9 KB
/
metrics.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
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
title: metrics
keywords: fastai
sidebar: home_sidebar
summary: "Useful metrics for training"
---
<!--
#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: docs_src/metrics.ipynb
# instructions: https://docs.fast.ai/gen_doc_main.html
-->
<div class="container" id="notebook-container">
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Training-metrics">Training metrics<a class="anchor-link" href="#Training-metrics">¶</a></h2>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p><em>Metrics</em> for training fastai models are simply functions that take <code>input</code> and <code>target</code> tensors, and return some metric of interest for training. You can write your own metrics by defining a function of that type, and passing it to <a href="/basic_train.html#Learner"><code>Learner</code></a> in the <a href="/metrics.html#metrics"><code>metrics</code></a> parameter, or use one of the following pre-defined functions.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Predefined-metrics:">Predefined metrics:<a class="anchor-link" href="#Predefined-metrics:">¶</a></h2>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="accuracy" class="doc_header"><code>accuracy</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L25" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#accuracy-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>accuracy</code>(<strong><code>input</code></strong>:<code>Tensor</code>, <strong><code>targs</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="accuracy-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#accuracy-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>accuracy</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_accuracy</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L44" class="source_link" style="float:right">[source]</a></li><li><code>pytest -sv tests/test_vision_train.py::test_accuracy</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_vision_train.py#L41" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Computes accuracy with <code>targs</code> when <code>input</code> is bs * n_classes.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<div markdown="span" class="alert alert-danger" role="alert"><i class="fa fa-danger-circle"></i> <b>Warning: </b>This metric is intended for classification of objects belonging to a single class.</div>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">preds</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.6</span><span class="p">,</span> <span class="mf">0.4</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.9</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">])</span> <span class="c1"># bs = 5, n = 2</span>
<span class="n">ys</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="n">accuracy</span><span class="p">(</span><span class="n">preds</span><span class="p">,</span> <span class="n">ys</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>tensor(0.6000)</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="accuracy_thresh" class="doc_header"><code>accuracy_thresh</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L32" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#accuracy_thresh-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>accuracy_thresh</code>(<strong><code>y_pred</code></strong>:<code>Tensor</code>, <strong><code>y_true</code></strong>:<code>Tensor</code>, <strong><code>thresh</code></strong>:<code>float</code>=<strong><em><code>0.5</code></em></strong>, <strong><code>sigmoid</code></strong>:<code>bool</code>=<strong><em><code>True</code></em></strong>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="accuracy_thresh-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#accuracy_thresh-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>accuracy_thresh</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_accuracy_thresh</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L99" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Computes accuracy when <code>y_pred</code> and <code>y_true</code> are the same size.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Predictions are compared to <code>thresh</code> after <code>sigmoid</code> is maybe applied. Then we count the numbers that match the targets.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>This function is intended for one-hot-encoded targets (often in a multiclassification problem).</div>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">preds</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.6</span><span class="p">,</span> <span class="mf">0.4</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.9</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">])</span>
<span class="n">ys</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span>
<span class="n">accuracy_thresh</span><span class="p">(</span><span class="n">preds</span><span class="p">,</span> <span class="n">ys</span><span class="p">,</span> <span class="n">thresh</span><span class="o">=</span><span class="mf">0.65</span><span class="p">,</span> <span class="n">sigmoid</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>tensor(0.4000)</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="top_k_accuracy" class="doc_header"><code>top_k_accuracy</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L37" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#top_k_accuracy-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>top_k_accuracy</code>(<strong><code>input</code></strong>:<code>Tensor</code>, <strong><code>targs</code></strong>:<code>Tensor</code>, <strong><code>k</code></strong>:<code>int</code>=<strong><em><code>5</code></em></strong>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="top_k_accuracy-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#top_k_accuracy-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>top_k_accuracy</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_top_k_accuracy</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L69" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Computes the Top-k accuracy (target is in the top k predictions).</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="dice" class="doc_header"><code>dice</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L53" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#dice-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>dice</code>(<strong><code>input</code></strong>:<code>Tensor</code>, <strong><code>targs</code></strong>:<code>Tensor</code>, <strong><code>iou</code></strong>:<code>bool</code>=<strong><em><code>False</code></em></strong>, <strong><code>eps</code></strong>:<code>float</code>=<strong><em><code>1e-08</code></em></strong>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="dice-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#dice-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>dice</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_dice</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L108" class="source_link" style="float:right">[source]</a></li><li><code>pytest -sv tests/test_metrics.py::test_dice_iou</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L118" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Dice coefficient metric for binary target. If iou=True, returns iou metric, classic for segmentation problems.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
$$dice = \frac{2(TP)}{2(TP) + FP + FN}$$<p>where TP, FP and FN are the number of true positives, false positives and false negatives.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">preds</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.6</span><span class="p">,</span> <span class="mf">0.4</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.9</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">])</span>
<span class="n">ys</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="n">dice</span><span class="p">(</span><span class="n">preds</span><span class="p">,</span> <span class="n">ys</span><span class="p">)</span> <span class="c1"># TP = 2, FP = 1, FN = 1</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>tensor(0.6667)</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="error_rate" class="doc_header"><code>error_rate</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L49" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#error_rate-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>error_rate</code>(<strong><code>input</code></strong>:<code>Tensor</code>, <strong><code>targs</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="error_rate-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#error_rate-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>error_rate</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_error_rate</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L86" class="source_link" style="float:right">[source]</a></li><li><code>pytest -sv tests/test_vision_train.py::test_error_rate</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_vision_train.py#L45" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>1 - <a href="/metrics.html#accuracy"><code>accuracy</code></a></p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="mean_squared_error" class="doc_header"><code>mean_squared_error</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L78" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#mean_squared_error-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>mean_squared_error</code>(<strong><code>pred</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="mean_squared_error-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#mean_squared_error-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>mean_squared_error</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_mse</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L144" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Mean squared error between <code>pred</code> and <code>targ</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="mean_absolute_error" class="doc_header"><code>mean_absolute_error</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L73" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#mean_absolute_error-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>mean_absolute_error</code>(<strong><code>pred</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="mean_absolute_error-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#mean_absolute_error-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>mean_absolute_error</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_mae</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L135" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Mean absolute error between <code>pred</code> and <code>targ</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="mean_squared_logarithmic_error" class="doc_header"><code>mean_squared_logarithmic_error</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L88" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#mean_squared_logarithmic_error-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>mean_squared_logarithmic_error</code>(<strong><code>pred</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="mean_squared_logarithmic_error-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#mean_squared_logarithmic_error-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>mean_squared_logarithmic_error</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_msle</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L163" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Mean squared logarithmic error between <code>pred</code> and <code>targ</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="exp_rmspe" class="doc_header"><code>exp_rmspe</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L66" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#exp_rmspe-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>exp_rmspe</code>(<strong><code>pred</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="exp_rmspe-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#exp_rmspe-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>exp_rmspe</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_exp_rmspe</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L90" class="source_link" style="float:right">[source]</a></li><li><code>pytest -sv tests/test_metrics.py::test_exp_rmspe_num_of_ele</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L94" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Exp RMSE between <code>pred</code> and <code>targ</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="root_mean_squared_error" class="doc_header"><code>root_mean_squared_error</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L83" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#root_mean_squared_error-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>root_mean_squared_error</code>(<strong><code>pred</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="root_mean_squared_error-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#root_mean_squared_error-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>root_mean_squared_error</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_rmse</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L153" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Root mean squared error between <code>pred</code> and <code>targ</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="fbeta" class="doc_header"><code>fbeta</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L13" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#fbeta-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>fbeta</code>(<strong><code>y_pred</code></strong>:<code>Tensor</code>, <strong><code>y_true</code></strong>:<code>Tensor</code>, <strong><code>thresh</code></strong>:<code>float</code>=<strong><em><code>0.2</code></em></strong>, <strong><code>beta</code></strong>:<code>float</code>=<strong><em><code>2</code></em></strong>, <strong><code>eps</code></strong>:<code>float</code>=<strong><em><code>1e-09</code></em></strong>, <strong><code>sigmoid</code></strong>:<code>bool</code>=<strong><em><code>True</code></em></strong>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="fbeta-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#fbeta-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>fbeta</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_fbeta</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L126" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Computes the f_beta between <code>preds</code> and <code>targets</code></p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p><code>beta</code> determines the value of the fbeta applied, <code>eps</code> is there for numeric stability. If <code>sigmoid=True</code>, a sigmoid is applied to the predictions before comparing them to <code>thresh</code> then to the targets. See the <a href="https://en.wikipedia.org/wiki/F1_score">F1 score wikipedia page</a> for details on the fbeta score.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
$${F_\beta} = (1+\beta^2)\frac{precision \cdot recall}{(\beta^2 \cdot precision) + recall}$$
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">preds</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mf">0.6</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">,</span> <span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.9</span><span class="p">])</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span> <span class="c1"># TP =2, FP = 1, FN = 1</span>
<span class="n">ys</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
<span class="n">fbeta</span><span class="p">(</span><span class="n">preds</span><span class="p">,</span> <span class="n">ys</span><span class="p">,</span> <span class="n">thresh</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span> <span class="n">sigmoid</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>tensor(0.6667)</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>This function is intended for one-hot-encoded targets (often in a multiclassification problem).</div>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="explained_variance" class="doc_header"><code>explained_variance</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L93" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#explained_variance-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>explained_variance</code>(<strong><code>pred</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="explained_variance-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#explained_variance-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>explained_variance</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_explained_variance</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L174" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Explained variance between <code>pred</code> and <code>targ</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
$$ Explained \ Variance = 1 - \frac{Var( targ - pred )}{Var( targ )}$$
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">preds</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mf">0.10</span><span class="p">,</span> <span class="o">.</span><span class="mi">20</span><span class="p">,</span> <span class="o">.</span><span class="mi">30</span><span class="p">,</span> <span class="o">.</span><span class="mi">40</span><span class="p">,</span> <span class="o">.</span><span class="mi">50</span><span class="p">])</span>
<span class="n">ys</span> <span class="o">=</span> <span class="n">tensor</span><span class="p">([</span><span class="mf">0.12</span><span class="p">,</span> <span class="o">.</span><span class="mi">17</span><span class="p">,</span> <span class="o">.</span><span class="mi">25</span><span class="p">,</span> <span class="o">.</span><span class="mi">44</span><span class="p">,</span> <span class="o">.</span><span class="mi">56</span><span class="p">])</span> <span class="c1"># predictions are close to the truth</span>
<span class="n">explained_variance</span><span class="p">(</span><span class="n">preds</span><span class="p">,</span> <span class="n">ys</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>tensor(0.9374)</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="r2_score" class="doc_header"><code>r2_score</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L99" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#r2_score-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>r2_score</code>(<strong><code>pred</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>) → <code>Rank0Tensor</code></p>
</blockquote>
<div class="collapse" id="r2_score-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#r2_score-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>r2_score</code>:</p><ul><li><code>pytest -sv tests/test_metrics.py::test_r2_score</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_metrics.py#L185" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>R2 score (coefficient of determination) between <code>pred</code> and <code>targ</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
$$ {R^2} = 1 - \frac{\sum( targ - pred )^2}{\sum( targ - \overline{targ})^2}$$<p>where $\overline{targ}$ is the mean of the targ tensor.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">r2_score</span><span class="p">(</span><span class="n">preds</span><span class="p">,</span> <span class="n">ys</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>tensor(0.9351)</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>The following metrics are classes, don't forget to instantiate them when you pass them to a <a href="/basic_train.html#Learner"><code>Learner</code></a>.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="RMSE" class="doc_header"><code>class</code> <code>RMSE</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L126" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#RMSE-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>RMSE</code>() :: <a href="/metrics.html#RegMetrics"><code>RegMetrics</code></a></p>
</blockquote>
<div class="collapse" id="RMSE-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#RMSE-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>RMSE</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the root mean squared error.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="ExpRMSPE" class="doc_header"><code>class</code> <code>ExpRMSPE</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L131" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#ExpRMSPE-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>ExpRMSPE</code>() :: <a href="/metrics.html#RegMetrics"><code>RegMetrics</code></a></p>
</blockquote>
<div class="collapse" id="ExpRMSPE-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#ExpRMSPE-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>ExpRMSPE</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the exponential of the root mean square error.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="Precision" class="doc_header"><code>class</code> <code>Precision</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L206" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#Precision-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>Precision</code>(<strong><code>average</code></strong>:<code>Optional</code>[<code>str</code>]=<strong><em><code>'binary'</code></em></strong>, <strong><code>pos_label</code></strong>:<code>int</code>=<strong><em><code>1</code></em></strong>, <strong><code>eps</code></strong>:<code>float</code>=<strong><em><code>1e-09</code></em></strong>) :: <a href="/metrics.html#CMScores"><code>CMScores</code></a></p>
</blockquote>
<div class="collapse" id="Precision-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#Precision-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>Precision</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the Precision.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="Recall" class="doc_header"><code>class</code> <code>Recall</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L201" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#Recall-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>Recall</code>(<strong><code>average</code></strong>:<code>Optional</code>[<code>str</code>]=<strong><em><code>'binary'</code></em></strong>, <strong><code>pos_label</code></strong>:<code>int</code>=<strong><em><code>1</code></em></strong>, <strong><code>eps</code></strong>:<code>float</code>=<strong><em><code>1e-09</code></em></strong>) :: <a href="/metrics.html#CMScores"><code>CMScores</code></a></p>
</blockquote>
<div class="collapse" id="Recall-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#Recall-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>Recall</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the Recall.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="FBeta" class="doc_header"><code>class</code> <code>FBeta</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L212" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#FBeta-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>FBeta</code>(<strong><code>average</code></strong>:<code>Optional</code>[<code>str</code>]=<strong><em><code>'binary'</code></em></strong>, <strong><code>pos_label</code></strong>:<code>int</code>=<strong><em><code>1</code></em></strong>, <strong><code>eps</code></strong>:<code>float</code>=<strong><em><code>1e-09</code></em></strong>, <strong><code>beta</code></strong>:<code>float</code>=<strong><em><code>2</code></em></strong>) :: <a href="/metrics.html#CMScores"><code>CMScores</code></a></p>
</blockquote>
<div class="collapse" id="FBeta-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#FBeta-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>FBeta</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the F<code>beta</code> score.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="R2Score" class="doc_header"><code>class</code> <code>R2Score</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L116" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#R2Score-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>R2Score</code>() :: <a href="/metrics.html#RegMetrics"><code>RegMetrics</code></a></p>
</blockquote>
<div class="collapse" id="R2Score-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#R2Score-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>R2Score</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the R2 score (coefficient of determination).</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="ExplainedVariance" class="doc_header"><code>class</code> <code>ExplainedVariance</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L121" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#ExplainedVariance-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>ExplainedVariance</code>() :: <a href="/metrics.html#RegMetrics"><code>RegMetrics</code></a></p>
</blockquote>
<div class="collapse" id="ExplainedVariance-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#ExplainedVariance-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>ExplainedVariance</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the explained variance.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="MatthewsCorreff" class="doc_header"><code>class</code> <code>MatthewsCorreff</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L253" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#MatthewsCorreff-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>MatthewsCorreff</code>() :: <a href="/metrics.html#ConfusionMatrix"><code>ConfusionMatrix</code></a></p>
</blockquote>
<div class="collapse" id="MatthewsCorreff-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#MatthewsCorreff-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>MatthewsCorreff</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the Matthews correlation coefficient.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Ref.: <a href="https://github.com/scikit-learn/scikit-learn/blob/bac89c2/sklearn/metrics/classification.py">https://github.com/scikit-learn/scikit-learn/blob/bac89c2/sklearn/metrics/classification.py</a></p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="KappaScore" class="doc_header"><code>class</code> <code>KappaScore</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L233" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#KappaScore-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>KappaScore</code>(<strong><code>weights</code></strong>:<code>Optional</code>[<code>str</code>]=<strong><em><code>None</code></em></strong>) :: <a href="/metrics.html#ConfusionMatrix"><code>ConfusionMatrix</code></a></p>
</blockquote>
<div class="collapse" id="KappaScore-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#KappaScore-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>KappaScore</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the rate of agreement (Cohens Kappa).</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Ref.: <a href="https://github.com/scikit-learn/scikit-learn/blob/bac89c2/sklearn/metrics/classification.py">https://github.com/scikit-learn/scikit-learn/blob/bac89c2/sklearn/metrics/classification.py</a></p>
<p><a href="/metrics.html#KappaScore"><code>KappaScore</code></a> supports linear and quadratic weights on the off-diagonal cells in the <a href="/metrics.html#ConfusionMatrix"><code>ConfusionMatrix</code></a>, in addition to the default unweighted calculation treating all misclassifications as equally weighted. Leaving <a href="/metrics.html#KappaScore"><code>KappaScore</code></a>'s <code>weights</code> attribute as <code>None</code> returns the unweighted Kappa score. Updating <code>weights</code> to "linear" means off-diagonal ConfusionMatrix elements are weighted in linear proportion to their distance from the diagonal; "quadratic" means weights are squared proportional to their distance from the diagonal.
Specify linear or quadratic weights, if using, by first creating an instance of the metric and then updating the <code>weights</code> attribute, similar to as follows:</p>
<pre><code>kappa = KappaScore()
kappa.weights = "quadratic"
learn = cnn_learner(data, model, metrics=[error_rate, kappa])</code></pre>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="ConfusionMatrix" class="doc_header"><code>class</code> <code>ConfusionMatrix</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L142" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#ConfusionMatrix-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>ConfusionMatrix</code>() :: <a href="/callback.html#Callback"><code>Callback</code></a></p>
</blockquote>
<div class="collapse" id="ConfusionMatrix-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#ConfusionMatrix-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>ConfusionMatrix</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the confusion matrix.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="MultiLabelFbeta" class="doc_header"><code>class</code> <code>MultiLabelFbeta</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L315" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#MultiLabelFbeta-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>MultiLabelFbeta</code>(<strong><code>learn</code></strong>, <strong><code>beta</code></strong>=<strong><em><code>2</code></em></strong>, <strong><code>eps</code></strong>=<strong><em><code>1e-15</code></em></strong>, <strong><code>thresh</code></strong>=<strong><em><code>0.3</code></em></strong>, <strong><code>sigmoid</code></strong>=<strong><em><code>True</code></em></strong>, <strong><code>average</code></strong>=<strong><em><code>'micro'</code></em></strong>) :: <a href="/basic_train.html#LearnerCallback"><code>LearnerCallback</code></a></p>
</blockquote>
<div class="collapse" id="MultiLabelFbeta-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#MultiLabelFbeta-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>MultiLabelFbeta</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the fbeta score for multilabel classification</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p><a href="/metrics.html#MultiLabelFbeta"><code>MultiLabelFbeta</code></a> implements mutlilabel classification fbeta score similar to <a href="https://scikit-learn.org/stable/modules/generated/sklearn.metrics.f1_score.html">scikit-learn's</a> as a <a href="/basic_train.html#LearnerCallback"><code>LearnerCallback</code></a>. Average options: ["micro", "macro", "weighted", "none"]. Intended to use with one-hot encoded targets with 1s and 0s.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">show_doc</span><span class="p">(</span><span class="n">auc_roc_score</span><span class="p">,</span> <span class="n">title_level</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="auc_roc_score" class="doc_header"><code>auc_roc_score</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L276" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#auc_roc_score-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>auc_roc_score</code>(<strong><code>input</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>)</p>
</blockquote>
<div class="collapse" id="auc_roc_score-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#auc_roc_score-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>auc_roc_score</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the area under the receiver operator characteristic (ROC) curve using the trapezoid method. Restricted binary classification tasks.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p><a href="/metrics.html#auc_roc_score"><code>auc_roc_score</code></a> computes the AUC score for the ROC curve similarly to <a href="https://scikit-learn.org/stable/modules/generated/sklearn.metrics.roc_auc_score.html">scikit-learn</a> using the trapezoid method, effectively summarizing the curve information in a single number. See <a href="https://en.wikipedia.org/wiki/Receiver_operating_characteristic#Area_under_the_curve">Wikipedia's page</a> for more information on this.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">jekyll_note</span><span class="p">(</span><span class="s2">"Instead of passing this method to the learner's metrics directly, make use of the AUROC() class."</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">show_doc</span><span class="p">(</span><span class="n">roc_curve</span><span class="p">,</span> <span class="n">title_level</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="roc_curve" class="doc_header"><code>roc_curve</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L284" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#roc_curve-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>roc_curve</code>(<strong><code>input</code></strong>:<code>Tensor</code>, <strong><code>targ</code></strong>:<code>Tensor</code>)</p>
</blockquote>
<div class="collapse" id="roc_curve-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#roc_curve-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>roc_curve</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the receiver operator characteristic (ROC) curve by determining the true positive ratio (TPR) and false positive ratio (FPR) for various classification thresholds. Restricted binary classification tasks.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p><a href="/metrics.html#roc_curve"><code>roc_curve</code></a> generates the ROC curve similarly to <a href="https://scikit-learn.org/stable/modules/generated/sklearn.metrics.roc_curve.html">scikit-learn</a>. See <a href="https://en.wikipedia.org/wiki/Receiver_operating_characteristic">Wikipedia's page</a> for more information on the ROC curve.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">jekyll_note</span><span class="p">(</span><span class="s2">"Instead of passing this method to the learner's metrics directly, make use of the AUROC() class."</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">show_doc</span><span class="p">(</span><span class="n">AUROC</span><span class="p">,</span> <span class="n">title_level</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h3 id="AUROC" class="doc_header"><code>class</code> <code>AUROC</code><a href="https://github.com/fastai/fastai/blob/master/fastai/metrics.py#L302" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#AUROC-pytest" style="float:right; padding-right:10px">[test]</a></h3><blockquote><p><code>AUROC</code>() :: <a href="/callback.html#Callback"><code>Callback</code></a></p>
</blockquote>
<div class="collapse" id="AUROC-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#AUROC-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>AUROC</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Computes the area under the curve (AUC) score based on the receiver operator characteristic (ROC) curve. Restricted to binary classification tasks.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p><a href="/metrics.html#AUROC"><code>AUROC</code></a> creates a <a href="/callback.html#Callback"><code>Callback</code></a> for computing the AUC score for the ROC curve with <a href="/metrics.html#auc_roc_score"><code>auc_roc_score</code></a> at the end of each epoch, given that averaging over batches is incorrect in case of the AUROC. See <a href="https://en.wikipedia.org/wiki/Receiver_operating_characteristic#Area_under_the_curve">Wikipedia's page</a> for more information on the AUROC.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">