Microsoft.ML.Data.xml
730.7 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.ML.Data</name>
</assembly>
<members>
<member name="M:Microsoft.ML.Data.CrossValidationCommand.ApplyAllTransformsToData(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.RoleMappedData,Microsoft.Data.DataView.IDataView)">
<summary>
Callback from the CV method to apply the transforms from the train data to the test and/or validation data.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CrossValidationCommand.CreateRoleMappedData(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.Data.DataView.IDataView,Microsoft.ML.ITrainer)">
<summary>
Callback from the CV method to apply the transforms to the train data.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CrossValidationCommand.FoldHelper.#ctor(Microsoft.ML.IHostEnvironment,System.String,Microsoft.Data.DataView.IDataView,System.String,Microsoft.ML.Data.CrossValidationCommand.Arguments,System.Func{Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.Data.DataView.IDataView,Microsoft.ML.ITrainer,Microsoft.ML.Data.RoleMappedData},System.Func{Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.RoleMappedData,Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.RoleMappedData},Microsoft.ML.IComponentFactory{Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.ML.Data.RoleMappedSchema,Microsoft.ML.Data.IDataScorerTransform},Microsoft.ML.IComponentFactory{Microsoft.ML.Data.IMamlEvaluator},System.Func{Microsoft.Data.DataView.IDataView},System.Func{Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.RoleMappedData,Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.RoleMappedData},Microsoft.ML.IPredictor,System.String,Microsoft.ML.Data.ILegacyDataLoader,System.Boolean)">
<param name="env">The environment.</param>
<param name="registrationName">The registration name.</param>
<param name="inputDataView">The input data view.</param>
<param name="splitColumn">The column to use for splitting data into folds.</param>
<param name="args">Cross validation arguments.</param>
<param name="createExamples">The delegate to create RoleMappedData</param>
<param name="applyTransformsToTestData">The delegate to apply the transforms from the train pipeline to the test data</param>
<param name="scorer">The scorer</param>
<param name="evaluator">The evaluator</param>
<param name="getValidationDataView">The delegate to create validation data view</param>
<param name="applyTransformsToValidationData">The delegate to apply the transforms from the train pipeline to the validation data</param>
<param name="inputPredictor">The input predictor, for the continue training option</param>
<param name="cmd">The command string.</param>
<param name="loader">Original loader so we can construct correct pipeline for model saving.</param>
<param name="savePerInstance">Whether to produce the per-instance data view.</param>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Data.CrossValidationCommand.FoldHelper.GetCrossValidationTasks">
<summary>
Creates and runs tasks for each fold of cross validation. The split column is used to split the input data into folds.
There are two cases:
1. The split column is R4: in this case it assumes that the values are in the interval [0,1] and will split
this interval into equal width folds. If the values are uniformly distributed it should result in balanced folds.
2. The split column is key of known cardinality: will split the whole range into equal parts to form folds. If the
keys are generated by hashing for example, it should result in balanced folds.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Data.CrossValidationCommand.ConstructPerFoldName(System.String,System.Int32)">
<summary>
Take path to expected output model file and return path to output model file for specific fold.
Example: \\share\model.zip -> \\share\model.fold001.zip
</summary>
<param name="outputModelFile">Path to output model file</param>
<param name="fold">Current fold</param>
<returns>Path to output model file for specific fold</returns>
</member>
<member name="T:Microsoft.ML.Data.DataCommand">
<summary>
This holds useful base classes for commands that ingest a primary dataset and deal with associated model files.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataCommand.ImplBase`1.#ctor(Microsoft.ML.IHostEnvironment,`0,System.String,System.Nullable{System.Int32})">
<summary>
The degree of concurrency is passed in the conc parameter. If it is null, the value
of args.parralel is used. If that is null, zero is used (which means "automatic").
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataCommand.ImplBase`1.LoadModelObjects(Microsoft.ML.IChannel,System.Nullable{System.Boolean},Microsoft.ML.IPredictor@,System.Boolean,Microsoft.ML.Data.RoleMappedSchema@,Microsoft.ML.Data.ILegacyDataLoader@)">
<summary>
Loads multiple artifacts of interest from the input model file, given the context
established by the command line arguments.
</summary>
<param name="ch">The channel to which to provide output.</param>
<param name="wantPredictor">Whether we want a predictor from the model file. If
<c>false</c> we will not even attempt to load a predictor. If <c>null</c> we will
load the predictor, if present. If <c>true</c> we will load the predictor, or fail
noisily if we cannot.</param>
<param name="predictor">The predictor in the model, or <c>null</c> if
<paramref name="wantPredictor"/> was false, or <paramref name="wantPredictor"/> was
<c>null</c> and no predictor was present.</param>
<param name="wantTrainSchema">Whether we want the training schema. Unlike
<paramref name="wantPredictor"/>, this has no "hard fail if not present" option. If
this is <c>true</c>, it is still possible for <paramref name="trainSchema"/> to remain
<c>null</c> if there were no role mappings, or pipeline.</param>
<param name="trainSchema">The training schema if <paramref name="wantTrainSchema"/>
is true, and there were role mappings stored in the model.</param>
<param name="pipe">The data pipe constructed from the combination of the
model and command line arguments.</param>
</member>
<member name="M:Microsoft.ML.Data.LoaderUtils.SaveLoader(Microsoft.ML.Data.ILegacyDataLoader,Microsoft.ML.IFileHandle)">
<summary>
Saves <paramref name="loader"/> to the specified <paramref name="file"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LoaderUtils.SaveLoader(Microsoft.ML.Data.ILegacyDataLoader,System.IO.Stream)">
<summary>
Saves <paramref name="loader"/> to the specified <paramref name="stream"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetricColumn">
<summary>
This class contains information about an overall metric, namely its name and whether it is a vector
metric or not.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetricColumn.Objective">
<summary>
An enum specifying whether the metric should be maximized or minimized while sweeping. 'Info' should be
used for metrics that are irrelevant to the model's quality (such as the number of positive/negative
examples etc.).
</summary>
</member>
<member name="T:Microsoft.ML.Data.IEvaluator">
<summary>
This is an interface for evaluation. It has two methods: <see cref="M:Microsoft.ML.Data.IEvaluator.Evaluate(Microsoft.ML.Data.RoleMappedData)"/> and <see cref="M:Microsoft.ML.Data.IEvaluator.GetPerInstanceMetrics(Microsoft.ML.Data.RoleMappedData)"/>.
Both take a <see cref="T:Microsoft.ML.Data.RoleMappedData"/> as input. The <see cref="T:Microsoft.ML.Data.RoleMappedData"/> is assumed to contain all the column
roles needed for evaluation, including the score column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IEvaluator.Evaluate(Microsoft.ML.Data.RoleMappedData)">
<summary>
Compute the aggregate metrics. Return a dictionary from the metric kind
(overal/per-fold/confusion matrix/PR-curves etc.), to a data view containing the metric.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IEvaluator.GetPerInstanceMetrics(Microsoft.ML.Data.RoleMappedData)">
<summary>
Return an <see cref="T:Microsoft.ML.Data.IDataTransform"/> containing the per-instance results.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IEvaluator.GetOverallMetricColumns">
<summary>
Get all the overall metrics returned by this evaluator.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SignatureEvaluator">
<summary>
Signature for creating an <see cref="T:Microsoft.ML.Data.IEvaluator"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SignatureDataScorer">
<summary>
Signature for creating an <see cref="T:Microsoft.ML.Data.IDataScorerTransform"/>.
</summary>
<param name="data">The data containing the columns to score</param>
<param name="mapper">The mapper, already bound to the schema column in <paramref name="data"/></param>
<param name="trainSchema">This parameter holds a snapshot of the role mapped training schema as
it existed at the point when <paramref name="mapper"/> was trained, or <c>null</c> if it not
available for some reason</param>
</member>
<member name="M:Microsoft.ML.Data.ScoreCommand.ShouldAddColumn(Microsoft.Data.DataView.DataViewSchema,System.Int32,System.UInt32,System.Boolean)">
<summary>
Whether a column should be added, assuming it's not hidden
(i.e.: this doesn't check for hidden
</summary>
</member>
<member name="M:Microsoft.ML.Data.ScoreUtils.GetScorerComponentAndMapper(Microsoft.ML.IPredictor,Microsoft.ML.IComponentFactory{Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.ML.Data.RoleMappedSchema,Microsoft.ML.Data.IDataScorerTransform},Microsoft.ML.Data.RoleMappedSchema,Microsoft.ML.IHostEnvironment,Microsoft.ML.IComponentFactory{Microsoft.ML.IPredictor,Microsoft.ML.Data.ISchemaBindableMapper},Microsoft.ML.Data.ISchemaBoundMapper@)">
<summary>
Determines the scorer component factory (if the given one is null or empty), and creates the schema bound mapper.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ScoreUtils.GetScorerComponent(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ISchemaBoundMapper,System.String)">
<summary>
Determine the default scorer for a schema bound mapper. This looks for text-valued ScoreColumnKind
metadata on the first column of the mapper. If that text is found and maps to a scorer loadable class,
that component is used. Otherwise, the GenericScorer is used.
</summary>
<param name="environment">The host environment.</param>.
<param name="mapper">The schema bound mapper to get the default scorer.</param>.
<param name="suffix">An optional suffix to append to the default column names.</param>
</member>
<member name="M:Microsoft.ML.Data.ScoreUtils.GetSchemaBindableMapper(Microsoft.ML.IHostEnvironment,Microsoft.ML.IPredictor,Microsoft.ML.IComponentFactory{Microsoft.ML.IPredictor,Microsoft.ML.Data.ISchemaBindableMapper},Microsoft.ML.CommandLine.ICommandLineComponentFactory)">
<summary>
Given a predictor, an optional mapper factory, and an optional scorer factory settings,
produces a compatible ISchemaBindableMapper.
First, it tries to instantiate the bindable mapper using the mapper factory.
Next, it tries to instantiate the bindable mapper using the <paramref name="scorerFactorySettings"/>
(this will only succeed if there's a registered BindableMapper creation method with load name equal to the one
of the scorer).
If the above fails, it checks whether the predictor implements <see cref="T:Microsoft.ML.Data.ISchemaBindableMapper"/>
directly.
If this also isn't true, it will create a 'matching' standard mapper.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ShowSchemaCommand.RunOnData(System.IO.TextWriter,Microsoft.ML.Data.ShowSchemaCommand.Arguments,Microsoft.Data.DataView.IDataView)">
<summary>
This shows the schema of the given <paramref name="data"/>, ignoring the data specification
in the <paramref name="args"/> parameter. Test code invokes this, hence it is internal.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ShowSchemaCommand.GetViewChainReversed(Microsoft.Data.DataView.IDataView)">
<summary>
Returns the sequence of views passed through the transform chain, last to first.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TestCommand">
<summary>
This command is essentially chaining together <see cref="T:Microsoft.ML.Data.ScoreCommand"/> and
<see cref="T:Microsoft.ML.Data.EvaluateCommand"/>, without the need to save the intermediary scored data.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TrainUtils.MatchNameOrDefaultOrNull(Microsoft.ML.IExceptionContext,Microsoft.Data.DataView.DataViewSchema,System.String,System.String,System.String)">
<summary>
If user name is null or empty, return null.
Else, if the user name is found in the schema, return the user name.
Else, if the user name equals the default name return null.
Else, throw an error.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TrainUtils.SaveModel(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.ML.IFileHandle,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedData,System.String)">
<summary>
Save the model to the output path.
The method saves the loader and the transformations of dataPipe and saves optionally predictor
and command. It also uses featureColumn, if provided, to extract feature names.
</summary>
<param name="env">The host environment to use.</param>
<param name="ch">The communication channel to use.</param>
<param name="output">The output file handle.</param>
<param name="predictor">The predictor.</param>
<param name="data">The training examples.</param>
<param name="command">The command string.</param>
</member>
<member name="M:Microsoft.ML.Data.TrainUtils.SaveModel(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,System.IO.Stream,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedData,System.String)">
<summary>
Save the model to the stream.
The method saves the loader and the transformations of dataPipe and saves optionally predictor
and command. It also uses featureColumn, if provided, to extract feature names.
</summary>
<param name="env">The host environment to use.</param>
<param name="ch">The communication channel to use.</param>
<param name="outputStream">The output model stream.</param>
<param name="predictor">The predictor.</param>
<param name="data">The training examples.</param>
<param name="command">The command string.</param>
</member>
<member name="M:Microsoft.ML.Data.TrainUtils.SaveDataPipe(Microsoft.ML.IHostEnvironment,Microsoft.ML.RepositoryWriter,Microsoft.Data.DataView.IDataView,System.Boolean)">
<summary>
Save the data pipeline defined by dataPipe. If blankLoader is true or the root IDataView is not an IDataLoader,
this persists the root as a BinaryLoader having the same schema.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TrainUtils.BacktrackPipe(Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.IDataView@)">
<summary>
Traces back the .Source chain of the transformation pipe <paramref name="dataPipe"/> up to the moment it no longer can.
Returns all the transforms of <see cref="T:Microsoft.Data.DataView.IDataView"/> and the first data view (a non-transform).
</summary>
<param name="dataPipe">The transformation pipe to traverse.</param>
<param name="pipeStart">The beginning data view of the transform chain</param>
<returns>The list of the transforms</returns>
</member>
<member name="T:Microsoft.ML.Data.DataDebuggerPreview">
<summary>
This class represents an eager 'preview' of a <see cref="T:Microsoft.Data.DataView.IDataView"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry">
<summary>
Each column corresponds to a table of contents entry, describing information about the column
and how values may be extracted. For columns represented physically within the stream this will
include its location within the stream and a codec to decode the bytestreams, and for generated
columns procedures to create them. This structure is used both for those columns that
we know how to access (called alive columns), and those columns we do not know how to access
(either because the value codec or compressions scheme is unrecognized, called a dead column).
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.Name">
<summary>
The name of the column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.Codec">
<summary>
The codec we will use to read the values from the stream. This will be null if
and only if this is a dead or generated column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.Type">
<summary>
The column type of the column. This will be null if and only if this is a dead
column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.Compression">
<summary>
The compression scheme used on this column's blocks.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.RowsPerBlock">
<summary>
The number of rows in each block (except for the last one).
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.LookupOffset">
<summary>
The offset into the stream where the lookup table for this column is stored.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.MetadataTocOffset">
<summary>
The offset into the stream where the metadata TOC entries for this column are
stored. This will be 0 if there is no metadata for this column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.ColumnIndex">
<summary>
The index of the column. Note that if there are dead columns, this value may
differ from the corresponding column index as reported by the dataview.
</summary>
</member>
<member name="P:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.IsGenerated">
<summary>
Whether this is a generated column, that is, something dependent on no actual block data
in the file.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.#ctor(Microsoft.ML.Data.IO.BinaryLoader,System.String,Microsoft.Data.DataView.DataViewType,System.Delegate)">
<summary>
Constructor for a generated column, which corresponds to no column in the original file,
and has no stored blocks associated with it. The input <paramref name="valueMapper"/> must
be a <c>ValueMapper</c> mapping a <c>long</c> zero based row index, to some value with the
same type as the raw type in <paramref name="type"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.GetValueMapper``1">
<summary>
Returns the value mapper for a generated column. Only a valid call if
<typeparamref name="T"/> is the same type as <see cref="P:Microsoft.Data.DataView.DataViewType.RawType"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.GetLookup">
<summary>
Gets an array, one for each block of this column, describing its location within the file.
This will return null if and only if this is a generated column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.GetMaxBlockSizes(System.Int32@,System.Int32@)">
<summary>
Fetches the maximum block sizes for both the compressed and decompressed
block sizes, for this column. If there are no blocks associated with this
column, for whatever reason (for example, a data view with no rows, or a generated
column), this will return 0 in both vlaues.
</summary>
<param name="compressed">The maximum value of the compressed block size
(that is, the actual size of the block in stream) among all blocks for this
column</param>
<param name="decompressed">The maximum value of the block size when
decompressed among all blocks for this column</param>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.GetMetadataTocArray">
<summary>
Gets an array containing the metadata TOC entries. This will return null if there
are no entries stored at all, and empty if there is metadata, but none of it was
readable. (To inspect attributes of the unreadable metadata, if any, see
<see cref="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.GetDeadMetadataTocArray"/>.) All entries will point to metadata with
known codecs and compression schemes.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.GetDeadMetadataTocArray">
<summary>
Gets an array containing the metadata TOC entries for all "dead" pieces of metadata. This
will return null if there are no metadata stored at all either readable or unreadable, and
empty if there is no unreadable piece of metadata. A piece of metadata is considered "dead"
if either its codec or compression kind is unknown. This is primarily for diagnostic purposes.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.GetMetadataTocEntryOrNull(System.String)">
<summary>
Returns the entry for a valid "live" piece of metadata given a kind.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.TableOfContentsEntry.GetMetadataTocEndOffset">
<summary>
Returns the location in the stream just past the end of the metadata table of contents.
If this column has no metadata table of contents defined, this will return 0. This is
primarily for diagnostic purposes.
</summary>
<returns></returns>
</member>
<member name="T:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry">
<summary>
A column can be associated with metadata, in which case it will have one or more table of contents entries,
each represented by one of these entries.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.Kind">
<summary>
The kind of the metadata, an identifying name.
</summary>
</member>
<member name="P:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.Codec">
<summary>
The codec we will use to read the metadata value. If this is <c>null</c>,
the metadata is considered "dead," that is, uninterpretable.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.Compression">
<summary>
The compression scheme used on the metadata block. If this is an unknown
type, the metadata is considered "dead," that is, uninterpretable.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.BlockOffset">
<summary>
The offset into the stream where the metadata block begins.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.BlockSize">
<summary>
The number of bytes used to store the metadata block.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.GetGetter">
<summary>
Return <see cref="T:Microsoft.Data.DataView.ValueGetter`1"/> to the stored entry value as <see cref="T:System.Delegate"/>. An example of stored value is
<see cref="F:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry`1.Value"/>. For implementations of <see cref="M:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.GetGetter"/>, see <see cref="T:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.ImplDead"/>,
<see cref="T:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.ImplOne`1"/>, and <see cref="T:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.ImplVec`1"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry.ImplDead">
<summary>
Information on a metadata that could not be interpreted for some reason.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry`1.EnsureValue">
<summary>
By calling <see cref="M:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry`1.EnsureValue"/>, we make sure <see cref="F:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry`1.Value"/>'s content get loaded definitely.
Without calling <see cref="M:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry`1.EnsureValue"/>, <see cref="F:Microsoft.ML.Data.IO.BinaryLoader.MetadataTableOfContentsEntry`1.Value"/> could be default value of its type.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.ComputeOutputSchema">
<summary>
This function returns output schema, <see cref="P:Microsoft.ML.Data.IO.BinaryLoader.Schema"/>, of <see cref="T:Microsoft.ML.Data.IO.BinaryLoader"/> by translating <see cref="F:Microsoft.ML.Data.IO.BinaryLoader._aliveColumns"/> into
<see cref="T:Microsoft.Data.DataView.DataViewSchema.Column"/>s. If a <see cref="T:Microsoft.ML.Data.IO.BinaryLoader"/> loads a text column from the input file, its <see cref="P:Microsoft.ML.Data.IO.BinaryLoader.Schema"/>
should contains a <see cref="T:Microsoft.Data.DataView.DataViewSchema.Column"/> with <see cref="P:Microsoft.Data.DataView.TextDataViewType.Instance"/> as its <see cref="T:Microsoft.Data.DataView.DataViewType"/>.
</summary>
<returns><see cref="P:Microsoft.ML.Data.IO.BinaryLoader.Schema"/> of loaded file.</returns>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.ReaderVersion">
<summary>
Upper inclusive bound of versions this reader can read.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.StandardDataTypesVersion">
<summary>
The first version that removes DvTypes and uses .NET standard
data types.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.MissingTextVersion">
<summary>
The first version of the format that accomodated DvText.NA.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.MetadataVersion">
<summary>
The first version of the format that accomodated arbitrary metadata.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.SlotNamesVersion">
<summary>
The first version of the format that accomodated slot names.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.ReaderFirstVersion">
<summary>
Low inclusive bound of versions this reader can read.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.IO.BinaryLoader.Arguments,System.IO.Stream,System.Boolean)">
<summary>
Constructs a new data view loader.
</summary>
<param name="stream">A seekable, readable stream. Note that the data view loader assumes
that it is the exclusive owner of this stream.</param>
<param name="args">Arguments</param>
<param name="env">Host environment</param>
<param name="leaveOpen">Whether to leave the input stream open</param>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.#ctor(Microsoft.ML.IHost,Microsoft.ML.ModelLoadContext,System.IO.Stream)">
<summary>
Creates a binary loader from a <see cref="T:Microsoft.ML.ModelLoadContext"/>. Since the loader code
opens the file, this will always take ownership of the stream, that is, this is always
akin to <c>leaveOpen</c> in the other constructor being false.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,System.IO.Stream)">
<summary>
Creates a binary loader from a stream that is not owned by the loader.
This creates its own independent copy of input stream for the binary loader.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.SaveParameters(Microsoft.ML.ModelSaveContext,System.Int32,System.String,System.Double)">
<summary>
Write the parameters of a loader to the save context. Can be called by <see cref="M:Microsoft.ML.Data.IO.BinaryLoader.SaveInstance(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelSaveContext,Microsoft.Data.DataView.DataViewSchema)"/>, where there's no actual
loader, only default parameters.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.SaveSchema(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelSaveContext,Microsoft.Data.DataView.DataViewSchema,System.Int32[]@)">
<summary>
Save a zero-row dataview that will be used to infer schema information, used in the case
where the binary loader is instantiated with no input streams.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.SaveInstance(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelSaveContext,Microsoft.Data.DataView.DataViewSchema)">
<summary>
Given the schema and a model context, save an imaginary instance of a binary loader with the
specified schema. Deserialization from this context should produce a real binary loader that
has the specified schema.
This is used in an API scenario, when the data originates from something other than a loader.
Since our model file requires a loader at the beginning, we have to construct a bogus 'binary' loader
to begin the pipe with, with the assumption that the user will bypass the loader at deserialization
time by providing a starting data view.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe.DecompressOne">
<summary>
This will attempt to extract a compressed block from the
<see cref="F:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe`1._toDecompress"/> queue. This returns true if and only if it
succeeded in extracting an item from the queue (even a sentinel block);
that is, if it returns false, then there are no more items to extract
(though, continuing to call this method is entirely possible, and legal,
if convenient).
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe.MoveNextCleanup">
<summary>
Necessary to be called in the event of a premature exiting. This executes
the same recycle-fetch block cycle as <see cref="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe.MoveNext"/>, except that
nothing is actually done with the resulting block. This should be called
in a similar fashion as the cursor calls <see cref="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe.MoveNext"/>.
</summary>
</member>
<member name="P:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipeGenerated`1.Block.IsSentinel">
<summary>
This indicates that this block does not contain any actual information, or
correspond to an actual block, but it will still contain the
<see cref="F:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipeGenerated`1.Block.BlockSequence"/> index. Sentinel blocks are used to indicate that
there will be no more blocks to be decompressed along a particular pipe,
allowing the pipe worker to perform necessary cleanup.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipeGenerated`1.Block.#ctor(System.Int64)">
<summary>
Constructor for a sentinel compressed block. (For example,
the pipe's last block, which contains no valid data.)
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe`1._toDecompress">
<summary>
Calls from the stream reader worker into <see cref="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe`1.PrepAndSendCompressedBlock(System.Int64,System.Int64,System.Int32)"/> will feed
into this collection, and calls from the decompress worker into <see cref="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe`1.DecompressOne"/>
will consume this collection.
</summary>
</member>
<member name="P:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe`1.CompressedBlock.IsSentinel">
<summary>
This indicates that this block does not contain any actual information, or
correspond to an actual block, but it will still contain the
<see cref="F:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe`1.CompressedBlock.BlockSequence"/> index. Sentinel blocks are used to indicate that
there will be no more blocks to be decompressed along a particular pipe,
allowing the pipe worker to perform necessary cleanup.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe`1.CompressedBlock.#ctor(System.Int64)">
<summary>
Constructor for a sentinel compressed block. (For example,
the pipe's last block, which contains no valid data.)
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.ReadPipe`1.#ctor(Microsoft.ML.Data.IO.BinaryLoader.Cursor,System.Int32,System.Int32)">
<summary>
This is called through reflection so it will appear to have no references.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinaryLoader.Cursor.GetNoRowGetter(Microsoft.Data.DataView.DataViewType)">
<summary>
Even in the case with no rows, there still must be valid delegates. This will return
a delegate that simply always throws.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.BinarySaver.ColumnCodec">
<summary>
This is a simple struct to associate a source index with a codec, without having to have
parallel structures everywhere.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinarySaver.WritePipe.Create(Microsoft.ML.Data.IO.BinarySaver,Microsoft.Data.DataView.DataViewRowCursor,Microsoft.ML.Data.IO.BinarySaver.ColumnCodec)">
<summary>
Returns an appropriate generic <c>WritePipe{T}</c> for the given column.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.BinarySaver.Block">
<summary>
A class useful for encapsulating both compressed and uncompressed block data.
As the mechanism the compress workers communicate with the writer worker, they
also have a dual usage if <see cref="T:System.Exception"/> is non-null of indicating
a source worker threw an exception.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinarySaver.Block.BlockData">
<summary>
Take one guess.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinarySaver.Block.UncompressedLength">
<summary>
The length of the block if uncompressed. This quantity is only intended to be
meaningful if the block data is compressed.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinarySaver.Block.ColumnIndex">
<summary>
The column index, which is the index of the column as being written, which
may be less than the column from the source dataview if there were preceeding
columns being dropped.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BinarySaver.Block.BlockIndex">
<summary>
The block sequence number for this column, starting consecutively from 0.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinarySaver.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.IO.BinarySaver.Arguments)">
<summary>
Constructs a saver for a data view.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.BinarySaver.WriteMetadata(System.IO.BinaryWriter,Microsoft.Data.DataView.DataViewSchema,System.Int32,Microsoft.ML.IChannel)">
<summary>
A helper method to query and write metadata to the stream.
</summary>
<param name="writer">A binary writer, which if metadata exists for the
indicated column the base stream will be positioned just past the end of
the written metadata table of contents, and if metadata does not exist
remains unchanged</param>
<param name="schema">The schema to query for metadat</param>
<param name="col">The column we are attempting to get metadata for</param>
<param name="ch">The channel to which we write any diagnostic information</param>
<returns>The offset of the metadata table of contents, or 0 if there was
no metadata</returns>
</member>
<member name="M:Microsoft.ML.Data.IO.BinarySaver.TryWriteTypeDescription(System.IO.Stream,Microsoft.Data.DataView.DataViewType,System.Int32@)">
<summary>
A utility method to save a column type to a stream, if we have a codec for that.
</summary>
<param name="stream">The stream to save the description to</param>
<param name="type">The type to save</param>
<param name="bytesWritten">The number of bytes written to the stream, which will
be zero if we could not save the stream</param>
<returns>Returns if have the ability to save this column type. If we do, we write
the description to the stream. If we do not, nothing is written to the stream and
the stream is not advanced.</returns>
</member>
<member name="M:Microsoft.ML.Data.IO.BinarySaver.LoadTypeDescriptionOrNull(System.IO.Stream)">
<summary>
Attempts to load a type description from a stream. In all cases, in the event
of a properly formatted stream, even if the type-descriptor is not recognized,
the stream will be at the end of that type descriptor. Note that any detected
format errors will result in a throw.
</summary>
<param name="stream">The stream to load the type description from</param>
<returns>A non-null value if the type descriptor was recognized, or null if
it was not</returns>
</member>
<member name="M:Microsoft.ML.Data.IO.BinarySaver.TryWriteTypeAndValue``1(System.IO.Stream,Microsoft.Data.DataView.DataViewType,``0@,System.Int32@)">
<summary>
A utility method to save a column type and value to a stream, if we have a codec for that.
</summary>
<param name="stream">The stream to write the type and value to</param>
<param name="type">The type of the codec to write and utilize</param>
<param name="value">The value to encode and write</param>
<param name="bytesWritten">The number of bytes written</param>
<returns>Whether the write was successful or not</returns>
</member>
<member name="M:Microsoft.ML.Data.IO.BinarySaver.TryLoadTypeAndValue(System.IO.Stream,Microsoft.Data.DataView.DataViewType@,System.Object@)">
<summary>
Attempts to load a type description and a value of that type from a stream.
</summary>
<param name="stream">The stream to load the type description and value from</param>
<param name="type">A non-null value if the type descriptor was recognized, or null if
it was not</param>
<param name="value">A non-null value if the type descriptor was recognized and a value
read, or null if the type descriptor was not recognized</param>
<returns>Whether the load of a type description and value was successful</returns>
</member>
<member name="M:Microsoft.ML.Data.IO.BinarySaver.LoadValue``1(System.IO.Stream,Microsoft.ML.Data.IO.IValueCodec{``0})">
<summary>
Deserializes and returns a value given a stream and codec.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.BlockLookup">
<summary>
This structure is utilized by both the binary loader and binary saver to hold
information on the location of blocks written to an .IDV binary file.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BlockLookup.BlockOffset">
<summary>The offset of the block into the file.</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BlockLookup.BlockLength">
<summary>The byte length of the block on disk.</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.BlockLookup.DecompressedBlockLength">
<summary>The byte length of the block if decompressed.</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.CodecFactory.WriteCodec(System.IO.Stream,Microsoft.ML.Data.IO.IValueCodec)">
<summary>
Given a codec, write a type description to a stream, from which this codec can be
reconstructed later. This returns the number of bytes written, so that, if this
were a seekable stream, the positions would differ by this amount before and after
a call to this method.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.CodecFactory.TryReadCodec(System.IO.Stream,Microsoft.ML.Data.IO.IValueCodec@)">
<summary>
Attempts to define a codec, given a stream positioned at the start of a serialized
codec type definition.
</summary>
<param name="definitionStream">The input stream, which whether this returns true or false
will be left at the end of the codec type definition</param>
<param name="codec">A codec castable to a generic <c>IValueCodec{T}</c> where
<c>typeof(T)==codec.Type.RawType</c></param>
<returns>Whether the codec type definition was understood. If true the codec has defined
value, and should be usable. If false, the name of the codec was unrecognized. Note that
malformed definitions are detected, this will throw instead of returning either true or
false.</returns>
</member>
<member name="T:Microsoft.ML.Data.IO.CodecFactory.ValueWriterBase`1">
<summary>
A convenient base class for value writers.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.CodecFactory.ValueReaderBase`1">
<summary>
A convenient base class for value readers.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.CodecFactory.SimpleCodec`1">
<summary>
A simple codec is useful for those types with no parameterizations.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.CodecFactory.UnsafeTypeCodec`1">
<summary>
This codec is for use with types that have <c>UnsafeTypeOps</c> operations defined.
Generally, this corresponds to numeric types that can be safely blitted.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.CodecFactory.BoolCodec">
<summary>
This is a boolean code that reads from a form that serialized
1 bit per value. The old encoding (implemented by a different codec)
uses 2 bits per value so NA values can be supported.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.CompressionKind">
<summary>
A code indicating the kind of compression. It is supposed that each kind of compression is totally
sufficient to describe how a given stream should be decompressed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.CompressionCodecExtension.CompressStream(Microsoft.ML.Data.IO.CompressionKind,System.IO.Stream)">
<summary>
Generate an appropriate wrapping compressing stream for the codec. This
stream will be closable and disposable, without closing or disposing of
the passed in stream. The scheme for compression is not in any way
parameterizable.
</summary>
<param name="compression">The compression codec</param>
<param name="stream">The stream to which compressed data will be written</param>
<returns>A stream to which the user can write uncompressed data</returns>
</member>
<member name="M:Microsoft.ML.Data.IO.CompressionCodecExtension.DecompressStream(Microsoft.ML.Data.IO.CompressionKind,System.IO.Stream)">
<summary>
Generate an appropriate wrapping decompressing stream for the codec.
</summary>
<param name="compression">The compression codec</param>
<param name="stream">The stream from which compressed data will be written</param>
<returns>A stream from which the user can read uncompressed data</returns>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.HeaderSize">
<summary>
The fixed header size. This should not be changed even in future versions of the format.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.SignatureValue">
<summary>
The header must start with this signature. This number will
appear as the eight-byte sequence "CML\0DVB\0" if encoded in
little-endian. (CML DVB is meant to suggest CloudML DataView binary).
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.TailSignatureValue">
<summary>
The file must end with this value. Is is simply the
byte-order-reversed version of the head signature.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.WriterVersion">
<summary>
The current version of the format this software can write.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.Signature">
<summary>
The magic number of this file.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.Version">
<summary>
Indicates the version of the data file.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.CompatibleVersion">
<summary>
Indicates the minimum reader version that can interpret this file, possibly
with some data loss.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.TableOfContentsOffset">
<summary>
The offset to the table of contents structure where the column type definitions
are stored.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.TailOffset">
<summary>
The eight-byte tail signature starts at this offset. So, the entire dataset
stream should be considered to have eight plus this value bytes.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.RowCount">
<summary>
The number of rows in this data file.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.Header.ColumnCount">
<summary>
The number of columns in this data file.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.IValueCodec">
<summary>
A value codec encapsulates implementations capable of writing and reading data of some
type to and from streams. The idea is that one creates a codec using <c>TryGetCodec</c>
on the appropriate <c>ColumnType</c>, then opens multiple writers to write blocks of data
to some stream. The idea is that each writer or reader is called on some "managable chunk"
of data.
Codecs should be thread safe, though the readers and writers they spawn do not need to
be thread safe.
</summary>
</member>
<member name="P:Microsoft.ML.Data.IO.IValueCodec.LoadName">
<summary>
This is the codec's identifying name. This is utilized both by the codec factory's
<c>WriteTypeDescription</c> and <c>TryGetCodec</c>, for persisting and recovering
the codec, respectively.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueCodec.WriteParameterization(System.IO.Stream)">
<summary>
Writes the codec parameterization to the stream. (The parameterization
is the third part of the codec type description, after the name, and length
of the parameterization.)
</summary>
<returns>The number of bytes written to the stream</returns>
</member>
<member name="P:Microsoft.ML.Data.IO.IValueCodec.Type">
<summary>
The column type for this codec.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.IValueCodec`1">
<summary>
The generic value codec.
</summary>
<typeparam name="T">The type for which we can spawn readers and writers.
Note that <c>Type.RawType == typeof(T)</c>.</typeparam>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueCodec`1.OpenWriter(System.IO.Stream)">
<summary>
Returns a writer for this codec, capable of writing a series of values to a block
starting at the current position of the indicated writable stream.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueCodec`1.OpenReader(System.IO.Stream,System.Int32)">
<summary>
Returns a reader for this codec, capable of reading a series of values to a block
starting at the current position of the indicated readable stream.
</summary>
<param name="stream">Stream on which we open reader.</param>
<param name="items">The number of items expected to be encoded in the block
starting from the current position of the stream. Implementors should, if
possible, throw if it seems if the block contains a different number of
elements.</param>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueWriter.Commit">
<summary>
Finishes writing to the stream. No further values should be written using the
<c>Write</c> methods. Note that failure to commit does not leave the stream in
a defined state: something or nothing could have already been written to the
stream, and the writer has no facilities to "rewind" whatever writes it may
have performed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueWriter.GetCommitLengthEstimate">
<summary>
Returns an estimate of the total length that would be written to the stream
were we to commit right now. This may be called very often in some circumstances,
so implementors should optimize for speed over accuracy.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.IValueWriter`1">
<summary>
A value writer on a particular type. The intent is that implementors of this will
be spawned from an <seealso cref="T:Microsoft.ML.Data.IO.IValueCodec"/>, its write methods called some
number of times to write to the stream, and then <c>Commit</c> will be called when
all values have been written, the stream now being at the end of the written block.
The intended usage of the value writers is that blocks are composed of some small
number of values (perhaps a few thousand), the idea being that a block is something
that should easily fit in main memory, both for reading and writing. Some writers
take advantage of this to organize their values for more efficient reading.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueWriter`1.Write(`0@)">
<summary>
Writes a single value to the writer.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueWriter`1.Write(System.ReadOnlySpan{`0})">
<summary>
Writes a span of values. This should be equivalent to writing each element
singly, though possibly more efficient than such a naive implementation.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.IValueReader`1">
<summary>
A value reader on a particular type. As with writers, implementors of this will be
spawned form an <seealso cref="T:Microsoft.ML.Data.IO.IValueCodec"/>. Its read methods will be called some
number of times to read from the stream. The read methods should be used to read
precisely the same number of times as was written to the block. if you read more,
then the values returned past the last will be undefined, and in either case the
stream will be left in an undefined state. Implementors may optionally complain in
such a case, but many will not, so outside knowledge should be used by the user
to ensure bad behavior does not happen. (For example, if you have a writer that
just writes packed binary values with no descriptive information, the corresponding
read will have no ability to tell when it is supposed to "end.")
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueReader`1.MoveNext">
<summary>
Moves to the next element.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueReader`1.Get(`0@)">
<summary>
Gets the current element.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.IValueReader`1.Read(`0[],System.Int32,System.Int32)">
<summary>
Reads into an array of values. This should be roughly equivalent to calling <c>MoveNext</c>
then <c>Get</c> into an array on each element singly, though possibly more efficient than
such a naive implementation. It may also diverge from that, in that <c>Get</c>'s behavior
before the next <c>MoveNext</c> is undefined when this function is called.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.MemoryStreamCollection.IndexFor(System.Int32)">
<summary>
Given a byte size, returns an appropriate index to <see cref="F:Microsoft.ML.Data.IO.MemoryStreamCollection._pools"/>.
This is a non-decreasing function w.r.t. <paramref name="maxSize"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TextSaver.ValueWriter.WriteData(System.Action{System.Text.StringBuilder,System.Int32},System.Int32@)">
<summary>
Write the data to the given stream. This requires that FetchData was previously called.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TextSaver.SeparatorCharToString(System.Char)">
<summary>
Returns the string representation of a separator: helpful if it's whitespace or a punctuation mark.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TextSaverUtils.MapText(System.ReadOnlySpan{System.Char},System.Text.StringBuilder@,System.Char)">
<summary>
Converts a ReadOnlySpan to a StringBuilder using TextSaver escaping and string quoting rules.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.TransposeLoader">
<summary>
The transposed loader reads the transposed binary format. This binary format, at a high level, is nothing more
than, for a dataview with "c" columns, "c+1" binary IDVs glued together. We call these sub-IDVs. The first of these,
the master sub-IDV stores the overall schema, and optionally the data in row-wise format.
</summary>
<seealso cref="T:Microsoft.ML.Data.IO.TransposeSaver"/>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.HeaderSize">
<summary>
The fixed header size. This should not be changed even in future versions of the format.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.SignatureValue">
<summary>
The header must start with this signature. This number will
appear as the eight-byte sequence "XPOSEDDV" if encoded in
little-endian. (XPOSEDDV is meant to suggest transposed DataView).
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.TailSignatureValue">
<summary>
The file must end with this value. Is is simply the
byte-order-reversed version of the head signature.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.WriterVersion">
<summary>
The current version of the format this software can write.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.Signature">
<summary>
The magic number of this file.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.Version">
<summary>
Indicates the version of the data file.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.CompatibleVersion">
<summary>
Indicates the minimum reader version that can interpret this file, possibly
with some data loss.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.SubIdvTableOffset">
<summary>
The offset to the list of the directory of the sub-IDV structures.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.TailOffset">
<summary>
The eight-byte tail signature starts at this offset. So, the entire dataset
stream should be considered to have eight plus this value bytes.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.RowCount">
<summary>
The number of rows.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.Header.ColumnCount">
<summary>
The number of columns. There will be this + 1 entries in the sub-IDV table
offset structure.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry">
<summary>
A sub-IDV entry corresponds to an offset and length within the transposed file, that points
either to a block binary-IDV formatted data if the offset is positive, or indicates that there
is no corresponding IDV entry if the offset is zero.
</summary>
</member>
<member name="P:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.HasDataView">
<summary>
Is true when this sub-IDV appears to exist, without actually loading that sub-IDV.
If this returns true, <see cref="M:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.GetViewOrNull"/> will either return a non-null
value, or throw some sort of formatting error.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.#ctor(Microsoft.ML.Data.IO.TransposeLoader,System.IO.BinaryReader)">
<summary>
Reads the table of contents entry from the file, advancing the binary loader stream.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.#ctor(Microsoft.ML.Data.IO.TransposeLoader)">
<summary>
Constructs an empty table of contents entry, with no offset.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.GetViewOrNull">
<summary>
Gets the dataview corresponding to this sub-IDV entry. This will
lazily load the file, if it has not previously been requested. This
will return <c>null</c> if the offset is 0.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.VerifyView(Microsoft.Data.DataView.IDataView)">
<summary>
Called once, to verify that the lazily read dataview is "correct." Called by
<see cref="M:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.GetViewOrNull"/> once it has been read. Any problems with the data-view
should be handle with <see cref="M:Microsoft.ML.Contracts.CheckDecode(System.Boolean)"/> or by throwing
<see cref="M:Microsoft.ML.Contracts.ExceptDecode"/>, as we consider the views not adhering to
standards to be a file formatting issue. Note that this will never be called if
the offset field is zero.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.SchemaSubIdv">
<summary>
This is the entry corresponding to the first IDV entry in the file, which will hold
at least the schema information for all columns. There should be one of these per
file. Optionally, this file can also hold the row-wise data stored as well, in case
the user wanted to have the hybrid row/slotwise store. For this one, it is illegal
for the offset to be zero.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.TransposedSubIdv">
<summary>
This is the entry corresponding to the transposed columns. There will be one of
these per column, though some entries will not actually have a corresponding
dataview (for example, they will have an offset of 0) if the column was not one selected
for slot-wise transposition.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TransposeLoader.SubIdvEntry.TransposedSubIdv.#ctor(Microsoft.ML.Data.IO.TransposeLoader,System.Int32)">
<summary>
Returns an empty sub-IDV entry for the no-file case.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.ReaderFirstVersion">
<summary>
Low inclusive bound of versions this reader can read.
</summary>
</member>
<member name="F:Microsoft.ML.Data.IO.TransposeLoader.ReaderVersion">
<summary>
Upper inclusive bound of versions this reader can read.
</summary>
</member>
<member name="P:Microsoft.ML.Data.IO.TransposeLoader.HasRowData">
<summary>
Whether the master schema sub-IDV has the actual data.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TransposeLoader.SaveSchema(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelSaveContext,Microsoft.Data.DataView.DataViewSchema)">
<summary>
Save a zero-row dataview that will be used to infer schema information, used in the case
where the tranpsose loader is instantiated with no input streams.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IO.TransposeLoader.Cursor.Init(System.Int32)">
<summary>
Initializes the transpose cursors and getters for a column.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IO.TransposeSaver">
<summary>
Saver for a format that can be loaded using the <see cref="T:Microsoft.ML.Data.IO.TransposeLoader"/>.
</summary>
<seealso cref="T:Microsoft.ML.Data.IO.TransposeLoader"/>
</member>
<member name="M:Microsoft.ML.Data.IO.TransposeSaver.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.IO.TransposeSaver.Arguments)">
<summary>
Constructs a saver for a data view.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CompositeDataLoader`2">
<summary>
This class represents a data loader that applies a transformer chain after loading.
It also has methods to save itself to a repository.
</summary>
</member>
<member name="F:Microsoft.ML.Data.CompositeDataLoader`2.Loader">
<summary>
The underlying data loader.
</summary>
</member>
<member name="F:Microsoft.ML.Data.CompositeDataLoader`2.Transformer">
<summary>
The chain of transformers (possibly empty) that are applied to data upon loading.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CompositeDataLoader`2.Load(`0)">
<summary>
Produce the data view from the specified input.
Note that <see cref="T:Microsoft.Data.DataView.IDataView"/>'s are lazy, so no actual loading happens here, just schema validation.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CompositeDataLoader`2.AppendTransformer``1(``0)">
<summary>
Append a new transformer to the end.
</summary>
<returns>The new composite data loader</returns>
</member>
<member name="M:Microsoft.ML.Data.CompositeDataLoader`2.SaveTo(Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Save the contents to a stream, as a "model file".
</summary>
</member>
<member name="T:Microsoft.ML.Data.CompositeDataLoader">
<summary>
Utility class to facilitate loading from a stream.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CompositeDataLoader.SaveTo``1(Microsoft.ML.IDataLoader{``0},Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Save the contents to a stream, as a "model file".
</summary>
</member>
<member name="M:Microsoft.ML.Data.CompositeDataLoader.LoadFrom(Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Load the pipeline from stream.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CompositeLoaderEstimator`2">
<summary>
An estimator class for composite data loader.
It can be used to build a 'trainable smart data loader', although this pattern is not very common.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CompositeLoaderEstimator`2.Append``1(Microsoft.ML.IEstimator{``0})">
<summary>
Create a new loader estimator, by appending another estimator to the end of this loader estimator.
</summary>
</member>
<member name="T:Microsoft.ML.Data.EstimatorChain`1">
<summary>
Represents a chain (potentially empty) of estimators that end with a <typeparamref name="TLastTransformer"/>.
If the chain is empty, <typeparamref name="TLastTransformer"/> is always <see cref="T:Microsoft.ML.ITransformer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EstimatorChain`1.#ctor">
<summary>
Create an empty estimator chain.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EstimatorChain`1.AppendCacheCheckpoint(Microsoft.ML.IHostEnvironment)">
<summary>
Append a 'caching checkpoint' to the estimator chain. This will ensure that the downstream estimators will be trained against
cached data. It is helpful to have a caching checkpoint before trainers that take multiple data passes.
</summary>
<param name="env">The host environment to use for caching.</param>
</member>
<member name="T:Microsoft.ML.Data.DataLoadSave.FakeSchemaFactory">
<summary>
A fake schema that is manufactured out of a SchemaShape.
It will pretend that all vector sizes are equal to 10, all key value counts are equal to 10,
and all values are defaults (for annotations).
</summary>
</member>
<member name="T:Microsoft.ML.Data.LegacyCompositeDataLoader">
<summary>
A data loader that wraps an underlying loader plus a sequence of transforms.
It is not valid to have nested <see cref="T:Microsoft.ML.Data.LegacyCompositeDataLoader"/>'s: if a <see cref="T:Microsoft.ML.Data.LegacyCompositeDataLoader"/>
is an underlying loader, the resulting loader will 'flatten' the structure.
The family of <c>Create</c> methods only instantiate <see cref="T:Microsoft.ML.Data.LegacyCompositeDataLoader"/>'s
when there are transforms to keep, otherwise they just return underlying loaders.
</summary>
</member>
<member name="P:Microsoft.ML.Data.LegacyCompositeDataLoader.View">
<summary>
Returns the underlying data view of the composite loader.
This can be used to programmatically explore the chain of transforms that's inside the composite loader.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.LegacyCompositeDataLoader.Arguments,Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Creates a loader according to the specified <paramref name="args"/>.
If there are transforms, then the result will be a <see cref="T:Microsoft.ML.Data.LegacyCompositeDataLoader"/>,
otherwise, it'll be whatever <see cref="T:Microsoft.ML.Data.ILegacyDataLoader"/> is specified in <c>args.loader</c>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ILegacyDataLoader,System.Collections.Generic.KeyValuePair{System.String,Microsoft.ML.IComponentFactory{Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.IDataTransform}}[])">
<summary>
Creates a <see cref="T:Microsoft.ML.Data.LegacyCompositeDataLoader"/> that starts with the <paramref name="srcLoader"/>,
and follows with transforms created from the <paramref name="transformArgs"/> array.
If there are no transforms, the <paramref name="srcLoader"/> is returned.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.ApplyTransforms(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ILegacyDataLoader,System.Collections.Generic.KeyValuePair{System.String,System.String}[],System.Func{Microsoft.ML.IHostEnvironment,System.Int32,Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.IDataView})">
<summary>
Appends transforms to the <paramref name="srcLoader"/> and returns a loader that contains these new transforms.
If there are no transforms to append, returns <paramref name="srcLoader"/> intact, otherwise creates a
<see cref="T:Microsoft.ML.Data.LegacyCompositeDataLoader"/>. The transforms are created by sequentially invoking the provided lambda,
one time for each element of <paramref name="tagData"/>.
</summary>
<param name="env">The host environment.</param>
<param name="srcLoader">The source loader.</param>
<param name="tagData">The array of (tag, creationInfo) pairs. Can be an empty array or null, in which case
the function returns <paramref name="srcLoader"/>.</param>
<param name="createTransform">The delegate to invoke at each transform creation.
Delegate parameters are: host environment, transform index (0 to <c>tagData.Length</c>), source data view.
It should return the <see cref="T:Microsoft.Data.DataView.IDataView"/> that should share the same loader as the source data view.</param>
<returns>The resulting data loader.</returns>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.ApplyTransform(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ILegacyDataLoader,System.String,System.String,System.Func{Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.IDataView})">
<summary>
Apply one transform to the data loader, and returns a (composite) data loader that contains the result.
The transform is created by invoking the lambda for a data source, and it should return an
<see cref="T:Microsoft.Data.DataView.IDataView"/> that shares the same loader as the provided source.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Loads the entire composite data loader (loader + transforms) from the context.
If there are no transforms, the underlying loader is returned.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.ML.Data.ILegacyDataLoader,System.Func{System.String,System.Boolean})">
<summary>
Creates a <see cref="T:Microsoft.ML.Data.ILegacyDataLoader"/> from the specified source loader, followed by
the transforms that are loaded from the <paramref name="ctx"/>, tags filtered by
by the <paramref name="isTransformTagAccepted"/>.
If the <paramref name="ctx"/> contains no accepted transforms, the <paramref name="srcLoader"/> is
returned intact.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.LoadSelectedTransforms(Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView,Microsoft.ML.IHostEnvironment,System.Func{System.String,System.Boolean})">
<summary>
Loads all transforms from the <paramref name="ctx"/> that pass the <paramref name="isTransformTagAccepted"/> test,
applies them sequentially to the <paramref name="srcView"/>, and returns the resulting data view.
If there are no transforms in <paramref name="ctx"/> that are accepted, returns the original <paramref name="srcView"/>.
The difference from the <c>Create</c> method above is that:
- it doesn't wrap the results into a loader, just returns the last transform in the chain.
- it accepts <see cref="T:Microsoft.Data.DataView.IDataView"/> as input, not necessarily a loader.
- it throws away the tag information.
- it doesn't throw if the context is not representing a <see cref="T:Microsoft.ML.Data.LegacyCompositeDataLoader"/>: in this case it's assumed that no transforms
meet the test, and the <paramref name="srcView"/> is returned.
Essentially, this is a helper method for the LoadTransform class.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.LoadTransforms(Microsoft.ML.ModelLoadContext,Microsoft.ML.Data.ILegacyDataLoader,Microsoft.ML.IHost,System.Func{System.String,System.Boolean})">
<summary>
Loads all transforms from the <paramref name="ctx"/> that pass the <paramref name="isTransformTagAccepted"/> test,
applies them sequentially to the <paramref name="srcLoader"/>, and returns the (composite) data loader.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LegacyCompositeDataLoader.SavePipe(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelSaveContext,System.Action{Microsoft.ML.ModelSaveContext},System.Collections.Generic.IList{Microsoft.ML.Data.IDataTransform})">
<summary>
Save the loader and transforms (if any) to the repository.
This is intended to be used by API, where the components are not part of the same
<see cref="T:Microsoft.ML.Data.LegacyCompositeDataLoader"/>.
</summary>
<param name="env">Environment context</param>
<param name="ctx">The context to write to.</param>
<param name="loaderSaveAction">The code to save the loader.</param>
<param name="transforms">The transforms. Empty list and null are both allowed.</param>
</member>
<member name="T:Microsoft.ML.Data.MultiFileSource">
<summary>
Wraps a potentially compound path as an IMultiStreamSource.
</summary>
<remarks>Expands wild cards and supports multiple paths separated by +, or loads all the files of a subfolder,
if the syntax for the path is 'FolderPath/...' (separator would be OS relevant).
</remarks>
</member>
<member name="M:Microsoft.ML.Data.MultiFileSource.#ctor(System.String[])">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Data.MultiFileSource"/>.
In case of usage from Maml, the paths would be wildcard concatenated in the first string of <paramref name="paths"/>.
</summary>
<param name="paths">The paths of the files to load.</param>
</member>
<member name="T:Microsoft.ML.Data.FileHandleSource">
<summary>
Wraps an <see cref="T:Microsoft.ML.IFileHandle"/> as an IMultiStreamSource.
</summary>
</member>
<member name="T:Microsoft.ML.Data.BlockingQueue`1">
<summary>Provides a thread-safe queue that supports blocking takes when empty and blocking adds when full.</summary>
<typeparam name="T">Specifies the type of data contained.</typeparam>
</member>
<member name="F:Microsoft.ML.Data.BlockingQueue`1._queue">
<summary>The underlying queue storing all elements.</summary>
</member>
<member name="F:Microsoft.ML.Data.BlockingQueue`1._itemsAvailable">
<summary>A semaphore that can be waited on to know when an item is available for taking.</summary>
</member>
<member name="F:Microsoft.ML.Data.BlockingQueue`1._spaceAvailable">
<summary>A semaphore that can be waited on to know when space is available for adding.</summary>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.#ctor(System.Int32)">
<summary>Initializes the blocking queue.</summary>
<param name="boundedCapacity">The maximum number of items the queue may contain.</param>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.Dispose">
<summary>Cleans up all resources used by the blocking collection.</summary>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.TryAdd(`0,System.Int32)">
<summary>Adds an item to the blocking collection.</summary>
<param name="item">The item to add.</param>
<param name="millisecondsTimeout">The time to wait, in milliseconds, or -1 to wait indefinitely.</param>
<returns>
true if the item was successfully added; false if the timeout expired or if the collection were marked
as complete for adding before the item could be added.
</returns>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.TryTake(`0@,System.Int32)">
<summary>Tries to take an item from the blocking collection.</summary>
<param name="item">The item removed, or default if none could be taken.</param>
<param name="millisecondsTimeout">The time to wait, in milliseconds, or -1 to wait indefinitely.</param>
<returns>
true if the item was successfully taken; false if the timeout expired or if the collection is empty
and has been marked as complete for adding.
</returns>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.GetConsumingEnumerable">
<summary>
Gets an enumerable for taking all items out of the collection until
the collection has been marked as complete for adding and is empty.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.CompleteAdding">
<summary>Mark the collection as complete for adding.</summary>
<remarks>After this is called, no calls made on this queue will block.</remarks>
</member>
<member name="T:Microsoft.ML.Data.BlockingQueue`1.CompletableSemaphore">
<summary>
A basic monitor-based semaphore that, in addition to standard Wait/Release semantics,
also supports marking the semaphore as completed, in which case all waiters immediately
fail if there's no count remaining.
</summary>
</member>
<member name="F:Microsoft.ML.Data.BlockingQueue`1.CompletableSemaphore._count">
<summary>The remaining count in the semaphore.</summary>
</member>
<member name="F:Microsoft.ML.Data.BlockingQueue`1.CompletableSemaphore._waiters">
<summary>The number of threads currently waiting in Wait.</summary>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.CompletableSemaphore.#ctor(System.Int32)">
<summary>Initializes the semaphore with the specified initial count.</summary>
<param name="initialCount">The initial count.</param>
</member>
<member name="P:Microsoft.ML.Data.BlockingQueue`1.CompletableSemaphore.Completed">
<summary>Gets whether the semaphore has been marked as completed.</summary>
<remarks>
If completed, no calls to Wait will block; if no count remains, regardless of timeout, Waits will
return immediately with a result of false.
</remarks>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.CompletableSemaphore.Release">
<summary>Releases the semaphore once.</summary>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.CompletableSemaphore.Wait(System.Int32)">
<summary>Blocks the current thread until it can enter the semaphore once.</summary>
<param name="millisecondsTimeout">The maximum amount of time to wait to enter the semaphore, or -1 to wait indefinitely.</param>
<returns>true if the semaphore was entered; otherwise, false.</returns>
</member>
<member name="M:Microsoft.ML.Data.BlockingQueue`1.CompletableSemaphore.Complete">
<summary>Marks the semaphore as completed, such that no further operations will block.</summary>
</member>
<member name="T:Microsoft.ML.Data.LoadColumnAttribute">
<summary>
Allow member to specify mapping to field(s) in text file.
To override name of <see cref="T:Microsoft.Data.DataView.IDataView"/> column use <see cref="T:Microsoft.ML.Data.ColumnNameAttribute"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LoadColumnAttribute.#ctor(System.Int32)">
<summary>
Maps member to specific field in text file.
</summary>
<param name="fieldIndex">The index of the field in the text file.</param>
</member>
<member name="M:Microsoft.ML.Data.LoadColumnAttribute.#ctor(System.Int32,System.Int32)">
<summary>
Maps member to range of fields in text file.
</summary>
<param name="start">The starting field index, for the range.</param>
<param name="end">The ending field index, for the range.</param>
</member>
<member name="M:Microsoft.ML.Data.LoadColumnAttribute.#ctor(System.Int32[])">
<summary>
Maps member to set of fields in text file.
</summary>
<param name="columnIndexes">Distinct text file field indices to load as part of this column.</param>
</member>
<member name="T:Microsoft.ML.Data.TextLoader">
<summary>
Loads a text file into an IDataView. Supports basic mapping from input columns to <see cref="T:Microsoft.Data.DataView.IDataView"/> columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.Column">
<summary>
Describes how an input column should be mapped to an <see cref="T:Microsoft.Data.DataView.IDataView"/> column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Column.#ctor">
<summary>
Describes how an input column should be mapped to an <see cref="T:Microsoft.Data.DataView.IDataView"/> column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Column.#ctor(System.String,Microsoft.ML.Data.DataKind,System.Int32)">
<summary>
Describes how an input column should be mapped to an <see cref="T:Microsoft.Data.DataView.IDataView"/> column.
</summary>
<param name="name">Name of the column.</param>
<param name="dataKind"><see cref="T:Microsoft.ML.Data.DataKind"/> of the items in the column.</param>
<param name="index">Index of the column.</param>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Column.#ctor(System.String,Microsoft.ML.Data.DataKind,System.Int32,System.Int32)">
<summary>
Describes how an input column should be mapped to an <see cref="T:Microsoft.Data.DataView.IDataView"/> column.
</summary>
<param name="name">Name of the column.</param>
<param name="dataKind"><see cref="T:Microsoft.ML.Data.DataKind"/> of the items in the column.</param>
<param name="minIndex">The minimum inclusive index of the column.</param>
<param name="maxIndex">The maximum-inclusive index of the column.</param>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Column.#ctor(System.String,Microsoft.ML.Data.DataKind,Microsoft.ML.Data.TextLoader.Range[],Microsoft.ML.Data.KeyCount)">
<summary>
Describes how an input column should be mapped to an <see cref="T:Microsoft.Data.DataView.IDataView"/> column.
</summary>
<param name="name">Name of the column.</param>
<param name="dataKind"><see cref="T:Microsoft.ML.Data.DataKind"/> of the items in the column.</param>
<param name="source">Source index range(s) of the column.</param>
<param name="keyCount">For a key column, this defines the range of values.</param>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Column.#ctor(System.String,Microsoft.ML.Data.InternalDataKind,Microsoft.ML.Data.TextLoader.Range[],Microsoft.ML.Data.KeyCount)">
<summary>
Describes how an input column should be mapped to an <see cref="T:Microsoft.Data.DataView.IDataView"/> column.
</summary>
<param name="name">Name of the column.</param>
<param name="kind"><see cref="T:Microsoft.ML.Data.InternalDataKind"/> of the items in the column.</param>
<param name="source">Source index range(s) of the column.</param>
<param name="keyCount">For a key column, this defines the range of values.</param>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Column.Name">
<summary>
Name of the column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Column.Type">
<summary>
<see cref="T:Microsoft.ML.Data.InternalDataKind"/> of the items in the column. It defaults to float.
Although <see cref="T:Microsoft.ML.Data.InternalDataKind"/> is internal, <see cref="F:Microsoft.ML.Data.TextLoader.Column.Type"/>'s information can be publically accessed by <see cref="P:Microsoft.ML.Data.TextLoader.Column.DataKind"/>.
</summary>
</member>
<member name="P:Microsoft.ML.Data.TextLoader.Column.DataKind">
<summary>
<see cref="T:Microsoft.ML.Data.DataKind"/> of the items in the column.
</summary>
It's a public interface to access the information in an internal DataKind.
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Column.Source">
<summary>
Source index range(s) of the column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Column.KeyCount">
<summary>
For a key column, this defines the range of values.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Column.IsValid">
<summary>
Returns <c>true</c> iff the ranges are disjoint, and each range satisfies 0 <= min <= max.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.Range">
<summary>
Specifies the range of indices of input columns that should be mapped to an output column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Range.#ctor(System.Int32)">
<summary>
A range representing a single value. Will result in a scalar column.
</summary>
<param name="index">The index of the field of the text file to read.</param>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Range.#ctor(System.Int32,System.Nullable{System.Int32})">
<summary>
A range representing a set of values. Will result in a vector column.
</summary>
<param name="min">The minimum inclusive index of the column.</param>
<param name="max">The maximum-inclusive index of the column. If <c>null</c>
indicates that the <see cref="T:Microsoft.ML.Data.TextLoader"/> should auto-detect the legnth
of the lines, and read untill the end.</param>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Range.Min">
<summary>
The minimum index of the column, inclusive.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Range.Max">
<summary>
The maximum index of the column, inclusive. If <see langword="null"/>
indicates that the <see cref="T:Microsoft.ML.Data.TextLoader"/> should auto-detect the legnth
of the lines, and read untill the end.
If max is specified, the fields <see cref="F:Microsoft.ML.Data.TextLoader.Range.AutoEnd"/> and <see cref="F:Microsoft.ML.Data.TextLoader.Range.VariableEnd"/> are ignored.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Range.AutoEnd">
<summary>
Whether this range extends to the end of the line, but should be a fixed number of items.
If <see cref="F:Microsoft.ML.Data.TextLoader.Range.Max"/> is specified, the fields <see cref="F:Microsoft.ML.Data.TextLoader.Range.AutoEnd"/> and <see cref="F:Microsoft.ML.Data.TextLoader.Range.VariableEnd"/> are ignored.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Range.VariableEnd">
<summary>
Whether this range extends to the end of the line, which can vary from line to line.
If <see cref="F:Microsoft.ML.Data.TextLoader.Range.Max"/> is specified, the fields <see cref="F:Microsoft.ML.Data.TextLoader.Range.AutoEnd"/> and <see cref="F:Microsoft.ML.Data.TextLoader.Range.VariableEnd"/> are ignored.
If <see cref="F:Microsoft.ML.Data.TextLoader.Range.AutoEnd"/> is <see langword="true"/>, then <see cref="F:Microsoft.ML.Data.TextLoader.Range.VariableEnd"/> is ignored.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Range.AllOther">
<summary>
Whether this range includes only other indices not specified.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Range.ForceVector">
<summary>
Force scalar columns to be treated as vectors of length one.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.Options">
<summary>
The settings for <see cref="T:Microsoft.ML.Data.TextLoader"/>
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.AllowQuoting">
<summary>
Whether the input may include quoted values, which can contain separator characters, colons,
and distinguish empty values from missing values. When true, consecutive separators denote a
missing value and an empty value is denoted by \"\". When false, consecutive separators denote an empty value.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.AllowSparse">
<summary>
Whether the input may include sparse representations.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.InputSize">
<summary>
Number of source columns in the text data. Default is that sparse rows contain their size information.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.Separators">
<summary>
The characters that should be used as separators column separator.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.Columns">
<summary>
Specifies the input columns that should be mapped to <see cref="T:Microsoft.Data.DataView.IDataView"/> columns.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.TrimWhitespace">
<summary>
Wheter to remove trailing whitespace from lines.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.HasHeader">
<summary>
Whether the data file has a header with feature names.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.UseThreads">
<summary>
Whether to use separate parsing threads.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.HeaderFile">
<summary>
File containing a header with feature names. If specified, the header defined in the data file is ignored regardless of <see cref="F:Microsoft.ML.Data.TextLoader.Options.HasHeader"/>.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Options.MaxRows">
<summary>
Maximum number of rows to produce.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Options.IsValid">
<summary>
Checks that all column specifications are valid (that is, ranges are disjoint and have min<=max).
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.Segment">
<summary>
Used as an input column range.
A variable length segment (extending to the end of the input line) is represented by Lim == SrcLim.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Segment.#ctor(System.Int32,System.Int32,System.Boolean)">
<summary>
Be careful with this ctor. lim == SrcLim means that this segment extends to
the end of the input line. If that is not the intent, pass in Min(lim, SrcLim - 1).
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Segment.#ctor(System.Int32)">
<summary>
Defines a segment that extends from min to the end of input.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.ColInfo">
<summary>
Information for an output column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Bindings.Infos">
<summary>
<see cref="F:Microsoft.ML.Data.TextLoader.Bindings.Infos"/>[i] stores the i-th column's name and type. Columns are loaded from the input text file.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Bindings._slotNames">
<summary>
<see cref="F:Microsoft.ML.Data.TextLoader.Bindings.Infos"/>[i] stores the i-th column's metadata, named <see cref="F:Microsoft.ML.Data.AnnotationUtils.Kinds.SlotNames"/>
in <see cref="T:Microsoft.Data.DataView.DataViewSchema.Annotations"/>.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.Bindings._header">
<summary>
Empty if <see cref="F:Microsoft.ML.Data.TextLoader.Options.HasHeader"/> is <see langword="false"/>, no header presents, or upon load
there was no header stored in the model.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.OptionFlags">
<summary>
Option flags. These values are serialized, so changing the values requires
bumping the version number.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.TextLoader.Options,Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Loads a text file into an <see cref="T:Microsoft.Data.DataView.IDataView"/>. Supports basic mapping from input columns to IDataView columns.
</summary>
<param name="env">The environment to use.</param>
<param name="options">Defines the settings of the load operation.</param>
<param name="dataSample">Allows to expose items that can be used for loading.</param>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.TryParseSchema(Microsoft.ML.IHost,Microsoft.ML.Data.IMultiStreamSource,Microsoft.ML.Data.TextLoader.Options@,Microsoft.ML.Data.TextLoader.Column[]@,System.Boolean@)">
<summary>
See if we can extract valid arguments from the first data file. If so, update options and set cols to the combined set of columns.
If not, set error to true if there was an error condition.
</summary>
<remarks>
Not all arguments are extracted from the data file. There are three arguments that can vary from iteration to iteration and that are set
directly by the user in the options class. These three arguments are:
<see cref="F:Microsoft.ML.Data.TextLoader.Options.UseThreads"/>,
<see cref="F:Microsoft.ML.Data.TextLoader.Options.HeaderFile"/>,
<see cref="F:Microsoft.ML.Data.TextLoader.Options.MaxRows"/>
</remarks>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.FileContainsValidSchema(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.IMultiStreamSource,Microsoft.ML.Data.TextLoader.Options@)">
<summary>
Checks whether the source contains the valid TextLoader.Options depiction.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.LoadFile(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.TextLoader.Options,Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Convenience method to create a <see cref="T:Microsoft.ML.Data.TextLoader"/> and use it to load a specified file.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.GetOutputSchema">
<summary>
The output <see cref="T:Microsoft.Data.DataView.DataViewSchema"/> that will be produced by the loader.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Load(Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Loads data from <paramref name="source"/> into an <see cref="T:Microsoft.Data.DataView.IDataView"/>.
</summary>
<param name="source">The source from which to load data.</param>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Cursor.GetEmbeddedArgs(Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Look in the first file for args embedded as comments. This gathers comments
that come before any data line that start with #@.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.ValueCreatorCache">
<summary>
This type exists to provide efficient delegates for creating a ColumnValue specific to a DataKind.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.ParseStats">
<summary>
Basic statistics and reporting of unparsable stuff.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.RowSet.#ctor(Microsoft.ML.Data.TextLoader.ParseStats,System.Int32,System.Int32)">
<summary>
Takes the number of blocks, number of rows per block, and number of columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.ScanInfo">
<summary>
This is info tracked while scanning a line to find "fields". For each line, the first
several values, Path, Line, LineText, IchMinText, and IchLimText, are unchanging, but the
remaining values are updated for each field processed.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.Path">
<summary>
Path for the input file containing the given line (may be null).
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.Line">
<summary>
Line number.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.TextBuf">
<summary>
The current text for the entire line (all fields), and possibly more.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.IchMinBuf">
<summary>
The min position in <see cref="F:Microsoft.ML.Data.TextLoader.ScanInfo.TextBuf"/> to consider (all fields).
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.IchLimBuf">
<summary>
The lim position in <see cref="F:Microsoft.ML.Data.TextLoader.ScanInfo.TextBuf"/> to consider (all fields).
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.IchMinNext">
<summary>
Where to start for the next field. This is both an input and
output to the code that fetches the next field.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.Span">
<summary>
The (unquoted) text of the field.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.QuotingError">
<summary>
Whether there was a quoting error in the field.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.Index">
<summary>
For sparse encoding, this is the index of the field. Otherwise, -1.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.IchMin">
<summary>
The start character location in <see cref="F:Microsoft.ML.Data.TextLoader.ScanInfo.TextBuf"/>, including the sparse index
and quoting, if present. Used for logging.
</summary>
</member>
<member name="F:Microsoft.ML.Data.TextLoader.ScanInfo.IchLim">
<summary>
The end character location in <see cref="F:Microsoft.ML.Data.TextLoader.ScanInfo.TextBuf"/>, including the sparse index
and quoting, if present. Used for logging.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.ScanInfo.#ctor(System.ReadOnlyMemory{System.Char}@,System.String,System.Int64)">
<summary>
Initializes the ScanInfo.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.Parser.FieldSet">
<summary>
This holds a set of raw text fields. This is the input into the parsing
of the individual typed values.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Parser.FieldSet.EnsureSpace">
<summary>
Make sure there is enough space to add one more item.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Parser.TrimEndWhiteSpace(System.ReadOnlyMemory{System.Char},System.ReadOnlySpan{System.Char})">
<summary>
Returns a <see cref="T:System.ReadOnlyMemory`1"/> of <see cref="T:System.Char"/> with trailing whitespace trimmed.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TextLoader.Parser.Helper">
<summary>
This is an abstraction containing all the useful stuff for splitting a raw line of text
into a FieldSet. A cursor has one of these that it passes in whenever it wants a line
parsed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Parser.HelperImpl.IsSep(System.Char)">
<summary>
Check if the given char is a separator.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TextLoader.Parser.HelperImpl.GatherFields(System.ReadOnlyMemory{System.Char},System.ReadOnlySpan{System.Char},System.String,System.Int64)">
<summary>
Process the line of text into fields, stored in the Fields field. Ensures that sparse
don't precede non-sparse. Returns the lim of the src columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TransformerScope">
<summary>
This enum allows for 'tagging' the estimators (and subsequently transformers) in the chain to be used
'only for training', 'for training and evaluation' etc.
Most notable example is, transformations over the label column should not be used for scoring, so the scope
should be <see cref="F:Microsoft.ML.Data.TransformerScope.Training"/> or <see cref="F:Microsoft.ML.Data.TransformerScope.TrainTest"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ITransformerChainAccessor">
<summary>
Used to determine if <see cref="T:Microsoft.ML.ITransformer"/> object is of type <see cref="T:Microsoft.ML.Data.TransformerChain"/>
so that its internal fields can be accessed.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TransformerChain`1">
<summary>
A chain of transformers (possibly empty) that end with a <typeparamref name="TLastTransformer"/>.
For an empty chain, <typeparamref name="TLastTransformer"/> is always <see cref="T:Microsoft.ML.ITransformer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TransformerChain`1.#ctor(System.Collections.Generic.IEnumerable{Microsoft.ML.ITransformer},System.Collections.Generic.IEnumerable{Microsoft.ML.Data.TransformerScope})">
<summary>
Create a transformer chain by specifying transformers and their scopes.
</summary>
<param name="transformers">Transformers to be chained.</param>
<param name="scopes">Transformer scopes, parallel to <paramref name="transformers"/>.</param>
</member>
<member name="M:Microsoft.ML.Data.TransformerChain`1.#ctor(Microsoft.ML.ITransformer[])">
<summary>
Create a transformer chain by specifying all the transformers. The scopes are assumed to be
<see cref="F:Microsoft.ML.Data.TransformerScope.Everything"/>.
</summary>
<param name="transformers"></param>
</member>
<member name="M:Microsoft.ML.Data.TransformerChain`1.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext)">
<summary>
The loading constructor of transformer chain. Reverse of <see cref="M:Microsoft.ML.ICanSaveModel.Save(Microsoft.ML.ModelSaveContext)"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TransformerChain">
<summary>
Saving/loading routines for transformer chains.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TransformerChain.SaveTo(Microsoft.ML.ITransformer,Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Save any transformer to a stream by wrapping it into a transformer chain.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TrainedWrapperEstimatorBase">
<summary>
Estimator for trained wrapped transformers.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TrivialEstimator`1">
<summary>
The trivial implementation of <see cref="T:Microsoft.ML.IEstimator`1"/> that already has
the transformer and returns it on every call to <see cref="M:Microsoft.ML.Data.TrivialEstimator`1.Fit(Microsoft.Data.DataView.IDataView)"/>.
Concrete implementations still have to provide the schema propagation mechanism, since
there is no easy way to infer it from the transformer.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TrivialLoaderEstimator`2">
<summary>
The trivial wrapper for a <see cref="T:Microsoft.ML.IDataLoader`1"/> that acts as an estimator and ignores the source.
</summary>
</member>
<member name="T:Microsoft.ML.Data.AppendRowsDataView">
<summary>
This class provides the functionality to combine multiple IDataView objects which share the same schema
All sources must contain the same number of columns and their column names, sizes, and item types must match.
The row count of the resulting IDataView will be the sum over that of each individual.
An AppendRowsDataView instance is shuffleable iff all of its sources are shuffleable and their row counts are known.
</summary>
</member>
<member name="M:Microsoft.ML.Data.AppendRowsDataView.Create(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.DataViewSchema,Microsoft.Data.DataView.IDataView[])">
<summary>
Create a dataview by appending the rows of the sources.
All sources must be consistent with the passed-in schema in the number of columns, column names,
and column types. If schema is null, the first source's schema will be used.
</summary>
<param name="env">The host environment.</param>
<param name="schema">The schema for the result. If this is null, the first source's schema will be used.</param>
<param name="sources">The sources to be appended.</param>
<returns>The resulting IDataView.</returns>
</member>
<member name="T:Microsoft.ML.Data.AppendRowsDataView.Cursor">
<summary>
The deterministic cursor. It will scan through the sources sequentially.
</summary>
</member>
<member name="T:Microsoft.ML.Data.AppendRowsDataView.RandCursor">
<summary>
A RandCursor will ask each subordinate cursor to shuffle itself.
Then, at each step, it randomly calls a subordinate to move next with probability (roughly) proportional to
the number of the subordinate's remaining rows.
</summary>
</member>
<member name="T:Microsoft.ML.Data.AppendRowsDataView.MultinomialWithoutReplacementSampler">
<summary>
Given k classes with counts (N_0, N_2, N_3, ..., N_{k-1}), the goal of this sampler is to select the i-th
class with probability N_i/M, where M = N_0 + N_1 + ... + N_{k-1}.
Once the i-th class is selected, its count will be updated to N_i - 1.
For efficiency consideration, the sampling distribution is only an approximation of the desired distribution.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ArrayDataViewBuilder">
<summary>
This is a class for composing an in memory IDataView.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.CheckLength``1(System.String,``0[])">
<summary>
Verifies that the input array to one of the add routines is of the same length
as previously added arrays, assuming there were any.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn``1(System.String,Microsoft.Data.DataView.PrimitiveDataViewType,``0[])">
<summary>
Constructs a new column from an array where values are copied to output simply
by being assigned. Output values are returned simply by being assigned, so the
type <typeparamref name="T"/> should be a type where assigning to a different
value does not compromise the immutability of the source object (so, for example,
a scalar, string, or <c>ReadOnlyMemory</c> would be perfectly acceptable, but a
<c>HashSet</c> or <c>VBuffer</c> would not be).
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn``1(System.String,Microsoft.Data.DataView.ValueGetter{Microsoft.ML.Data.VBuffer{System.ReadOnlyMemory{System.Char}}},System.UInt64,``0[])">
<summary>
Constructs a new key column from an array where values are copied to output simply
by being assigned.
</summary>
<param name="name">The name of the column.</param>
<param name="getKeyValues">The delegate that does a reverse lookup based upon the given key. This is for annotation creation</param>
<param name="keyCount">The count of unique keys specified in values</param>
<param name="values">The values to add to the column. Note that since this is creating a <see cref="T:Microsoft.ML.Data.KeyType"/> column, the values will be offset by 1.</param>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn``1(System.String,Microsoft.Data.DataView.ValueGetter{Microsoft.ML.Data.VBuffer{System.ReadOnlyMemory{System.Char}}},Microsoft.Data.DataView.PrimitiveDataViewType,``0[][])">
<summary>
Creates a column with slot names from arrays. The added column will be re-interpreted as a buffer.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn``1(System.String,Microsoft.Data.DataView.PrimitiveDataViewType,``0[][])">
<summary>
Creates a column from arrays. The added column will be re-interpreted as a buffer.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn``1(System.String,Microsoft.Data.DataView.ValueGetter{Microsoft.ML.Data.VBuffer{System.ReadOnlyMemory{System.Char}}},Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.ML.Data.Combiner{``0},``0[][])">
<summary>
Creates a column with slot names from arrays. The added column will be re-interpreted as a buffer and possibly sparsified.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn``1(System.String,Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.ML.Data.Combiner{``0},``0[][])">
<summary>
Creates a column from arrays. The added column will be re-interpreted as a buffer and possibly sparsified.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn``1(System.String,Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.ML.Data.VBuffer{``0}[])">
<summary>
Adds a VBuffer{T} valued column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn``1(System.String,Microsoft.Data.DataView.ValueGetter{Microsoft.ML.Data.VBuffer{System.ReadOnlyMemory{System.Char}}},Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.ML.Data.VBuffer{``0}[])">
<summary>
Adds a VBuffer{T} valued column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.AddColumn(System.String,System.String[])">
<summary>
Adds a <c>ReadOnlyMemory</c> valued column from an array of strings.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.GetDataView(System.Nullable{System.Int32})">
<summary>
Constructs a data view from the columns added so far. Note that it is perfectly acceptable
to continue adding columns to the builder, but these additions will not be reflected in the
returned dataview.
</summary>
<param name="rowCount"></param>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.Column`1.CopyOut(System.Int32,`0@)">
<summary>
Produce the output value given the index.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.Column`2.CopyOut(`0@,`1@)">
<summary>
Assigns dst in such a way that the caller has ownership of <c>dst</c> without
compromising this object's ownership of <c>src</c>. What that operation will be
will depend on the types.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.Column`2.CopyOut(System.Int32,`1@)">
<summary>
Produce the output value given the index. This overload utilizes the <c>CopyOut</c>
helper function.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ArrayDataViewBuilder.AssignmentColumn`1">
<summary>
A column where the input and output types are the same, and simple assignment does
not compromise ownership of the internal vlaues.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ArrayDataViewBuilder.StringToTextColumn">
<summary>
A convenience column for converting strings into textspans.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ArrayDataViewBuilder.VectorColumn`2.InferType(Microsoft.Data.DataView.PrimitiveDataViewType,`0[],System.Func{`0,System.Int32})">
<summary>
A utility function for subclasses that want to get the type with a dimension based
on the input value array and some length function over the input type.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ArrayDataViewBuilder.VBufferColumn`1">
<summary>
A column of buffers.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView">
<summary>
This is a dataview that wraps another dataview, and does on-demand caching of the
input columns. When constructed, it caches no data. Whenever a cursor is constructed
that requests a column that has not yet been cached, any requested uncached columns
become cached through a background thread worker. A user can provide a hint to the
constructor to indicate that some columns should be pre-cached. A cursor over this
dataview will block when moved to a row until such time as all requested columns
have that row in cache.
</summary>
</member>
<member name="F:Microsoft.ML.Data.CacheDataView._cacheLock">
<summary>
Cursors can be opened from multiple threads simultaneously, so this is used to
synchronize both at the level of ensuring that only one cache is created per
column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.CacheDataView._cacheFillerThreads">
<summary>
Filler threads. Currently nothing is done with them. Possibly it may be good
practice to join against them somehow, but IDataViews as this stage are not
disposed, so it's unclear what would actually have the job of joining against
them.
</summary>
</member>
<member name="F:Microsoft.ML.Data.CacheDataView._caches">
<summary>
One cache per column. If this column is not being cached or has been cached,
this column will be null.
</summary>
</member>
<member name="F:Microsoft.ML.Data.CacheDataView._cacheDefaultWaiter">
<summary>
A waiter used for cursors where no columns are actually requested but it's still
necessary to wait to determine the number of rows.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Int32[])">
<summary>
Constructs an on demand cache for the input.
</summary>
<param name="env">The host environment</param>
<param name="input">The input dataview to cache. Note that if we do not know
how to cache some columns, these columns will not appear in this dataview.</param>
<param name="prefetch">A list of column indices the cacher should frontload,
prior to any cursors being requested. This can be null to indicate no
prefetching.</param>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.SelectCachableColumns(Microsoft.Data.DataView.IDataView,Microsoft.ML.IHostEnvironment,System.Int32[]@,System.Int32[]@)">
<summary>
Since shuffling requires serving up items potentially out of order we need to know
how to save and then copy out values that we read. This transform knows how to save
and copy out only primitive and vector valued columns, but nothing else, so any
other columns are dropped.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.MapInputToCacheColumnIndex(System.Int32)">
<summary>
While in typical cases the cache data view will know how to cache all columns,
the cache data view may not know how to cache certain custom types. User code
may require a mapping from input data view to cache data view column index space.
</summary>
<param name="inputIndex">An input data column index</param>
<returns>The column index of the corresponding column in the cache data view
if this was cachable, or else -1 if the column was not cachable</returns>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.GetRowCount">
<summary>
Return the number of rows if available.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.GetPermutationOrNull(System.Random)">
<summary>
Returns a permutation or null. This function will return null if either <paramref name="rand"/>
is null, or if the row count of this cache exceeds the maximum array size.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.KickoffFiller(System.Int32[])">
<summary>
This is a helper method that, given a list of columns, determines the subset
that are uncached, and if there are any uncached kicks off a filler worker to
fill them in, over a row cursor over this subset of columns.
</summary>
<param name="columns">The requested set of columns</param>
<seealso cref="M:Microsoft.ML.Data.CacheDataView.Filler(Microsoft.Data.DataView.DataViewRowCursor,Microsoft.ML.Data.CacheDataView.ColumnCache[],Microsoft.ML.Internal.Utilities.OrderedWaiter)"/>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.Filler(Microsoft.Data.DataView.DataViewRowCursor,Microsoft.ML.Data.CacheDataView.ColumnCache[],Microsoft.ML.Internal.Utilities.OrderedWaiter)">
<summary>
The actual body of the filler worker. The filler worker works fairly simply:
for each row, it tells each <see cref="T:Microsoft.ML.Data.CacheDataView.ColumnCache"/> instance in
<paramref name="caches"/> to fill in the value at the current position,
then increments the <paramref name="waiter"/>, then moves to the next row.
When it's done, it tells <see cref="T:Microsoft.ML.Data.CacheDataView.ColumnCache"/> to "freeze" itself, since
there should be no more rows.
<param name="cursor">The cursor over the rows to cache</param>
<param name="caches">The caches we must fill and, at the end of the cursor, freeze</param>
<param name="waiter">The waiter to increment as we cache each additional row</param>
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.Wait">
<summary>
Joins all the cache filler threads. This method is currently supposed to be called only by tests.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.IWaiter.Wait(System.Int64)">
<summary>
Blocks until that position is either available, or it has been
determined no such position exists. Implicit in a true return value
for this is that any values of <paramref name="pos"/> less than are
also true, that is, if one waits on <c>i</c>, when this returns it
is equivalent to also having waited on <c>i-1</c>, <c>i-2</c>, etc.
Note that this is position within the cache, that is, a row index,
as opposed to position within the cursor.
This method should be thread safe because in the parallel cursor
case it will be used by multiple threads.
</summary>
<param name="pos">The position to wait for, must be positive</param>
<returns>True if the position can be accessed, false if not</returns>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView.TrivialWaiter">
<summary>
A waiter for use in situations where there is no real waiting, per se, just a row limit.
This should be instantiated only if the analogous <see cref="P:Microsoft.ML.Data.CacheDataView.WaiterWaiter.IsTrivial"/>
returned true.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView.WaiterWaiter">
<summary>
A waiter that determines the necessary waiters for a set of active columns, and waits
on all of them.
</summary>
</member>
<member name="P:Microsoft.ML.Data.CacheDataView.WaiterWaiter.IsTrivial">
<summary>
If this is true, then a <see cref="T:Microsoft.ML.Data.CacheDataView.TrivialWaiter"/> could be used instead.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView.IIndex">
<summary>
A collection of different simple objects that track the index into the cache at
particular location. Note that this index is, in the shuffled or parallel case,
very different from the position of the cursor that keeps this indexer.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.IIndex.GetIndex">
<summary>
The index. Callers should never call this either before one of the move
methods has returned true, or ever after either has returned false.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.IIndex.GetIdGetter">
<summary>
An ID getter, which should be based on the value that would be returned
from <see cref="M:Microsoft.ML.Data.CacheDataView.IIndex.GetIndex"/>, if valid, and otherwise have undefined behavior.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.IIndex.MoveNext">
<summary>
Moves to the next index. Once this has returned false, it should never be called again.
(This in constrast to public <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/> objects, whose move methods are
robust to that usage.)
</summary>
<returns>Whether the next index is available.</returns>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView.SequenceIndex`1">
<summary>
An <see cref="T:Microsoft.ML.Data.CacheDataView.IIndex"/> where the indices, while valid, are sequential increasing
adjacent indices.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView.JobScheduler">
<summary>
A simple job scheduler that assigns available jobs (batches/blocks for processing) to
free workers (cursors/threads). This scheduler takes the ids of the completed jobs into
account when assigning next jobs in order to minimize workers wait time as the consumer
of the completed jobs (a.k.a consolidator, see: DataViewUtils.ConsolidateGeneric) can
only consume jobs in order -according to their ids-. Note that workers get assigned
next job ids before they push the completed jobs to the consumer. So the workers are
then subject to being blocked until their current completed jobs are fully accepted
(i.e. added to the to-consume queue).
How it works:
Suppose we have 7 workers (w0,..,w6) and 14 jobs (j0,..,j13).
Initially, jobs get assigned to workers using a shared counter.
Here is an example outcome of using a shared counter:
w1->j0, w6->j1, w0->j2, w3->j3, w4->j4, w5->j5, w2->j6.
Suppose workers finished jobs in the following order:
w5->j5, w0->j2, w6->j1, w4->j4, w3->j3,w1->j0, w2->j6.
w5 finishes processing j5 first, but will be blocked until the processing of jobs
j0,..,j4 completes since the consumer can consume jobs in order only.
Therefore, the next available job (j7) should not be assigned to w5. It should be
assigned to the worker whose job *get consumed first* (w1 since it processes j0
which is the first job) *not* to the worker who completes its job first (w5 in
this example).
So, a shared counter can be used to assign jobs to workers initially but should
not be used onwards.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView.BlockSequenceIndex`1">
<summary>
An <see cref="T:Microsoft.ML.Data.CacheDataView.IIndex"/> that shares a counter among multiple threads. The multiple threads divy up
the work by blocks of rows rather than splitting row by row simply, both to cut down on interthread
communication as well as increased locality of thread data access.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView.BlockRandomIndex`1">
<summary>
An <see cref="T:Microsoft.ML.Data.CacheDataView.IIndex"/> that shares a counter among multiple threads. The multiple threads divy up
the work by blocks of rows rather than splitting row by row simply, to cut down on interthread
communication.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CacheDataView.ColumnCache">
<summary>
A cache of values from a single column. The filler worker fills these in row
by row, and increments the associated waiter. The consumer for the cache
waits on the associated waiter (if non-null), then fetches values as it
determines rows are valid.
</summary>
</member>
<member name="P:Microsoft.ML.Data.CacheDataView.ColumnCache.Waiter">
<summary>
The ordered waiter on row indices, indicating when a row index is valid,
or null if it is no longer necessary to wait on this column, that is,
it is completely filled in. Multiple columns can share a single waiter
since often multiple columns are being cached simultaneously, so this
object is not unqiue to this column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.ColumnCache.Create(Microsoft.ML.Data.CacheDataView,Microsoft.Data.DataView.DataViewRowCursor,System.Int32,Microsoft.ML.Internal.Utilities.OrderedWaiter)">
<summary>
Creates a cache pipe, over a particular column in a cursor.
</summary>
<param name="parent">The cache data view for which we are a cache</param>
<param name="input">The cursor to read from</param>
<param name="srcCol">The column of the cursor we are wrapping.</param>
<param name="waiter">The waiter for the filler associated with this column</param>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.ColumnCache.CacheCurrent">
<summary>
Utilized by the filler worker, to fill in the cache at the current position of the cursor.
The filler worker will have moved the cursor to the next row prior to calling this, so
overrides will merely get the value at the current position of the cursor.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.ColumnCache.Freeze">
<summary>
Utilized by the filler worker, to indicate to the cache that it will not be receiving
any more values through <see cref="M:Microsoft.ML.Data.CacheDataView.ColumnCache.CacheCurrent"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CacheDataView.ColumnCache`1.Fetch(System.Int32,`0@)">
<summary>
Utilized by the consumer to get a value in the cache at an index. The
consumer should coordinate with the <see cref="P:Microsoft.ML.Data.CacheDataView.ColumnCache.Waiter"/> member to ensure
that the row is valid.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CompositeRowToRowMapper">
<summary>
A row-to-row mapper that is the result of a chained application of multiple mappers.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CompositeRowToRowMapper.#ctor(Microsoft.Data.DataView.DataViewSchema,Microsoft.ML.Data.IRowToRowMapper[])">
<summary>
Out of a series of mappers, construct a seemingly unitary mapper that is able to apply them in sequence.
</summary>
<param name="inputSchema">The input schema.</param>
<param name="mappers">The sequence of mappers to wrap. An empty or <c>null</c> argument
is legal, and counts as being a no-op application.</param>
</member>
<member name="M:Microsoft.ML.Data.CompositeRowToRowMapper.Microsoft#ML#Data#IRowToRowMapper#GetDependencies(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewConstructionUtils">
<summary>
A helper class to create data views based on the user-provided types.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewConstructionUtils.InputRowBase`1">
<summary>
A row that consumes items of type <typeparamref name="TRow"/>, and provides an <see cref="T:Microsoft.Data.DataView.DataViewRow"/>. This
is in contrast to <see cref="T:Microsoft.ML.Data.IRowReadableAs`1"/> which consumes a data view row and publishes them as the output type.
</summary>
<typeparam name="TRow">The input data type.</typeparam>
</member>
<member name="T:Microsoft.ML.Data.DataViewConstructionUtils.DataViewBase`1">
<summary>
The base class for the data view over items of user-defined type.
</summary>
<typeparam name="TRow">The user-defined data type.</typeparam>
</member>
<member name="P:Microsoft.ML.Data.DataViewConstructionUtils.DataViewBase`1.DataViewCursorBase.Position">
<summary>
Zero-based position of the cursor.
</summary>
</member>
<member name="P:Microsoft.ML.Data.DataViewConstructionUtils.DataViewBase`1.DataViewCursorBase.IsGood">
<summary>
Convenience property for checking whether the cursor is in a good state where values
can be retrieved, that is, whenever <see cref="P:Microsoft.ML.Data.DataViewConstructionUtils.DataViewBase`1.DataViewCursorBase.Position"/> is non-negative.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewConstructionUtils.DataViewBase`1.DataViewCursorBase.MoveNextCore">
<summary>
Core implementation of <see cref="M:Microsoft.ML.Data.DataViewConstructionUtils.DataViewBase`1.DataViewCursorBase.MoveNext"/>, called if no prior call to this method
has returned <see langword="false"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewConstructionUtils.ListDataView`1">
<summary>
An in-memory data view based on the IList of data.
Supports shuffling.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewConstructionUtils.StreamingDataView`1">
<summary>
An in-memory data view based on the IEnumerable of data.
Doesn't support shuffling.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewConstructionUtils.SingleRowLoopDataView`1">
<summary>
This represents the 'infinite data view' over one (mutable) user-defined object.
The 'current row' object can be updated at any time, this will affect all the
newly created cursors, but not the ones already existing.
</summary>
</member>
<member name="T:Microsoft.ML.Data.AnnotationInfo">
<summary>
A single instance of annotation information, associated with a column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.AnnotationInfo.AnnotationType">
<summary>
The type of the annotation.
</summary>
</member>
<member name="F:Microsoft.ML.Data.AnnotationInfo.Kind">
<summary>
The string identifier of the annotation. Some identifiers have special meaning,
like "SlotNames", but any other identifiers can be used.
</summary>
</member>
<member name="T:Microsoft.ML.Data.AnnotationInfo`1">
<summary>
Strongly-typed version of <see cref="T:Microsoft.ML.Data.AnnotationInfo"/>, that contains the actual value of the annotation.
</summary>
<typeparam name="T">Type of the annotation value.</typeparam>
</member>
<member name="M:Microsoft.ML.Data.AnnotationInfo`1.#ctor(System.String,`0,Microsoft.Data.DataView.DataViewType)">
<summary>
Constructor for annotation of value type T.
</summary>
<param name="kind">The string identifier of the annotation. Some identifiers have special meaning,
like "SlotNames", but any other identifiers can be used.</param>
<param name="value">Annotation value.</param>
<param name="annotationType">Type of the annotation.</param>
</member>
<member name="M:Microsoft.ML.Data.DataViewExtensions.GetRowCursor(Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.DataViewSchema.Column[])">
<summary>
Get a row cursor. The <paramref name="columnsNeeded"/> are the active columns.
The schema of the returned cursor will be the same as the schema of the IDataView, but getting
a getter for an inactive columns will throw.
</summary>
<param name="columnsNeeded">The columns requested by this <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/>, or as otherwise called, the active columns.
An empty collection indicates that no column is needed.</param>
<param name="dv">The <see cref="T:Microsoft.Data.DataView.IDataView"/> containing the <paramref name="columnsNeeded"/>.</param>
</member>
<member name="M:Microsoft.ML.Data.DataViewExtensions.GetRowCursor(Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.DataViewSchema.Column)">
<summary>
Get a row cursor. The <paramref name="columnNeeded"/> is the active column.
The schema of the returned cursor will be the same as the schema of the IDataView, but getting
a getter for the other, inactive columns will throw.
</summary>
<param name="columnNeeded">The column requested by this <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/>, or as otherwise called, the active column.</param>
<param name="dv">The <see cref="T:Microsoft.Data.DataView.IDataView"/> containing the <paramref name="columnNeeded"/>.</param>
</member>
<member name="M:Microsoft.ML.Data.DataViewExtensions.GetRowCursor(Microsoft.Data.DataView.IDataView)">
<summary>
Get a row cursor. No colums are needed by this <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewExtensions.GetRowCursorForAllColumns(Microsoft.Data.DataView.IDataView)">
<summary>
Get a row cursor including all the columns of the <see cref="T:Microsoft.Data.DataView.IDataView"/> it is called upon..
</summary>
</member>
<member name="T:Microsoft.ML.Data.EmptyDataView">
<summary>
This implements a data view that has a schema, but no rows.
</summary>
</member>
<member name="T:Microsoft.ML.Data.InternalSchemaDefinition">
<summary>
An internal class that holds the (already validated) mapping between a custom type and an IDataView schema.
</summary>
</member>
<member name="M:Microsoft.ML.Data.InternalSchemaDefinition.Column.AssertRep">
<summary>
Function that checks whether the InternalSchemaDefinition.Column is a valid one.
To be valid, the Column must:
1. Have non-empty values for ColumnName and ColumnType
2. Have a non-empty value for FieldInfo iff it is a field column, else
ReturnParameterInfo and Generator iff it is a computed column
3. Generator must have the method inputs (TRow rowObject,
long position, ref TValue outputValue) in that order.
</summary>
</member>
<member name="M:Microsoft.ML.Data.InternalSchemaDefinition.GetVectorAndItemType(System.Reflection.MemberInfo,System.Boolean@,System.Type@)">
<summary>
Given a field or property info on a type, returns whether this appears to be a vector type,
and also the associated data kind for this type. If a valid data type could not
be determined, this will throw.
</summary>
<param name="memberInfo">The field or property info to inspect.</param>
<param name="isVector">Whether this appears to be a vector type.</param>
<param name="itemType">
The corresponding <see cref="T:Microsoft.Data.DataView.PrimitiveDataViewType"/> RawType of the type, or items of this type if vector.
</param>
</member>
<member name="M:Microsoft.ML.Data.InternalSchemaDefinition.GetVectorAndItemType(System.Type,System.String,System.Boolean@,System.Type@)">
<summary>
Given a type and name for a variable, returns whether this appears to be a vector type,
and also the associated data type for this type. If a valid data type could not
be determined, this will throw.
</summary>
<param name="rawType">The type of the variable to inspect.</param>
<param name="name">The name of the variable to inspect.</param>
<param name="isVector">Whether this appears to be a vector type.</param>
<param name="itemType">
The corresponding <see cref="T:Microsoft.Data.DataView.PrimitiveDataViewType"/> RawType of the type, or items of this type if vector.
</param>
</member>
<member name="T:Microsoft.ML.Data.LambdaColumnMapper">
<summary>
This applies the user provided ValueMapper to a column to produce a new column. It automatically
injects a standard conversion from the actual type of the source column to typeSrc (if needed).
</summary>
</member>
<member name="T:Microsoft.ML.Data.LambdaFilter">
<summary>
This applies the user provided RefPredicate to a column and drops rows that map to false. It automatically
injects a standard conversion from the actual type of the source column to typeSrc (if needed).
</summary>
</member>
<member name="T:Microsoft.ML.Data.OpaqueDataView">
<summary>
Opaque IDataView implementation to provide a barrier for data pipe optimizations.
Used in cross validatation to generate the train/test pipelines for each fold.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IRowMapper">
<summary>
This interface is used to create a <see cref="T:Microsoft.ML.Data.RowToRowMapperTransform"/>.
Implementations should be given an <see cref="T:Microsoft.Data.DataView.DataViewSchema"/> in their constructor, and should have a
ctor or Create method with <see cref="T:Microsoft.ML.Data.SignatureLoadRowMapper"/>, along with a corresponding
<see cref="T:Microsoft.ML.LoadableClassAttribute"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IRowMapper.GetDependencies(System.Func{System.Int32,System.Boolean})">
<summary>
Returns the input columns needed for the requested output columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IRowMapper.CreateGetters(Microsoft.Data.DataView.DataViewRow,System.Func{System.Int32,System.Boolean},System.Action@)">
<summary>
Returns the getters for the output columns given an active set of output columns. The length of the getters
array should be equal to the number of columns added by the IRowMapper. It should contain the getter for the
i'th output column if activeOutput(i) is true, and null otherwise. If creating a <see cref="T:Microsoft.Data.DataView.DataViewRow"/> or
<see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/> out of this, the <paramref name="disposer"/> delegate (if non-null) should be called
from the dispose of either of those instances.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IRowMapper.GetOutputColumns">
<summary>
Returns information about the output columns, including their name, type and any metadata information.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IRowMapper.GetTransformer">
<summary>
DO NOT USE IT!
Purpose of this method is to enable legacy loading and unwrapping of RowToRowTransform.
It should be removed as soon as we get rid of <see cref="T:Microsoft.ML.Data.TrainedWrapperEstimatorBase"/>
Returns parent transfomer which uses this mapper.
</summary>
</member>
<member name="T:Microsoft.ML.Data.RowToRowMapperTransform">
<summary>
This class is a transform that can add any number of output columns, that depend on any number of input columns.
It does so with the help of an <see cref="T:Microsoft.ML.Data.IRowMapper"/>, that is given a schema in its constructor, and has methods
to get the dependencies on input columns and the getters for the output columns, given an active set of output columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowMapperTransform.GetActive(System.Func{System.Int32,System.Boolean},System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column}@)">
<summary>
Produces the set of active columns for the data view (as a bool[] of length bindings.ColumnCount),
and the needed active input columns, given a predicate for the needed active output columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowMapperTransform.Microsoft#ML#Data#IRowToRowMapper#GetDependencies(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of output columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SimpleRow">
<summary>
An implementation of <see cref="T:Microsoft.Data.DataView.DataViewRow"/> that gets its <see cref="P:Microsoft.Data.DataView.DataViewRow.Position"/>, <see cref="P:Microsoft.Data.DataView.DataViewRow.Batch"/>,
and <see cref="M:Microsoft.Data.DataView.DataViewRow.GetIdGetter"/> from an input row. The constructor requires a schema and array of getter
delegates. A <see langword="null"/> delegate indicates an inactive column. The delegates are assumed to be
of the appropriate type (this does not validate the type).
REVIEW: Should this validate that the delegates are of the appropriate type? It wouldn't be difficult
to do so.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SimpleRow.#ctor(Microsoft.Data.DataView.DataViewSchema,Microsoft.Data.DataView.DataViewRow,System.Delegate[],System.Action)">
<summary>
Constructor.
</summary>
<param name="schema">The schema for the row.</param>
<param name="input">The row that is being wrapped by this row, where our <see cref="P:Microsoft.Data.DataView.DataViewRow.Position"/>,
<see cref="P:Microsoft.Data.DataView.DataViewRow.Batch"/>, <see cref="M:Microsoft.Data.DataView.DataViewRow.GetIdGetter"/>.</param>
<param name="getters">The collection of getter delegates, whose types should map those in a schema.
If one of these is <see langword="null"/>, the corresponding column is considered inactive.</param>
<param name="disposer">A method that, if non-null, will be called exactly once during
<see cref="M:System.IDisposable.Dispose"/>, prior to disposing <paramref name="input"/>.</param>
</member>
<member name="T:Microsoft.ML.Data.Transposer">
<summary>
This provides a scalable method of getting a "transposed" view of a subset of columns from an
<see cref="T:Microsoft.Data.DataView.IDataView"/>. Instances of <see cref="T:Microsoft.ML.Data.Transposer"/> act like a wrapped version of
the input dataview, except that an indicated set of columns will be transposable, even if they
were not transposable before. Note that transposition is a somewhat slow and resource intensive
operation.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Transposer.Create(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Boolean,System.String[])">
<summary>
Creates an instance given a list of column names.
</summary>
<param name="env">The host environment</param>
<param name="view">The view whose columns we want to transpose</param>
<param name="forceSave">Whether the internal transposer should always unconditionally
save the column we are transposing. Can be useful if the original dataview is possibly
slow to iterate over that column.</param>
<param name="columns">The non-empty list of columns to transpose</param>
</member>
<member name="M:Microsoft.ML.Data.Transposer.Create(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Boolean,System.Int32[])">
<summary>
Creates an instance given a list of column indices.
</summary>
<param name="env">The host environment</param>
<param name="view">The view whose columns we want to transpose</param>
<param name="forceSave">Whether the internal transposer should always unconditionally
save the column we are transposing. Can be useful if the original dataview is possibly
slow to iterate over that column.</param>
<param name="columns">The non-empty list of columns to transpose</param>
</member>
<member name="M:Microsoft.ML.Data.Transposer.SlotCursorVec`1.#ctor(Microsoft.ML.Data.Transposer,System.Int32)">
<summary>
Constructs a slot cursor.
</summary>
<param name="parent">The transposer.</param>
<param name="col">The index of the transposed column.</param>
</member>
<member name="M:Microsoft.ML.Data.Transposer.SlotCursorVec`1.EnsureValid">
<summary>
Ensures that the column from the source data view stored in our intermediate buffers is the
current column requested.
</summary>
</member>
<member name="T:Microsoft.ML.Data.Transposer.DataViewSlicer">
<summary>
This takes an input data view, and presents a dataset with "sliced" up columns
that are partitionings of the original columns. Scalar columns and sufficiently
small vector columns are just served up as themselves. The idea is that each of
those slices should be small enough that storing an entire column in memory.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Transposer.DataViewSlicer.InColToOutRange(System.Int32,System.Int32@,System.Int32@)">
<summary>
Given the index of a column we were told to split, get the corresponding range out output
ranges.
</summary>
<param name="incol">The index into the array of column indices.</param>
<param name="outMin">The minimum output column index corresponding to that split column</param>
<param name="outLim">The exclusive limit of the output column index corresponding to that
split column</param>
</member>
<member name="M:Microsoft.ML.Data.Transposer.DataViewSlicer.OutputColumnToSplitterIndices(System.Int32,System.Int32@,System.Int32@)">
<summary>
Given an output column index, find which spliter produces it and which spliter column is its source.
</summary>
<param name="col">An output column index</param>
<param name="splitInd"><see cref="F:Microsoft.ML.Data.Transposer.DataViewSlicer._splitters"/>[splitInd] produces the specified output column.</param>
<param name="splitCol">The specified output column is the splitCol-th column among columns produced by <see cref="F:Microsoft.ML.Data.Transposer.DataViewSlicer._splitters"/>[splitInd].</param>
</member>
<member name="M:Microsoft.ML.Data.Transposer.DataViewSlicer.CreateInputPredicate(System.Func{System.Int32,System.Boolean},System.Boolean[]@)">
<summary>
Given a possibly null predicate for this data view, produce the dependency predicate for the sources,
as well as a list of all the splitters for which we should produce rowsets.
</summary>
<param name="pred">The predicate input into the <see cref="M:Microsoft.ML.Data.Transposer.DataViewSlicer.GetRowCursor(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column},System.Random)"/> method.</param>
<param name="activeSplitters">A boolean indicator array of length equal to the number of splitters,
indicating whether that splitter has any active columns in its outputs or not</param>
<returns>The predicate to use when constructing the row cursor from the source</returns>
</member>
<member name="T:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter">
<summary>
There is one instance of these per column, implementing the possible splitting
of one column from a <see cref="T:Microsoft.Data.DataView.IDataView"/> into multiple columns. The instance
describes the resulting split columns through <see cref="P:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.OutputSchema"/>,
and then can be bound to an <see cref="T:Microsoft.Data.DataView.DataViewRow"/> to provide that splitting functionality.
</summary>
</member>
<member name="P:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.OutputSchema">
<summary>
Output schema of a splitter. A splitter takes a column from input data and then divide it into multiple columns
to form its output data.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.Create(Microsoft.Data.DataView.IDataView,System.Int32)">
<summary>
Creates a splitter for a given row.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.Bind(Microsoft.Data.DataView.DataViewRow,System.Func{System.Int32,System.Boolean})">
<summary>
Given an input <see cref="T:Microsoft.Data.DataView.DataViewRow"/>, create the <see cref="T:Microsoft.Data.DataView.DataViewRow"/> containing the split
version of the columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.NoSplitter`1">
<summary>
A splitter that doesn't split, just passes through the column contents.
Useful for when we've been told to "split" a column that we don't need
to split.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.NoSplitter`1.#ctor(Microsoft.Data.DataView.IDataView,System.Int32)">
<summary>
This is NoSplitter. Thus, the column, indexed by col, which supposes to be splitted will just be copied to an output
column without splitting.
</summary>
<param name="view">Input data whose columns can be splitted.</param>
<param name="col">The selected column's index.</param>
</member>
<member name="T:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.ColumnSplitter`1">
<summary>
This splitter enables the partition of a single column into two or more
columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.ColumnSplitter`1.#ctor(Microsoft.Data.DataView.IDataView,System.Int32,System.Int32[])">
<summary>
Provide a column partitioner that partitions a vector column into multiple
vector columns.
</summary>
<param name="view">The view where we are slicing one column</param>
<param name="col">The column we are slicing</param>
<param name="lims">Equal in length to the number of slices, this is
the limit of the indices of each slice, where the successive slice
starts with that limit as its minimum index. So slice i comes from
source slot indices from <c><paramref name="lims"/>[i-1]</c> inclusive to
<c><paramref name="lims"/>[i]</c> exclusive, with slice 0 starting at 0.</param>
</member>
<member name="T:Microsoft.ML.Data.Transposer.DataViewSlicer.Cursor">
<summary>
The cursor implementation creates the <see cref="T:Microsoft.Data.DataView.DataViewRow"/>s using <see cref="M:Microsoft.ML.Data.Transposer.DataViewSlicer.Splitter.Bind(Microsoft.Data.DataView.DataViewRow,System.Func{System.Int32,System.Boolean})"/>,
then collates the results from those rows as effectively one big row.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TransposerUtils.GetSingleSlotValue``1(Microsoft.ML.Data.ITransposeDataView,System.Int32,Microsoft.ML.Data.VBuffer{``0}@)">
<summary>
This is a convenience method that extracts a single slot value's vector,
while simultaneously verifying that there is exactly one value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TransposerUtils.GetGetterWithVectorType``1(Microsoft.ML.Data.SlotCursor,Microsoft.ML.IExceptionContext)">
<summary>
The <see cref="M:Microsoft.ML.Data.SlotCursor.GetGetter``1"/> is parameterized by a type that becomes the
type parameter for a <see cref="T:Microsoft.ML.Data.VBuffer`1"/>, and this is generally preferable and more
sensible but for various reasons it's often a lot simpler to have a get-getter be over
the actual type returned by the getter, that is, parameterize this by the actual
<see cref="T:Microsoft.ML.Data.VBuffer`1"/> type.
</summary>
<typeparam name="TValue">The type, must be a <see cref="T:Microsoft.ML.Data.VBuffer`1"/> generic type,
though enforcement of this has to be done only at runtime for practical reasons</typeparam>
<param name="cursor">The cursor to get the getter for</param>
<param name="ctx">The exception contxt</param>
<returns>The value getter</returns>
</member>
<member name="M:Microsoft.ML.Data.TransposerUtils.GetRowCursorShim(Microsoft.ML.IChannelProvider,Microsoft.ML.Data.SlotCursor)">
<summary>
Given a slot cursor, construct a single-column equivalent row cursor, with the single column
active and having the same type. This is useful to exploit the many utility methods that exist
to handle <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/> and <see cref="T:Microsoft.Data.DataView.DataViewRow"/> but that know nothing about
<see cref="T:Microsoft.ML.Data.SlotCursor"/>, without having to rewrite all of them. This is, however, rather
something of a hack; whenever possible or reasonable the slot cursor should be used directly.
The name of this column is always "Waffles".
</summary>
<param name="provider">The channel provider used in creating the wrapping row cursor</param>
<param name="cursor">The slot cursor to wrap</param>
<returns>A row cursor with a single active column with the same type as the slot type</returns>
</member>
<member name="T:Microsoft.ML.Data.TransposerUtils.SlotDataView">
<summary>
Presents a single transposed column as a single-column dataview.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IRowReadableAs`1">
<summary>
This interface is an <see cref="T:Microsoft.Data.DataView.DataViewRow"/> with 'strongly typed' binding.
It can populate the user-supplied object's fields with the values of the current row.
</summary>
<typeparam name="TRow">The user-defined type that is being populated while cursoring.</typeparam>
</member>
<member name="M:Microsoft.ML.Data.IRowReadableAs`1.FillValues(`0)">
<summary>
Populates the fields of the user-supplied <paramref name="row"/> object with the values of the current row.
</summary>
<param name="row">The row object. Cannot be null.</param>
</member>
<member name="T:Microsoft.ML.Data.RowCursor`1">
<summary>
This interface provides cursoring through a <see cref="T:Microsoft.Data.DataView.IDataView"/> via a 'strongly typed' binding.
It can populate the user-supplied object's fields with the values of the current row.
</summary>
<typeparam name="TRow">The user-defined type that is being populated while cursoring.</typeparam>
</member>
<member name="T:Microsoft.ML.Data.ICursorable`1">
<summary>
This interface allows to create strongly typed cursors over a <see cref="T:Microsoft.Data.DataView.IDataView"/>.
</summary>
<typeparam name="TRow">The user-defined type that is being populated while cursoring.</typeparam>
</member>
<member name="M:Microsoft.ML.Data.ICursorable`1.GetCursor">
<summary>
Get a new cursor.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ICursorable`1.GetRandomizedCursor(System.Int32)">
<summary>
Get a new randomized cursor.
</summary>
<param name="randomSeed">The random seed to use.</param>
</member>
<member name="T:Microsoft.ML.Data.TypedCursorable`1">
<summary>
Implementation of the strongly typed Cursorable.
Similarly to the 'DataView{T}, this class uses IL generation to create the 'poke' methods that
write directly into the fields of the user-defined type.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TypedCursorable`1.IsCompatibleType(Microsoft.Data.DataView.DataViewType,System.Reflection.MemberInfo)">
<summary>
Returns whether the column type <paramref name="colType"/> can be bound to field <paramref name="memberInfo"/>.
They must both be vectors or scalars, and the raw data type should match.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TypedCursorable`1.GetCursor">
<summary>
Create and return a new cursor.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TypedCursorable`1.GetRandomizedCursor(System.Int32)">
<summary>
Create and return a new randomized cursor.
</summary>
<param name="randomSeed">The random seed to use.</param>
</member>
<member name="M:Microsoft.ML.Data.TypedCursorable`1.GetCursor(System.Func{System.Int32,System.Boolean},System.Nullable{System.Int32})">
<summary>
Create a new cursor with additional active columns.
</summary>
<param name="additionalColumnsPredicate">Predicate that denotes which additional columns to include in the cursor,
in addition to the columns that are needed for populating the <typeparamref name="TRow"/> object.</param>
<param name="randomSeed">The random seed to use. If <c>null</c>, the cursor will be non-randomized.</param>
</member>
<member name="M:Microsoft.ML.Data.TypedCursorable`1.GetCursorSet(System.Func{System.Int32,System.Boolean},System.Int32,System.Random)">
<summary>
Create a set of cursors with additional active columns.
</summary>
<param name="additionalColumnsPredicate">Predicate that denotes which additional columns to include in the cursor,
in addition to the columns that are needed for populating the <typeparamref name="TRow"/> object.</param>
<param name="n">Number of cursors to create</param>
<param name="rand">Random generator to use</param>
</member>
<member name="M:Microsoft.ML.Data.TypedCursorable`1.Create(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Boolean,Microsoft.ML.Data.SchemaDefinition)">
<summary>
Create a Cursorable object on a given data view.
</summary>
<param name="env">Host environment.</param>
<param name="data">The underlying data view.</param>
<param name="ignoreMissingColumns">Whether to ignore missing columns in the data view.</param>
<param name="schemaDefinition">The optional user-provided schema.</param>
<returns>The constructed Cursorable.</returns>
</member>
<member name="T:Microsoft.ML.Data.CursoringUtils">
<summary>
Utility methods that facilitate strongly-typed cursoring.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CursoringUtils.AsCursorable``1(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Boolean,Microsoft.ML.Data.SchemaDefinition)">
<summary>
Generate a strongly-typed cursorable wrapper of the <see cref="T:Microsoft.Data.DataView.IDataView"/>.
</summary>
<typeparam name="TRow">The user-defined row type.</typeparam>
<param name="env">The environment.</param>
<param name="data">The underlying data view.</param>
<param name="ignoreMissingColumns">Whether to ignore the case when a requested column is not present in the data view.</param>
<param name="schemaDefinition">Optional user-provided schema definition. If it is not present, the schema is inferred from the definition of T.</param>
<returns>The cursorable wrapper of <paramref name="data"/>.</returns>
</member>
<member name="T:Microsoft.ML.Data.ZipBinding">
<summary>
A convenience class for concatenating several schemas together.
This would be necessary when combining IDataViews through any type of combining operation, for example, zip.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ZipBinding.GetInputPredicates(System.Func{System.Int32,System.Boolean})">
<summary>
Returns an array of input predicated for sources, corresponding to the input predicate.
The returned array size is equal to the number of sources, but if a given source is not needed at all,
the corresponding predicate will be null.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ZipBinding.CheckColumnInRange(System.Int32)">
<summary>
Checks whether the column index is in range.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ZipDataView">
<summary>
This is a data view that is a 'zip' of several data views.
The length of the zipped data view is equal to the shortest of the lengths of the components.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ZipDataView.GetMinimumCursor(Microsoft.Data.DataView.IDataView)">
<summary>
Create an <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/> with no requested columns on a data view.
Potentially, this can be optimized by calling GetRowCount(lazy:true) first, and if the count is not known,
wrapping around GetCursor().
</summary>
</member>
<member name="T:Microsoft.ML.Data.BufferBuilder`1">
<summary>
Helper base class for building feature vectors (sparse or dense). Note that this is abstract
with some of the esoteric stuff "protected" instead of "public". This is so callees can't
abuse an instance of it.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BufferBuilder`1.ResetImpl(System.Int32,System.Boolean)">
<summary>
This resets the FeatureSet to be used again. This functionality is for memory
efficiency - we can keep pools of these to be re-used.
Dense indicates whether this should start out dense. It can, of course,
become dense when it makes sense to do so.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BufferBuilder`1.SetActiveRangeImpl(System.Int32,System.Int32)">
<summary>
This sets the active sub-range of the feature index space. For example, when asking
a feature handler to add features, we call this so the feature handler can use zero-based
indexing for the features it is generating. This also prohibits the feature handler from
messing with a different index range. Note that this is protected so a non-abstract derived
type can choose how to use it, but a feature handler can't directly mess with the active
range.
</summary>
<param name="ifeat">The min feature index of the active range</param>
<param name="cfeat">The number of feature indices in the active range</param>
</member>
<member name="M:Microsoft.ML.Data.BufferBuilder`1.AddFeature(System.Int32,`0)">
<summary>
Adds a feature to the current active range. If the index is a duplicate, this adds the
given value to any previously provided value(s).
</summary>
</member>
<member name="M:Microsoft.ML.Data.BufferBuilder`1.SortAndSumDups">
<summary>
Sort the indices/values (by index) and sum the values for duplicate indices. This asserts that
_sorted is false and _dense is false. It also asserts that _count > 1.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BufferBuilder`1.MakeDense">
<summary>
Convert a sorted non-dense representation to dense.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BufferBuilder`1.TryGetFeature(System.Int32,`0@)">
<summary>
Try to get the value for the given feature. Returns false if the feature index is not found.
Note that this respects the "active range", just as AddFeature does.
</summary>
</member>
<member name="T:Microsoft.ML.Data.Conversion.Conversions">
<summary>
This type exists to provide efficient delegates for conversion between standard ColumnTypes,
as discussed in the IDataView Type System Specification. This is a singleton class.
Some conversions are "standard" conversions, conforming to the details in the spec.
Others are auxilliary conversions. The use of auxilliary conversions should be limited to
situations that genuinely require them and have been well designed in the particular context.
For example, this contains non-standard conversions from the standard primitive types to
text (and StringBuilder). These are needed by the standard TextSaver, which handles
differences between sparse and dense inputs in a semantically invariant way.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.GetStandardConversion``2(Microsoft.Data.DataView.DataViewType,Microsoft.Data.DataView.DataViewType,System.Boolean@)">
<summary>
Return a standard conversion delegate from typeSrc to typeDst. If there is no such standard
conversion, this throws an exception.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryGetStandardConversion``2(Microsoft.Data.DataView.DataViewType,Microsoft.Data.DataView.DataViewType,Microsoft.ML.Data.ValueMapper{``0,``1}@,System.Boolean@)">
<summary>
Determine whether there is a standard conversion from typeSrc to typeDst and if so,
set conv to the conversion delegate. The type parameters TSrc and TDst must match
the raw types of typeSrc and typeDst.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.GetStandardConversion(Microsoft.Data.DataView.DataViewType,Microsoft.Data.DataView.DataViewType)">
<summary>
Return a standard conversion delegate from typeSrc to typeDst. If there is no such standard
conversion, this throws an exception.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryGetStandardConversion(Microsoft.Data.DataView.DataViewType,Microsoft.Data.DataView.DataViewType,System.Delegate@,System.Boolean@)">
<summary>
Determine whether there is a standard conversion from typeSrc to typeDst and if so,
set conv to the conversion delegate.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.GetNAOrDefault``1(Microsoft.Data.DataView.DataViewType)">
<summary>
Returns the NA value of the given type, if it has one, otherwise, it returns
default of the type. This only knows about NA values of standard scalar types
and key types.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.GetNAOrDefault``1(Microsoft.Data.DataView.DataViewType,System.Boolean@)">
<summary>
Returns the NA value of the given type, if it has one, otherwise, it returns
default of the type. This only knows about NA values of standard scalar types
and key types. Returns whether the returned value is the default value or not.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.GetNAOrDefaultGetter``1(Microsoft.Data.DataView.DataViewType)">
<summary>
Returns a ValueGetter{T} that produces the NA value of the given type, if it has one,
otherwise, it produces default of the type. This only knows about NA values of standard
scalar types and key types.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.Byte@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable or overflows.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.UInt16@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable or overflows.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.UInt32@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable or overflows.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.UInt64@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable or overflows.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,Microsoft.Data.DataView.DataViewRowId@)">
<summary>
A parse method that transforms a 34-length string into a <see cref="T:Microsoft.Data.DataView.DataViewRowId"/>.
</summary>
<param name="src">What should be a 34-length hexadecimal representation, including a 0x prefix,
of the 128-bit number</param>
<param name="dst">The result</param>
<returns>Whether the input string was parsed successfully, that is, it was exactly length 32
and had only digits and the letters 'a' through 'f' or 'A' through 'F' as characters</returns>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.IsStdMissing(System.ReadOnlySpan{System.Char}@)">
<summary>
Return true if the span contains a standard text representation of NA
other than the standard TX missing representation - callers should
have already dealt with that case and the case of empty.
The standard representations are any casing of:
? NaN NA N/A
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParseKey(System.ReadOnlyMemory{System.Char}@,System.UInt64,System.UInt64@)">
<summary>
Utility to assist in parsing key-type values. The max value defines
the legal input value bound. The output dst value is "normalized" by adding 1
so max is mapped to 1 + max.
Unparsable or out of range values are mapped to zero with a false return.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.SByte@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable or overflows.
On failure, it sets dst to the default value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.Int16@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable or overflows.
On failure, it sets dst to the default value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.Int32@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable or overflows.
On failure, it sets dst to the defualt value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.Int64@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable or overflows.
On failure, it sets dst to the default value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParseNonNegative(System.ReadOnlySpan{System.Char},System.Int64@)">
<summary>
Returns false if the text is not parsable as an non-negative long or overflows.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParseSigned(System.Int64,System.ReadOnlyMemory{System.Char}@,System.Nullable{System.Int64}@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable as a signed integer
or the result overflows. The min legal value is -max. The NA value null.
When it returns false, result is set to the NA value. The result can be NA on true return,
since some representations of NA are not considered parse failure.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.Single@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable.
On failure, it sets dst to the NA value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.Double@)">
<summary>
This produces zero for empty. It returns false if the text is not parsable.
On failure, it sets dst to the NA value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.Conversion.Conversions.TryParse(System.ReadOnlyMemory{System.Char}@,System.Boolean@)">
<summary>
Try parsing a TX to a BL. This returns false for NA (span.IsMissing).
Otherwise, it trims the span, then succeeds on all casings of the strings:
* false, f, no, n, 0, -1, - => false
* true, t, yes, y, 1, +1, + => true
Empty string (but not missing string) succeeds and maps to false.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.GetTempColumnName(Microsoft.Data.DataView.DataViewSchema,System.String)">
<summary>
Generate a unique temporary column name for the given schema.
Use tag to independently create multiple temporary, unique column
names for a single transform.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.GetTempColumnNames(Microsoft.Data.DataView.DataViewSchema,System.Int32,System.String)">
<summary>
Generate n unique temporary column names for the given schema.
Use tag to independently create multiple temporary, unique column
names for a single transform.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.ComputeRowCount(Microsoft.Data.DataView.IDataView)">
<summary>
Get the row count from the input view by any means necessary, even explicit enumeration
and counting if <see cref="M:Microsoft.Data.DataView.IDataView.GetRowCount"/> insists on returning <c>null</c>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.GetThreadCount(Microsoft.ML.IHost,System.Int32,System.Boolean)">
<summary>
Get the target number of threads to use, given a host and another indicator of thread count.
When num > 0, this uses num limited to twice what the host says. Otherwise, if preferOne
is true, it returns 1. Otherwise, it returns what the host says.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.TryCreateConsolidatingCursor(Microsoft.Data.DataView.DataViewRowCursor@,Microsoft.Data.DataView.IDataView,System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column},Microsoft.ML.IHost,System.Random)">
<summary>
Try to create a cursor set from upstream and consolidate it here. The host determines
the target cardinality of the cursor set.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.CreateSplitCursors(Microsoft.ML.IChannelProvider,Microsoft.Data.DataView.DataViewRowCursor,System.Int32)">
<summary>
From the given input cursor, split it into a cursor set with the given
cardinality. If not all the active columns are cachable, this will only
produce the given input cursor.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.AllCacheable(Microsoft.Data.DataView.DataViewSchema,System.Func{System.Int32,System.Boolean})">
<summary>
Return whether all the active columns, as determined by the predicate, are
cachable - either primitive types or vector types.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.AllCacheable(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Return whether all the active columns, as determined by the predicate, are
cachable - either primitive types or vector types.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.IsCacheable(Microsoft.Data.DataView.DataViewType)">
<summary>
Determine whether the given type is cachable - either a primitive type or a vector type.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.SameSchemaAndActivity(Microsoft.Data.DataView.DataViewRowCursor[])">
<summary>
Tests whether the cursors are mutually compatible for consolidation,
that is, they all are non-null, have the same schemas, and the same
set of columns are active.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.ConsolidateGeneric(Microsoft.ML.IChannelProvider,Microsoft.Data.DataView.DataViewRowCursor[],System.Int32)">
<summary>
Given a parallel cursor set, this consolidates them into a single cursor. The batchSize
is a hint used for efficiency.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewUtils.Splitter">
<summary>
A convenience class to facilitate the creation of a split, as well as a convenient
place to store shared resources that can be reused among multiple splits of a cursor
with the same schema. Since splitting also returns a consolidator, this also contains
a consolidating logic.
In a very rough sense, both the splitters and consolidators are written in the same way:
For all input cursors, and all active columns, an "in pipe" is created. A worker thread
per input cursor busily retrieves values from the cursors and stores them in the "in
pipe." At appropriate times, "batch" objects are synthesized from the inputs consumed
thusfar, and inserted into a blocking collection. The output cursor or cursors likewise
have a set of "out pipe" instances, one per each of the active columns, through which
successive batches are presented for consumption by the user of the output cursors. Of
course, both split and consolidate have many details from which they differ, for example, the
consolidator must accept batches as they come and reconcile them among multiple inputs,
while the splitter is more free.
It is ideal if a data view that could be split retains one of these objects itself,
so that multiple splittings will have the capability of sharing buffers from cursoring
to cursoring, but this is not required.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewUtils.Splitter.ExtraIndex">
<summary>
Pipes, in addition to column values, will also communicate extra information
enumerated within this. This enum serves the purpose of providing nice readable
indices to these "extra" information in pipes.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.CreateInPipe``1(Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
An in pipe creator intended to be used from the splitter only.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.CreateIdInPipe(Microsoft.Data.DataView.DataViewRow)">
<summary>
An in pipe creator intended to be used from the splitter only.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewUtils.Splitter.InPipe">
<summary>
There is one of these created per input cursor, per "channel" of information
(necessary channels include values from active columns, as well as additional
side information), in both splitting and consolidating. This is a running buffer
of the input cursor's values. It is used to create <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.BatchColumn"/> objects.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.InPipe.CreateOutPipe(Microsoft.Data.DataView.DataViewType)">
<summary>
Creates an out pipe corresponding to the in pipe. This is useful for the splitter,
when we are creating an in pipe.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewUtils.Splitter.BatchColumn">
<summary>
These are objects continuously created by the <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.InPipe"/> to spin off the
values they have collected. They are collected into a <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.Batch"/>
object, and eventually one is consumed by an <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe"/> instance.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewUtils.Splitter.Batch">
<summary>
This holds a collection of <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.BatchColumn"/> objects, which together hold all
the values from a set of rows from the input cursor. These are produced as needed
by the input cursor reader, and consumed by each of the output cursors.
This class also serves a secondary role in marshalling exceptions thrown in the workers
producing batches, into the threads consuming these batches.
<see cref="P:Microsoft.ML.Data.DataViewUtils.Splitter.Batch.HasException"/> lets us know if this is one of these "special" batches.
If it is, then the <see cref="M:Microsoft.ML.Data.DataViewUtils.Splitter.Batch.SetAll(Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe[])"/> method will throw whenever it is called, by the
consumer of the batches.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.Batch.#ctor(Microsoft.ML.Internal.Utilities.MadeObjectPool{Microsoft.ML.Data.DataViewUtils.Splitter.BatchColumn[]},Microsoft.ML.Data.DataViewUtils.Splitter.BatchColumn[],System.Int32,System.Int64)">
<summary>
Construct a batch object to communicate the <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.BatchColumn"/> objects to consumers.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.Batch.#ctor(System.Exception)">
<summary>
Construct a batch object to communicate that something went wrong. In this case all other fields
will have default values.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.Batch.SetAll(Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe[])">
<summary>
Gives all of the batch columns to the output pipes. This should be called only once,
per batch object, because the the batch columns will be returned to the pool.
If this was an exception bearing batch, that exception will be propagated and thrown
in this.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe">
<summary>
This helps a cursor present the results of a <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.BatchColumn"/>. Practically its role
really is to just provide a stable delegate for the <see cref="M:Microsoft.Data.DataView.DataViewRow.GetGetter``1(System.Int32)"/>.
There is one of these created per column, per output cursor, i.e., in splitting
there are <c>n</c> of these created per column, and when consolidating only one of these
is created per column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe.CreateInPipe(System.Delegate)">
<summary>
Creates an in pipe corresponding to this out pipe. Useful for the consolidator,
when we are creating many in pipes from a single out pipe.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe.Set(Microsoft.ML.Data.DataViewUtils.Splitter.BatchColumn)">
<summary>
Sets this <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe"/> to start presenting the output of a batch column.
Note that this positions the output on the first item, not before the first item,
so it is not necessary to call <see cref="M:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe.MoveNext"/> to get the first value.
</summary>
<param name="batchCol">The batch column whose values we should start presenting.</param>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe.MoveNext">
<summary>
Moves to the next value. Note that this should be called only when we are certain that
we have a next value to move to, that is, when <see cref="P:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe.Remaining"/> is non-zero.
</summary>
</member>
<member name="T:Microsoft.ML.Data.DataViewUtils.Splitter.Cursor">
<summary>
A cursor used by both the splitter and consolidator, that iteratively consumes
<see cref="P:Microsoft.ML.Data.DataViewUtils.Splitter.Cursor.Batch"/> objects from the input blocking collection, and yields the
values stored therein through the help of <see cref="T:Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe"/> objects.
</summary>
</member>
<member name="M:Microsoft.ML.Data.DataViewUtils.Splitter.Cursor.#ctor(Microsoft.ML.IChannelProvider,Microsoft.Data.DataView.DataViewSchema,System.Int32[],System.Int32[],Microsoft.ML.Data.DataViewUtils.Splitter.OutPipe[],System.Collections.Concurrent.BlockingCollection{Microsoft.ML.Data.DataViewUtils.Splitter.Batch},System.Action)">
<summary>
Constructs one of the split cursors.
</summary>
<param name="provider">The channel provider.</param>
<param name="schema">The schema.</param>
<param name="activeToCol">The mapping from active indices, to input column indices.</param>
<param name="colToActive">The reverse mapping from input column indices to active indices,
where -1 is present if this column is not active.</param>
<param name="pipes">The output pipes, one per channel of information</param>
<param name="batchInputs"></param>
<param name="quitAction"></param>
</member>
<member name="T:Microsoft.ML.Data.DataViewUtils.SynchronousConsolidatingCursor">
<summary>
This is a consolidating cursor that is usable even with cursors that are uncachable,
at the cost of being totally synchronous, that is, there is no parallel benefit from
having split the input cursors.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IMultiStreamSource">
<summary>
An interface for exposing some number of items that can be opened for reading.
</summary>
REVIEW: Reconcile this with the functionality exposed by IHostEnvironment. For example,
we could simply replace this with an array of IFileHandle.
</member>
<member name="P:Microsoft.ML.Data.IMultiStreamSource.Count">
<summary>
Gets the number of items.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IMultiStreamSource.GetPathOrNull(System.Int32)">
<summary>
Return a string representing the "path" to the index'th stream. May return null.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IMultiStreamSource.Open(System.Int32)">
<summary>
Opens the indicated item and returns a readable stream on it.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IMultiStreamSource.OpenTextReader(System.Int32)">
<summary>
Opens the indicated item and returns a text stream reader on it.
</summary>
REVIEW: Consider making this an extension method.
</member>
<member name="T:Microsoft.ML.Data.SignatureDataLoader">
<summary>
Signature for creating an <see cref="T:Microsoft.ML.Data.ILegacyDataLoader"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SignatureLoadDataLoader">
<summary>
Signature for loading an <see cref="T:Microsoft.ML.Data.ILegacyDataLoader"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ILegacyDataLoader">
<summary>
Interface for a data loader. An <see cref="T:Microsoft.ML.Data.ILegacyDataLoader"/> can save its model information
and is instantiatable from arguments and an <see cref="T:Microsoft.ML.Data.IMultiStreamSource"/> .
</summary>
</member>
<member name="M:Microsoft.ML.Data.IDataSaver.IsColumnSavable(Microsoft.Data.DataView.DataViewType)">
<summary>
Check if the column can be saved.
</summary>
<returns>True if the column is savable.</returns>
</member>
<member name="M:Microsoft.ML.Data.IDataSaver.SaveData(System.IO.Stream,Microsoft.Data.DataView.IDataView,System.Int32[])">
<summary>
Save the data into the given stream. The stream should be kept open.
</summary>
<param name="stream">The stream that the data will be written.</param>
<param name="data">The data to be saved.</param>
<param name="cols">The list of column indices to be saved.</param>
</member>
<member name="T:Microsoft.ML.Data.SignatureDataTransform">
<summary>
Signature for creating an <see cref="T:Microsoft.ML.Data.IDataTransform"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SignatureLoadDataTransform">
<summary>
Signature for loading an <see cref="T:Microsoft.ML.Data.IDataTransform"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IDataTransform">
<summary>
Interface for a data transform. An <see cref="T:Microsoft.ML.Data.IDataTransform"/> can save its model information
and is instantiatable from arguments and an input <see cref="T:Microsoft.Data.DataView.IDataView"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ITransformTemplate">
<summary>
Data transforms need to be able to apply themselves to a different input IDataView.
This interface allows them to implement custom rebinding logic.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IRowSeekable">
<summary>
Represents a data view that supports random access to a specific row.
</summary>
</member>
<member name="T:Microsoft.ML.Data.RowSeeker">
<summary>
Represents a row seeker with random access that can retrieve a specific row by the row index.
For <see cref="T:Microsoft.ML.Data.RowSeeker"/>, when the state is valid (that is when <see cref="M:Microsoft.ML.Data.RowSeeker.MoveTo(System.Int64)"/>
returns <see langword="true"/>), it returns the current row index. Otherwise it's -1.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowSeeker.MoveTo(System.Int64)">
<summary>
Moves the seeker to a row at a specific row index.
If the row index specified is out of range (less than zero or not less than the
row count), it returns false and sets its Position property to -1.
</summary>
<param name="rowIndex">The row index to move to.</param>
<returns>True if a row with specified index is found; false otherwise.</returns>
</member>
<member name="T:Microsoft.ML.Data.ITransposeDataView">
<summary>
A view of data where columns can optionally be accessed slot by slot, as opposed to row
by row in a typical dataview. A slot-accessible column can be accessed with a slot-by-slot
cursor via an <see cref="T:Microsoft.ML.Data.SlotCursor"/> returned by <see cref="M:Microsoft.ML.Data.ITransposeDataView.GetSlotCursor(System.Int32)"/>
(naturally, as opposed to row-by-row through an <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/>). This interface
is intended to be implemented by classes that want to provide an option for an alternate
way of accessing the data stored in a <see cref="T:Microsoft.Data.DataView.IDataView"/>.
The interface only advertises that columns may be accessible in slot-wise fashion. The i-th column
is accessible in this fashion iff <see cref="M:Microsoft.ML.Data.ITransposeDataView.GetSlotType(System.Int32)"/> with col=i doesn't return <see langword="null"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ITransposeDataView.GetSlotCursor(System.Int32)">
<summary>
Presents a cursor over the slots of a transposable column, or throws if the column
is not transposable.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ITransposeDataView.GetSlotType(System.Int32)">
<summary>
<see cref="M:Microsoft.ML.Data.ITransposeDataView.GetSlotType(System.Int32)"/> (input argument is named col) specifies the type of all values at the col-th column of
<see cref="T:Microsoft.Data.DataView.IDataView"/>. For example, if <see cref="P:Microsoft.Data.DataView.IDataView.Schema"/>[i] is a scalar float column, then
<see cref="M:Microsoft.ML.Data.ITransposeDataView.GetSlotType(System.Int32)"/> with col=i may return a <see cref="T:Microsoft.ML.Data.VectorType"/> whose <see cref="P:Microsoft.ML.Data.VectorType.ItemType"/>
field is <see cref="P:Microsoft.Data.DataView.NumberDataViewType.Single"/>. If the i-th column can't be iterated column-wisely, this function may
return <see langword="null"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.GetGetterAsDelegate(Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
Returns an appropriate <see cref="T:Microsoft.Data.DataView.ValueGetter`1"/> for a row given an active column
index, but as a delegate. The type parameter for the delegate will correspond to the
raw type of the column.
</summary>
<param name="row">The row to get the getter for</param>
<param name="col">The column index, which must be active on that row</param>
<returns>The getter as a delegate</returns>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.GetGetterAs(Microsoft.Data.DataView.DataViewType,Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
Given a destination type, IRow, and column index, return a ValueGetter for the column
with a conversion to typeDst, if needed. This is a weakly typed version of
<see cref="M:Microsoft.ML.Data.RowCursorUtils.GetGetterAs``1(Microsoft.Data.DataView.DataViewType,Microsoft.Data.DataView.DataViewRow,System.Int32)"/>.
</summary>
<seealso cref="M:Microsoft.ML.Data.RowCursorUtils.GetGetterAs``1(Microsoft.Data.DataView.DataViewType,Microsoft.Data.DataView.DataViewRow,System.Int32)"/>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.GetGetterAs``1(Microsoft.Data.DataView.DataViewType,Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
Given a destination type, IRow, and column index, return a ValueGetter{TDst} for the column
with a conversion to typeDst, if needed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.GetGetterAsStringBuilder(Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
Given an IRow, and column index, return a function that utilizes the
<see cref="M:Microsoft.ML.Data.Conversion.Conversions.GetStringConversion``1(Microsoft.Data.DataView.DataViewType)"/> on the input
rows to map the values in the column, whatever type they may be, into a string
builder. This method will obviously succeed only if there is a string conversion
into the required type. This method can be useful if you want to output a value
as a string in a generic way, but don't really care how you do it.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.GetVecGetterAs(Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
Given the item type, typeDst, a row, and column index, return a ValueGetter for the vector-valued
column with a conversion to a vector of typeDst, if needed. This is the weakly typed version of
<see cref="M:Microsoft.ML.Data.RowCursorUtils.GetVecGetterAs``1(Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.Data.DataView.DataViewRow,System.Int32)"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.GetVecGetterAs``1(Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
Given the item type, typeDst, a row, and column index, return a ValueGetter{VBuffer{TDst}} for the
vector-valued column with a conversion to a vector of typeDst, if needed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.GetVecGetterAs``1(Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.ML.Data.SlotCursor)">
<summary>
Given the item type, typeDst, and a slot cursor, return a ValueGetter{VBuffer{TDst}} for the
vector-valued column with a conversion to a vector of typeDst, if needed.
</summary>
</member>
<member name="T:Microsoft.ML.Data.RowCursorUtils.GetterFactory">
<summary>
A convenience wrapper to generalize the operation of fetching a <see cref="T:Microsoft.Data.DataView.ValueGetter`1"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.GetIsNewGroupDelegate(Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
This method returns a small helper delegate that returns whether we are at the start
of a new group, that is, we have just started, or the key-value at indicated column
is different than it was, in the last call. This is practically useful for determining
group boundaries. Note that the delegate will return true on the first row.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.Fetch``1(Microsoft.ML.IExceptionContext,Microsoft.Data.DataView.DataViewRow,System.String)">
<summary>
Fetches the value of the column by name, in the given row.
Used by the evaluators to retrieve the metrics from the results IDataView.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.RowAsDataView(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.DataViewRow)">
<summary>
Given a row, returns a one-row data view. This is useful for cases where you have a row, and you
wish to use some facility normally only exposed to dataviews. (For example, you have an <see cref="T:Microsoft.Data.DataView.DataViewRow"/>
but want to save it somewhere using a <see cref="T:Microsoft.ML.Data.IO.BinarySaver"/>.)
Note that it is not possible for this method to ensure that the input <paramref name="row"/> does not
change, so users of this convenience must take care of what they do with the input row or the data
source it came from, while the returned dataview is potentially being used.
</summary>
<param name="env">An environment used to create the host for the resulting data view</param>
<param name="row">A row, whose columns must all be active</param>
<returns>A single-row data view incorporating that row</returns>
</member>
<member name="M:Microsoft.ML.Data.RowCursorUtils.FromColumnsToPredicate(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column},Microsoft.Data.DataView.DataViewSchema)">
<summary>
Given a collection of <see cref="T:Microsoft.Data.DataView.DataViewSchema.Column"/>, that is a subset of the Schema of the data, create a predicate,
that when passed a column index, will return <langword>true</langword> or <langword>false</langword>, based on whether
the column with the given <see cref="P:Microsoft.Data.DataView.DataViewSchema.Column.Index"/> is part of the <paramref name="columnsNeeded"/>.
</summary>
<param name="columnsNeeded">The subset of columns from the <see cref="T:Microsoft.Data.DataView.DataViewSchema"/> that are needed from this <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/>.</param>
<param name="sourceSchema">The <see cref="T:Microsoft.Data.DataView.DataViewSchema"/> from where the columnsNeeded originate.</param>
</member>
<member name="F:Microsoft.ML.Data.RowCursorUtils.FetchValueStateError">
<summary>
This is an error message meant to be used in the situation where a user calls a delegate as returned from
<see cref="M:Microsoft.Data.DataView.DataViewRow.GetIdGetter"/> or <see cref="M:Microsoft.Data.DataView.DataViewRow.GetGetter``1(System.Int32)"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SchemaAnnotationsExtensions">
<summary>
Extension methods to facilitate easy consumption of popular contents of <see cref="P:Microsoft.Data.DataView.DataViewSchema.Column.Annotations"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SchemaAnnotationsExtensions.HasSlotNames(Microsoft.Data.DataView.DataViewSchema.Column)">
<summary>
Returns <see langword="true"/> if the input column is of <see cref="T:Microsoft.ML.Data.VectorType"/>, and that has
<c>SlotNames</c> annotation of a <see cref="T:Microsoft.ML.Data.VectorType"/> whose <see cref="P:Microsoft.ML.Data.VectorType.ItemType"/>
is of <see cref="T:Microsoft.Data.DataView.TextDataViewType"/>, and further whose <see cref="P:Microsoft.ML.Data.VectorType.Size"/> matches
this input vector size.
</summary>
<param name="column">The column whose <see cref="P:Microsoft.Data.DataView.DataViewSchema.Column.Annotations"/> will be queried.</param>
<seealso cref="M:Microsoft.ML.Data.SchemaAnnotationsExtensions.GetSlotNames(Microsoft.Data.DataView.DataViewSchema.Column,Microsoft.ML.Data.VBuffer{System.ReadOnlyMemory{System.Char}}@)"/>
</member>
<member name="M:Microsoft.ML.Data.SchemaAnnotationsExtensions.GetSlotNames(Microsoft.Data.DataView.DataViewSchema.Column,Microsoft.ML.Data.VBuffer{System.ReadOnlyMemory{System.Char}}@)">
<summary>
Stores the slots names of the input column into the provided buffer, if there are slot names.
Otherwise it will throw an exception.
</summary>
<seealso cref="M:Microsoft.ML.Data.SchemaAnnotationsExtensions.HasSlotNames(Microsoft.Data.DataView.DataViewSchema.Column)"/>
<param name="column">The column whose <see cref="P:Microsoft.Data.DataView.DataViewSchema.Column.Annotations"/> will be queried.</param>
<param name="slotNames">The <see cref="T:Microsoft.ML.Data.VBuffer`1"/> into which the slot names will be stored.</param>
</member>
<member name="M:Microsoft.ML.Data.SchemaAnnotationsExtensions.HasKeyValues(Microsoft.Data.DataView.DataViewSchema.Column,Microsoft.Data.DataView.PrimitiveDataViewType)">
<summary>
Returns <see langword="true"/> if the input column is of <see cref="T:Microsoft.ML.Data.VectorType"/>, and that has
<c>SlotNames</c> annotation of a <see cref="T:Microsoft.ML.Data.VectorType"/> whose <see cref="P:Microsoft.ML.Data.VectorType.ItemType"/>
is of <see cref="T:Microsoft.Data.DataView.TextDataViewType"/>, and further whose <see cref="P:Microsoft.ML.Data.VectorType.Size"/> matches
this input vector size.
</summary>
<param name="column">The column whose <see cref="P:Microsoft.Data.DataView.DataViewSchema.Column.Annotations"/> will be queried.</param>
<param name="keyValueItemType">The type of the individual key-values to query. A common,
though not universal, type to provide is <see cref="P:Microsoft.Data.DataView.TextDataViewType.Instance"/>, so if left unspecified
this will be assumed to have the value <see cref="P:Microsoft.Data.DataView.TextDataViewType.Instance"/>.</param>
<seealso cref="M:Microsoft.ML.Data.SchemaAnnotationsExtensions.GetKeyValues``1(Microsoft.Data.DataView.DataViewSchema.Column,Microsoft.ML.Data.VBuffer{``0}@)"/>
</member>
<member name="M:Microsoft.ML.Data.SchemaAnnotationsExtensions.GetKeyValues``1(Microsoft.Data.DataView.DataViewSchema.Column,Microsoft.ML.Data.VBuffer{``0}@)">
<summary>
Stores the key values of the input colum into the provided buffer, if this is of key type and whose
key values are of <see cref="P:Microsoft.ML.Data.VectorType.ItemType"/> whose <see cref="P:Microsoft.Data.DataView.DataViewType.RawType"/> matches
<typeparamref name="TValue"/>. If there is no matching key valued annotation this will throw an exception.
</summary>
<typeparam name="TValue">The type of the key values.</typeparam>
<param name="column">The column whose <see cref="P:Microsoft.Data.DataView.DataViewSchema.Column.Annotations"/> will be queried.</param>
<param name="keyValues">The <see cref="T:Microsoft.ML.Data.VBuffer`1"/> into which the key values will be stored.</param>
</member>
<member name="M:Microsoft.ML.Data.SchemaAnnotationsExtensions.IsNormalized(Microsoft.Data.DataView.DataViewSchema.Column)">
<summary>
Returns <see langword="true"/> if and only if <paramref name="column"/> has <c>IsNormalized</c> annotation
set to <see langword="true"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.KeyTypeAttribute">
<summary>
Allow member to be marked as a <see cref="T:Microsoft.ML.Data.KeyType"/>.
</summary>
<remarks>
Can be applied only for member of following types: <see cref="T:System.Byte"/>, <see cref="T:System.UInt16"/>, <see cref="T:System.UInt32"/>, <see cref="T:System.UInt64"/>
</remarks>
</member>
<member name="M:Microsoft.ML.Data.KeyTypeAttribute.#ctor">
<summary>
Marks member as <see cref="T:Microsoft.ML.Data.KeyType"/>.
</summary>
<remarks>
Cardinality of <see cref="T:Microsoft.ML.Data.KeyType"/> would be maximum legal value of member type.
</remarks>
</member>
<member name="M:Microsoft.ML.Data.KeyTypeAttribute.#ctor(System.UInt64)">
<summary>
Marks member as <see cref="T:Microsoft.ML.Data.KeyType"/> and specifies <see cref="T:Microsoft.ML.Data.KeyType"/> cardinality.
</summary>
<param name="count">Cardinality of <see cref="T:Microsoft.ML.Data.KeyType"/>.</param>
</member>
<member name="P:Microsoft.ML.Data.KeyTypeAttribute.KeyCount">
<summary>
The key count.
</summary>
</member>
<member name="T:Microsoft.ML.Data.VectorTypeAttribute">
<summary>
Allows a member to be marked as a <see cref="T:Microsoft.ML.Data.VectorType"/>, primarily allowing one to set
the dimensionality of the resulting array.
</summary>
</member>
<member name="P:Microsoft.ML.Data.VectorTypeAttribute.Dims">
<summary>
The length of the vectors from this vector valued field.
</summary>
</member>
<member name="M:Microsoft.ML.Data.VectorTypeAttribute.#ctor">
<summary>
Mark member as single-dimensional array with unknown size.
</summary>
</member>
<member name="M:Microsoft.ML.Data.VectorTypeAttribute.#ctor(System.Int32)">
<summary>
Mark member as single-dimensional array with specified size.
</summary>
<param name="size">Expected size of array. A zero value indicates that the vector type is considered to have unknown length.</param>
</member>
<member name="M:Microsoft.ML.Data.VectorTypeAttribute.#ctor(System.Int32[])">
<summary>
Mark member with expected dimensions of array.
</summary>
<param name="dimensions">Dimensions of array. All values should be non-negative.
A zero value indicates that the vector type is considered to have unknown length along that dimension.</param>
</member>
<member name="T:Microsoft.ML.Data.ColumnNameAttribute">
<summary>
Allows a member to specify <see cref="T:Microsoft.Data.DataView.IDataView"/> column name directly, as opposed to the default
behavior of using the member name as the column name.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ColumnNameAttribute.Name">
<summary>
Column name.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnNameAttribute.#ctor(System.String)">
<summary>
Allows one to specify a name to expose this column as, as opposed to the default
behavior of using the member name as the column name.
</summary>
</member>
<member name="T:Microsoft.ML.Data.NoColumnAttribute">
<summary>
Mark this member as not being exposed as a <see cref="T:Microsoft.Data.DataView.IDataView"/> column in the <see cref="T:Microsoft.Data.DataView.DataViewSchema"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.CursorChannelAttribute">
<summary>
Mark a member that implements exactly IChannel as being permitted to receive
channel information from an external channel.
</summary>
</member>
<member name="M:Microsoft.ML.Data.CursorChannelAttribute.TrySetCursorChannel``1(Microsoft.ML.IExceptionContext,``0,Microsoft.ML.IChannel)">
<summary>
When passed some object, and a channel, it attempts to pass the channel to the object. It
passes the channel to the object iff the object has exactly one field marked with the
CursorChannelAttribute, and that field implements only the IChannel interface.
The function returns the modified object, as well as a boolean indicator of whether it was
able to pass the channel to the object.
</summary>
<param name="obj">The object that attempts to acquire the channel.</param>
<param name="channel">The channel to pass to the object.</param>
<param name="ectx">The exception context.</param>
<returns>1. A boolean indicator of whether the channel was sucessfully passed to the object.
2. The object passed in (only modified by the addition of the channel to the field
with the CursorChannelAttribute, if the channel was added sucessfully).</returns>
</member>
<member name="T:Microsoft.ML.Data.SchemaDefinition">
<summary>
This class defines a schema of a typed data view.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SchemaDefinition.Column">
<summary>
One column of the data view.
</summary>
</member>
<member name="P:Microsoft.ML.Data.SchemaDefinition.Column.MemberName">
<summary>
The name of the member the column is taken from. The API
requires this to not be null, and a valid name of a member of
the type for which we are creating a schema.
</summary>
</member>
<member name="P:Microsoft.ML.Data.SchemaDefinition.Column.ColumnName">
<summary>
The name of the column that's created in the data view. If this
is null, the API uses the <see cref="P:Microsoft.ML.Data.SchemaDefinition.Column.MemberName"/>.
</summary>
</member>
<member name="P:Microsoft.ML.Data.SchemaDefinition.Column.ColumnType">
<summary>
The column type. If this is null, the API attempts to derive a type
from the member's type.
</summary>
</member>
<member name="P:Microsoft.ML.Data.SchemaDefinition.Column.IsComputed">
<summary>
Whether the column is a computed type.
</summary>
</member>
<member name="P:Microsoft.ML.Data.SchemaDefinition.Column.Generator">
<summary>
The generator function. if the column is computed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SchemaDefinition.Column.AddAnnotation``1(System.String,``0,Microsoft.Data.DataView.DataViewType)">
<summary>
Add annotation to the column.
</summary>
<typeparam name="T">Type of annotation being added. Types suported as entries in columns
are also supported as entries in Annotations. Multiple annotations may be added to one column.
</typeparam>
<param name="kind">The string identifier of the annotation.</param>
<param name="value">Value of annotation.</param>
<param name="annotationType">Type of value.</param>
</member>
<member name="M:Microsoft.ML.Data.SchemaDefinition.Column.RemoveAnnotation(System.String)">
<summary>
Remove annotation from the column if it exists.
</summary>
<param name="kind">The string identifier of the annotation.</param>
</member>
<member name="P:Microsoft.ML.Data.SchemaDefinition.Column.GetAnnotationTypes">
<summary>
Returns annotations kind and type associated with this column.
</summary>
<returns>A dictionary with the kind of the annotation as the key, and the
annotation type as the associated value.</returns>
</member>
<member name="P:Microsoft.ML.Data.SchemaDefinition.Item(System.String)">
<summary>
Get or set the column definition by column name.
If there's no such column:
- get returns null,
- set adds a new column.
If there's more than one column with the same name:
- get returns the first column,
- set replaces the first column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SchemaDefinition.Create(System.Type,Microsoft.ML.Data.SchemaDefinition.Direction)">
<summary>
Create a schema definition by enumerating all public fields of the given type.
</summary>
<param name="userType">The type to base the schema on.</param>
<param name="direction">Accept fields and properties based on their direction.</param>
<returns>The generated schema definition.</returns>
</member>
<member name="T:Microsoft.ML.Data.SlotCursor">
<summary>
A cursor that allows slot-by-slot access of data. This is to <see cref="T:Microsoft.ML.Data.ITransposeDataView"/>
what <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/> is to <see cref="T:Microsoft.Data.DataView.IDataView"/>.
</summary>
</member>
<member name="P:Microsoft.ML.Data.SlotCursor.IsGood">
<summary>
Whether the cursor is in a state where it can serve up data, that is, <see cref="M:Microsoft.ML.Data.SlotCursor.MoveNext"/>
has been called and returned <see langword="true"/>.
</summary>
</member>
<member name="P:Microsoft.ML.Data.SlotCursor.SlotIndex">
<summary>
The slot index. Incremented by one when <see cref="M:Microsoft.ML.Data.SlotCursor.MoveNext"/> is called and returns <see langword="true"/>.
When initially created, or after <see cref="M:Microsoft.ML.Data.SlotCursor.MoveNext"/> returns <see langword="false"/>, this will be <c>-1</c>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SlotCursor.MoveNext">
<summary>
Advance to the next slot. When the cursor is first created, this method should be called to
move to the first slot. Returns <see langword="false"/> if there are no more slots.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SlotCursor.GetSlotType">
<summary>
The slot type for this cursor. Note that this should equal the
<see cref="M:Microsoft.ML.Data.ITransposeDataView.GetSlotType(System.Int32)"/> for the column from which this slot cursor
was created.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SlotCursor.GetGetter``1">
<summary>
A getter delegate for the slot values. The type <typeparamref name="TValue"/> must correspond
to the item type from <see cref="M:Microsoft.ML.Data.ITransposeDataView.GetSlotType(System.Int32)"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SlotCursor.SynchronizedSlotCursor">
<summary>
For wrapping another slot cursor from which we get <see cref="P:Microsoft.ML.Data.SlotCursor.SynchronizedSlotCursor.SlotIndex"/> and <see cref="M:Microsoft.ML.Data.SlotCursor.SynchronizedSlotCursor.MoveNext"/>,
but not the data or type accesors. Somewhat analogous to the <see cref="T:Microsoft.ML.Data.SynchronizedCursorBase"/>
for <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/>s.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SlotCursor.RootSlotCursor">
<summary>
A useful base class for common <see cref="T:Microsoft.ML.Data.SlotCursor"/> implementations, somewhat
analogous to the <see cref="T:Microsoft.ML.Data.RootCursorBase"/> for <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/>s.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SlotCursor.RootSlotCursor.MoveNextCore">
<summary>
Core implementation of <see cref="M:Microsoft.ML.Data.SlotCursor.RootSlotCursor.MoveNext"/>. This is called only if this method
has not yet previously returned <see langword="false"/>.
</summary>
</member>
<member name="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sources">
<summary>
A collection of source column indices after removing those we want to drop. Specifically, j=_sources[i] means
that the i-th output column in the output schema is the j-th column in the input schema.
</summary>
</member>
<member name="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sourceSchema">
<summary>
Input schema of this transform. It's useful when determining column dependencies and other
relations between input and output schemas.
</summary>
</member>
<member name="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._selectedColumnIndexes">
<summary>
Some column indexes in the input schema. <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sources"/> is computed from <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._selectedColumnIndexes"/>
and <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._drop"/>.
</summary>
</member>
<member name="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._drop">
<summary>
True, if this transform drops selected columns indexed by <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._selectedColumnIndexes"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings.ComputeSources(System.Boolean,System.Int32[],Microsoft.Data.DataView.DataViewSchema,System.Int32[]@)">
<summary>
Common method of computing <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sources"/> from necessary parameters. This function is used in constructors.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings.ComputeOutputSchema">
<summary>
After <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sourceSchema"/> and <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sources"/> are set, pick up selected columns from <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sourceSchema"/> to create <see cref="P:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings.OutputSchema"/>
Note that <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sources"/> tells us what columns in <see cref="F:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings._sourceSchema"/> are put into <see cref="P:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings.OutputSchema"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ChooseColumnsByIndexTransform.Bindings.GetSourceColumnIndex(System.Int32)">
<summary>
Given the column index in the output schema, this function returns its source column's index in the input schema.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ChooseColumnsByIndexTransform.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ChooseColumnsByIndexTransform.Options,Microsoft.Data.DataView.IDataView)">
<summary>
Public constructor corresponding to SignatureDataTransform.
</summary>
</member>
<member name="F:Microsoft.ML.Data.AnomalyDetectionEvaluator.TopKResults">
<summary>
The anomaly detection evaluator outputs a data view by this name, which contains the the examples
with the top scores in the test set. It contains the three columns listed below, with each row corresponding
to one test example.
</summary>
</member>
<member name="M:Microsoft.ML.Data.AnomalyDetectionEvaluator.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Evaluates scored anomaly detection data.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="predictedLabel">The name of the predicted label column in <paramref name="data"/>.</param>
<returns>The evaluation results for these outputs.</returns>
</member>
<member name="T:Microsoft.ML.Data.EvaluatorBase`1">
<summary>
This is a base class for TLC evaluators. It implements both of the <see cref="T:Microsoft.ML.Data.IEvaluator"/> methods: <see cref="T:Microsoft.ML.Data.Evaluate"/> and
<see cref="M:Microsoft.ML.Data.EvaluatorBase`1.GetPerInstanceMetricsCore(Microsoft.ML.Data.RoleMappedData)"/>. Note that the input <see cref="T:Microsoft.ML.Data.RoleMappedData"/> is assumed to contain all the column
roles needed for evaluation, including the score column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.UnweightedAuPrcAggregator.ComputeWeightedAuPrcCore(System.Double@)">
<summary>
Compute the AUPRC using the "lower trapesoid" estimator, as described in the paper
<a href="https://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf">https://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf</a>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.WeightedAuPrcAggregator.ComputeWeightedAuPrcCore(System.Double@)">
<summary>
Compute the AUPRC using the "lower trapesoid" estimator, as described in the paper
<a href="https://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf">https://www.ecmlpkdd2013.org/wp-content/uploads/2013/07/aucpr_2013ecml_corrected.pdf</a>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.CheckColumnTypes(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Checks the column types of the evaluator's input columns. The base class implementation checks only the type
of the weight column, and all other columns should be checked by the deriving classes in <see cref="M:Microsoft.ML.Data.EvaluatorBase`1.CheckCustomColumnTypesCore(Microsoft.ML.Data.RoleMappedSchema)"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.CheckScoreAndLabelTypes(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Check that the types of the score and label columns are as expected by the evaluator. The <see cref="T:Microsoft.ML.Data.RoleMappedSchema"/>
is assumed to contain the label column (if it exists) and the score column.
Access the label column with the <see cref="P:Microsoft.ML.Data.RoleMappedSchema.Label"/> property, and the score column with the
<see cref="M:Microsoft.ML.Data.RoleMappedSchema.GetUniqueColumn(Microsoft.ML.Data.RoleMappedSchema.ColumnRole)"/> or <see cref="M:Microsoft.ML.Data.RoleMappedSchema.GetColumns(Microsoft.ML.Data.RoleMappedSchema.ColumnRole)"/> methods.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.CheckCustomColumnTypesCore(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Check the types of any other columns needed by the evaluator. Only override if the evaluator uses
columns other than label, score and weight.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.GetActiveColsCore(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Used in the Evaluate() method, to get the predicate for cursoring over the data.
The base class implementation activates the score column, the label column if it exists, the weight column if it exists
and the stratification columns.
Override if other input columns need to be activated.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.GetAggregator(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Get an aggregator for the specific evaluator given the current RoleMappedSchema.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.GetAggregatorDictionaries(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
For each stratification column, get an aggregator dictionary.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.GetAggregatorConsolidationFuncs(`0,Microsoft.ML.Data.EvaluatorBase{`0}.AggregatorDictionaryBase[],System.Action{System.UInt32,System.ReadOnlyMemory{System.Char},`0}@,System.Func{System.Collections.Generic.Dictionary{System.String,Microsoft.Data.DataView.IDataView}}@)">
<summary>
This method returns two functions used to create the data views of metrics computed by the different
aggregators (the overall one, and any stratified ones if they exist). The <paramref name="addAgg"/>
function is called for every aggregator, and it is where the aggregators should finish their aggregations
and the aggregator results should be stored. The <paramref name="consolidate"/> function
is called after <paramref name="addAgg"/> has been called on all the aggregators, and it returns
the dictionary of metric data views.
</summary>
</member>
<member name="T:Microsoft.ML.Data.EvaluatorBase`1.AggregatorBase">
<summary>
This is a helper class for evaluators deriving from EvaluatorBase, used for computing aggregate metrics.
Aggregators should keep track of the number of passes done. The <see cref="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorBase.InitializeNextPass(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Data.RoleMappedSchema)"/> method should get
the input getters of the given IRow that are needed for the current pass, assuming that all the needed column
information is stored in the given <see cref="T:Microsoft.ML.Data.RoleMappedSchema"/>.
In <see cref="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorBase.ProcessRow"/> the aggregator should call the getters once, and process the input as needed.
<see cref="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorBase.FinishPass"/> increments the pass count after each pass.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorBase.InitializeNextPass(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
This method should get the getters of the new IRow that are needed for the next pass.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorBase.ProcessRow">
<summary>
Call the getters once, and process the input as necessary.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorBase.FinishPass">
<summary>
Increment the pass count. Return true if additional passes are needed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorBase.GetWarnings(System.Collections.Generic.Dictionary{System.String,Microsoft.Data.DataView.IDataView},Microsoft.ML.IHostEnvironment)">
<summary>
Returns a dictionary from metric kinds to data views containing the metrics.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorDictionaryBase.Reset(Microsoft.Data.DataView.DataViewRow)">
<summary>
Gets the stratification column getter for the new IRow.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorDictionaryBase.Get">
<summary>
This method calls the getter of the stratification column, and returns the aggregator corresponding to
the stratification value.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Data.EvaluatorBase`1.AggregatorDictionaryBase.GetAll">
<summary>
This method returns the aggregators corresponding to all the stratification values seen so far.
</summary>
</member>
<member name="F:Microsoft.ML.Data.BinaryClassifierEvaluator.PrCurve">
<summary>
Binary classification evaluator outputs a data view with this name, which contains the p/r data.
It contains the columns listed below, and in case data also contains a weight column, it contains
also columns for the weighted values.
and false positive rate.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BinaryClassifierEvaluator.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String,System.String)">
<summary>
Evaluates scored binary classification data.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="probability">The name of the probability column in <paramref name="data"/>, the calibrated version of <paramref name="score"/>.</param>
<param name="predictedLabel">The name of the predicted label column in <paramref name="data"/>.</param>
<returns>The evaluation results for these calibrated outputs.</returns>
</member>
<member name="M:Microsoft.ML.Data.BinaryClassifierEvaluator.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Evaluates scored binary classification data, without probability-based metrics.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="predictedLabel">The name of the predicted label column in <paramref name="data"/>.</param>
<returns>The evaluation results for these uncalibrated outputs.</returns>
<seealso cref="M:Microsoft.ML.Data.BinaryClassifierEvaluator.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)"/>
</member>
<member name="M:Microsoft.ML.Data.ClusteringEvaluator.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Evaluates scored clustering data.
</summary>
<param name="data">The scored data.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="label">The name of the optional label column in <paramref name="data"/>.</param>
<param name="features">The name of the optional feature column in <paramref name="data"/>.</param>
<returns>The evaluation results.</returns>
</member>
<member name="T:Microsoft.ML.Data.PerInstanceEvaluatorBase">
<summary>
This is a helper class for creating the per-instance IDV.
</summary>
</member>
<member name="M:Microsoft.ML.Data.PerInstanceEvaluatorBase.SaveModel(Microsoft.ML.ModelSaveContext)">
<summary>
Derived class, for example A, should overwrite <see cref="M:Microsoft.ML.Data.PerInstanceEvaluatorBase.SaveModel(Microsoft.ML.ModelSaveContext)"/> so that ((<see cref="T:Microsoft.ML.ICanSaveModel"/>)A).Save(ctx) can correctly dump A.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.GetScoreColumn(Microsoft.ML.IExceptionContext,Microsoft.Data.DataView.DataViewSchema,System.String,System.String,System.String,System.String,System.String)">
<summary>
Find the score column to use. If <paramref name="name"/> is specified, that is used. Otherwise, this searches
for the most recent score set of the given <paramref name="kind"/>. If there is no such score set and
<paramref name="defName"/> is specifed it uses <paramref name="defName"/>. Otherwise, it throws.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.GetOptAuxScoreColumn(Microsoft.ML.IExceptionContext,Microsoft.Data.DataView.DataViewSchema,System.String,System.String,System.Int32,System.String,System.Func{Microsoft.Data.DataView.DataViewType,System.Boolean})">
<summary>
Find the optional auxilliary score column to use. If <paramref name="name"/> is specified, that is used.
Otherwise, if <paramref name="colScore"/> is part of a score set, this looks in the score set for a column
with the given <paramref name="valueKind"/>. If none is found, it returns <see langword="null"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.GetColName(System.String,System.Nullable{Microsoft.Data.DataView.DataViewSchema.Column},System.String)">
<summary>
If <paramref name="str"/> is non-empty, returns it. Otherwise if <paramref name="info"/> is non-<see langword="null"/>,
returns its <see cref="P:Microsoft.Data.DataView.DataViewSchema.Column.Name"/>. Otherwise, returns <paramref name="def"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.GetMetrics(Microsoft.Data.DataView.IDataView,System.Boolean)">
<summary>
Helper method to get an IEnumerable of double metrics from an overall metrics IDV produced by an evaluator.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.AddFoldIndex(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Int32)">
<summary>
Add a text column containing a fold index to a data view.
</summary>
<param name="env">The host environment.</param>
<param name="input">The data view to which we add the column</param>
<param name="curFold">The current fold this data view belongs to.</param>
<returns>The input data view with an additional text column containing the current fold index.</returns>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.AddFoldIndex(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Int32,System.Int32)">
<summary>
Add a key type column containing a fold index to a data view.
</summary>
<param name="env">The host environment.</param>
<param name="input">The data view to which we add the column</param>
<param name="curFold">The current fold this data view belongs to.</param>
<param name="numFolds">The total number of folds.</param>
<returns>The input data view with an additional key type column containing the current fold index.</returns>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.ReconcileSlotNames``1(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView[],System.String,Microsoft.Data.DataView.PrimitiveDataViewType,``0)">
<summary>
This method takes an array of data views and a specified input vector column, and adds a new output column to each of the data views.
First, we find the union set of the slot names in the different data views. Next we define a new vector column for each
data view, indexed by the union of the slot names. For each data view, every slot value is the value in the slot corresponding
to its slot name in the original column. If a reconciled slot name does not exist in an input column, the value in the output
column is def.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.ReconcileKeyValues(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView[],System.String,Microsoft.Data.DataView.DataViewType)">
<summary>
This method takes an array of data views and a specified input key column, and adds a new output column to each of the data views.
First, we find the union set of the key values in the different data views. Next we define a new key column for each
data view, with the union of the key values as the new key values. For each data view, the value in the output column is the value
corresponding to the key value in the original column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.ReconcileKeyValuesWithNoNames(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView[],System.String,System.UInt64)">
<summary>
This method takes an array of data views and a specified input key column, and adds a new output column to each of the data views.
First, we find the union set of the key values in the different data views. Next we define a new key column for each
data view, with the union of the key values as the new key values. For each data view, the value in the output column is the value
corresponding to the key value in the original column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.ReconcileVectorKeyValues(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView[],System.String,Microsoft.Data.DataView.DataViewType)">
<summary>
This method is similar to <see cref="M:Microsoft.ML.Data.EvaluateUtils.ReconcileKeyValues(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView[],System.String,Microsoft.Data.DataView.DataViewType)"/>, but it reconciles the key values over vector
input columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.ConcatenatePerInstanceDataViews(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.IMamlEvaluator,System.Boolean,System.Boolean,Microsoft.ML.Data.RoleMappedData[],System.String[]@)">
<summary>
This method gets the per-instance metrics from multiple scored data views and either returns them as an
array or combines them into a single data view, based on user specifications.
</summary>
<param name="env">A host environment.</param>
<param name="eval">The evaluator to use for getting the per-instance metrics.</param>
<param name="collate">If true, data views are combined into a single data view. Otherwise, data views
are returned as an array.</param>
<param name="outputFoldIndex">If true, a column containing the fold index is added to the returned data views.</param>
<param name="perInstance">The array of scored data views to evaluate. These are passed as <see cref="T:Microsoft.ML.Data.RoleMappedData"/>
so that the evaluator can know the role mappings it needs.</param>
<param name="variableSizeVectorColumnNames">A list of column names that are not included in the combined data view
since their types do not match.</param>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.ConcatenateOverallMetrics(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView[])">
<summary>
Create an output data view that is the vertical concatenation of the metric data views.
</summary>
</member>
<member name="M:Microsoft.ML.Data.EvaluateUtils.CombineFoldMetricsDataViews(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Int32)">
<summary>
Takes a data view containing one or more rows of metrics, and returns a data view containing additional
rows with the average and the standard deviation of the metrics in the input data view.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetricWriter.GetConfusionTable(Microsoft.ML.IHost,Microsoft.Data.DataView.IDataView,System.String@,System.Boolean,System.Int32)">
<summary>
Get the confusion tables as strings to be printed to the Console.
</summary>
<param name="host">The host is used for getting the random number generator for sampling classes</param>
<param name="confusionDataView">The data view containing the confusion matrix. It should contain a text column
with the label names named "LabelNames", and an R8 vector column named "Count" containing the counts: in the row
corresponding to label i, slot j should contain the number of class i examples that were predicted as j by the predictor.</param>
<param name="weightedConfusionTable">If there is an R8 vector column named "Weight" containing the weighted counts, this parameter
is assigned the string representation of the weighted confusion table. Otherwise it is assigned null.</param>
<param name="binary">Indicates whether the confusion table is for binary classification.</param>
<param name="sample">Indicates how many classes to sample from the confusion table (-1 indicates no sampling)</param>
</member>
<member name="M:Microsoft.ML.Data.MetricWriter.GetPerFoldResults(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.String@)">
<summary>
This method returns the per-fold metrics as a string. If weighted metrics are present they are returned in a separate string.
</summary>
<param name="env">An IHostEnvironment.</param>
<param name="fold">The data view containing the per-fold metrics. Each row in the data view represents a set of metrics
calculated either on the whole dataset or on a subset of it defined by a stratification column. If the data view contains
stratified metrics, it must contain two text columns named "StratCol" and "StratVal", containing the stratification column
name, and a text description of the value. In this case, the value of column StratVal in the row corresponding to the entire
dataset should contain the text "overall", and the value of column StratCol should be DvText.NA. If weighted metrics are present
then the data view should also contain a bool column named "IsWeighted".</param>
<param name="weightedMetrics">If the IsWeighted column exists, this is assigned the string representation of the weighted
metrics. Otherwise it is assigned null.</param>
</member>
<member name="M:Microsoft.ML.Data.MetricWriter.PrintOverallMetrics(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,System.String,Microsoft.Data.DataView.IDataView,System.Int32)">
<summary>
Print the overall results to the Console. The overall data view should contain rows from all the folds being averaged.
If filename is not null then also save the results to the specified file. The first row in the file is the averaged
results, followed by the results of each fold.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetricWriter.PrintWarnings(Microsoft.ML.IChannel,System.Collections.Generic.Dictionary{System.String,Microsoft.Data.DataView.IDataView})">
<summary>
Searches for a warning dataview in the given dictionary, and if present, prints the warnings to the given channel. The warning dataview
should contain a text column named "WarningText".
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetricWriter.SavePerInstance(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,System.String,Microsoft.Data.DataView.IDataView,System.Boolean,System.Boolean)">
<summary>
Save the given data view using text saver.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetricWriter.GetNonStratifiedMetrics(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView)">
<summary>
Filter out the stratified results from overall and drop the stratification columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetricKinds">
<summary>
This is a list of string constants denoting 'standard' metric kinds.
</summary>
</member>
<member name="F:Microsoft.ML.Data.MetricKinds.ConfusionMatrix">
<summary>
This data view contains the confusion matrix for N-class classification. It has N rows, and each row has
the following columns:
* Count (vector indicating how many examples of this class were predicted as each one of the classes). This column
should have metadata containing the class names.
* (Optional) Weight (vector with the total weight of the examples of this class that were predicted as each one of the classes).
</summary>
</member>
<member name="F:Microsoft.ML.Data.MetricKinds.OverallMetrics">
<summary>
This is a data view with 'global' dataset-wise metrics in its columns. It has one row containing the overall metrics,
and optionally more rows for weighted metrics, and stratified metrics.
</summary>
</member>
<member name="F:Microsoft.ML.Data.MetricKinds.Warnings">
<summary>
This data view contains a single text column, with warnings about bad input values encountered by the evaluator during
the aggregation of metrics. Each warning is in a separate row.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetricKinds.ColumnNames">
<summary>
Names for the columns in the data views output by evaluators.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IMamlEvaluator">
<summary>
This interface is used by Maml components (the <see cref="T:Microsoft.ML.Data.EvaluateCommand"/>, the <see cref="T:Microsoft.ML.Data.CrossValidationCommand"/>
and the <see cref="T:Microsoft.ML.Data.EvaluateTransform"/> to evaluate, print and save the results.
The input <see cref="T:Microsoft.ML.Data.RoleMappedData"/> to the <see cref="M:Microsoft.ML.Data.IEvaluator.Evaluate(Microsoft.ML.Data.RoleMappedData)"/> and the <see cref="M:Microsoft.ML.Data.IEvaluator.GetPerInstanceMetrics(Microsoft.ML.Data.RoleMappedData)"/> methods
should be assumed to contain only the following column roles: label, group, weight and name. Any other columns needed for
evaluation should be searched for by name in the <see cref="P:Microsoft.ML.Data.RoleMappedData.Schema"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IMamlEvaluator.PrintFoldResults(Microsoft.ML.IChannel,System.Collections.Generic.Dictionary{System.String,Microsoft.Data.DataView.IDataView})">
<summary>
Print the aggregate metrics to the console.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IMamlEvaluator.GetOverallResults(Microsoft.Data.DataView.IDataView[])">
<summary>
Combine the overall metrics from multiple folds into a single data view.
</summary>
<param name="metrics"></param>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Data.IMamlEvaluator.PrintAdditionalMetrics(Microsoft.ML.IChannel,System.Collections.Generic.Dictionary{System.String,Microsoft.Data.DataView.IDataView}[])">
<summary>
Handles custom metrics (such as p/r curves for binary classification, or group summary results for ranking) from one
or more folds. Implementations of this method typically creates a single data view for the custom metric and saves it
to a user specified file.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IMamlEvaluator.GetPerInstanceDataViewToSave(Microsoft.ML.Data.RoleMappedData)">
<summary>
Create a data view containing only the columns that are saved as per-instance results by Maml commands.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MamlEvaluatorBase">
<summary>
A base class implementation of <see cref="T:Microsoft.ML.Data.IMamlEvaluator"/>. The <see cref="T:Microsoft.ML.Data.Evaluate"/> and <see cref="M:Microsoft.ML.Data.IEvaluator.GetPerInstanceMetrics(Microsoft.ML.Data.RoleMappedData)"/>
methods create a new <see cref="T:Microsoft.ML.Data.RoleMappedData"/> containing all the columns needed for evaluation, and call the corresponding
methods on an <see cref="T:Microsoft.ML.Data.IEvaluator"/> of the appropriate type.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MamlEvaluatorBase.GetInputColumnRolesCore(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
All the input columns needed by an evaluator should be added here.
The base class ipmlementation gets the score column, the label column (if exists) and the weight column (if exists).
Override if additional columns are needed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MamlEvaluatorBase.PrintFoldResultsCore(Microsoft.ML.IChannel,System.Collections.Generic.Dictionary{System.String,Microsoft.Data.DataView.IDataView})">
<summary>
This method simply prints the overall metrics using EvaluateUtils.PrintConfusionMatrixAndPerFoldResults.
Override if something else is needed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MamlEvaluatorBase.PrintAdditionalMetricsCore(Microsoft.ML.IChannel,System.Collections.Generic.Dictionary{System.String,Microsoft.Data.DataView.IDataView}[])">
<summary>
This method simply prints the overall metrics using EvaluateUtils.PrintOverallMetrics.
Override if something else is needed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MamlEvaluatorBase.GetPerInstanceMetricsCore(Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
The perInst dataview contains all a name column (called Instance), the FoldId, Label and Weight columns if
they exist, and all the columns returned by <see cref="M:Microsoft.ML.Data.MamlEvaluatorBase.GetPerInstanceColumnsToSave(Microsoft.ML.Data.RoleMappedSchema)"/>.
It should be overridden only if additional processing is needed, such as dropping slots in the "top k scores" column
in the multi-class case.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MamlEvaluatorBase.GetPerInstanceColumnsToSave(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Returns the names of the columns that should be saved in the per-instance results file. These can include
the columns generated by the corresponding <see cref="T:Microsoft.ML.Data.IRowMapper"/>, or any of the input columns used by
it. The Name and Weight columns should not be included, since the base class includes them automatically.
</summary>
</member>
<member name="T:Microsoft.ML.Data.AnomalyDetectionMetrics">
<summary>
Evaluation results for anomaly detection.
</summary>
</member>
<member name="P:Microsoft.ML.Data.AnomalyDetectionMetrics.Auc">
<summary>
Gets the area under the ROC curve.
</summary>
<remarks>
The area under the ROC curve is equal to the probability that the algorithm ranks
a randomly chosen positive instance higher than a randomly chosen negative one
(assuming 'positive' ranks higher than 'negative').
</remarks>
</member>
<member name="P:Microsoft.ML.Data.AnomalyDetectionMetrics.DrAtK">
<summary>
Detection rate at K false positives.
</summary>
<remarks>
This is computed as follows:
1.Sort the test examples by the output of the anomaly detector in descending order of scores.
2.Among the top K False Positives, compute ratio : (True Positive @ K) / (Total anomalies in test data)
Example confusion matrix for anomaly detection:
Anomalies (in test data) | Non-Anomalies (in test data)
Predicted Anomalies : TP | FP
Predicted Non-Anomalies : FN | TN
</remarks>
</member>
<member name="T:Microsoft.ML.Data.BinaryClassificationMetrics">
<summary>
Evaluation results for binary classifiers, excluding probabilistic metrics.
</summary>
</member>
<member name="P:Microsoft.ML.Data.BinaryClassificationMetrics.Auc">
<summary>
Gets the area under the ROC curve.
</summary>
<remarks>
The area under the ROC curve is equal to the probability that the classifier ranks
a randomly chosen positive instance higher than a randomly chosen negative one
(assuming 'positive' ranks higher than 'negative').
</remarks>
</member>
<member name="P:Microsoft.ML.Data.BinaryClassificationMetrics.Accuracy">
<summary>
Gets the accuracy of a classifier which is the proportion of correct predictions in the test set.
</summary>
</member>
<member name="P:Microsoft.ML.Data.BinaryClassificationMetrics.PositivePrecision">
<summary>
Gets the positive precision of a classifier which is the proportion of correctly predicted
positive instances among all the positive predictions (i.e., the number of positive instances
predicted as positive, divided by the total number of instances predicted as positive).
</summary>
</member>
<member name="P:Microsoft.ML.Data.BinaryClassificationMetrics.PositiveRecall">
<summary>
Gets the positive recall of a classifier which is the proportion of correctly predicted
positive instances among all the positive instances (i.e., the number of positive instances
predicted as positive, divided by the total number of positive instances).
</summary>
</member>
<member name="P:Microsoft.ML.Data.BinaryClassificationMetrics.NegativePrecision">
<summary>
Gets the negative precision of a classifier which is the proportion of correctly predicted
negative instances among all the negative predictions (i.e., the number of negative instances
predicted as negative, divided by the total number of instances predicted as negative).
</summary>
</member>
<member name="P:Microsoft.ML.Data.BinaryClassificationMetrics.NegativeRecall">
<summary>
Gets the negative recall of a classifier which is the proportion of correctly predicted
negative instances among all the negative instances (i.e., the number of negative instances
predicted as negative, divided by the total number of negative instances).
</summary>
</member>
<member name="P:Microsoft.ML.Data.BinaryClassificationMetrics.F1Score">
<summary>
Gets the F1 score of the classifier.
</summary>
<remarks>
F1 score is the harmonic mean of precision and recall: 2 * precision * recall / (precision + recall).
</remarks>
</member>
<member name="P:Microsoft.ML.Data.BinaryClassificationMetrics.Auprc">
<summary>
Gets the area under the precision/recall curve of the classifier.
</summary>
<remarks>
The area under the precision/recall curve is a single number summary of the information in the
precision/recall curve. It is increasingly used in the machine learning community, particularly
for imbalanced datasets where one class is observed more frequently than the other. On these
datasets, AUPRC can highlight performance differences that are lost with AUC.
</remarks>
</member>
<member name="T:Microsoft.ML.Data.CalibratedBinaryClassificationMetrics">
<summary>
Evaluation results for binary classifiers, including probabilistic metrics.
</summary>
</member>
<member name="P:Microsoft.ML.Data.CalibratedBinaryClassificationMetrics.LogLoss">
<summary>
Gets the log-loss of the classifier.
</summary>
<remarks>
The log-loss metric, is computed as follows:
LL = - (1/m) * sum( log(p[i]))
where m is the number of instances in the test set.
p[i] is the probability returned by the classifier if the instance belongs to class 1,
and 1 minus the probability returned by the classifier if the instance belongs to class 0.
</remarks>
</member>
<member name="P:Microsoft.ML.Data.CalibratedBinaryClassificationMetrics.LogLossReduction">
<summary>
Gets the log-loss reduction (also known as relative log-loss, or reduction in information gain - RIG)
of the classifier.
</summary>
<remarks>
The log-loss reduction is scaled relative to a classifier that predicts the prior for every example:
(LL(prior) - LL(classifier)) / LL(prior)
This metric can be interpreted as the advantage of the classifier over a random prediction.
For example, if the RIG equals 20, it can be interpreted as "the probability of a correct prediction is
20% better than random guessing."
</remarks>
</member>
<member name="P:Microsoft.ML.Data.CalibratedBinaryClassificationMetrics.Entropy">
<summary>
Gets the test-set entropy (prior Log-Loss/instance) of the classifier.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ClusteringMetrics">
<summary>
The metrics generated after evaluating the clustering predictions.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ClusteringMetrics.Nmi">
<summary>
Normalized Mutual Information
NMI is a measure of the mutual dependence of the variables.
<a href="http://en.wikipedia.org/wiki/Mutual_information#Normalized_variants">Normalized variants</a> work on data that already has cluster labels.
Its value ranged from 0 to 1, where higher numbers are better.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ClusteringMetrics.AvgMinScore">
<summary>
Average Score. For the K-Means algorithm, the 'score' is the distance from the centroid to the example.
The average score is, therefore, a measure of proximity of the examples to cluster centroids.
In other words, it's the 'cluster tightness' measure.
Note however, that this metric will only decrease if the number of clusters is increased,
and in the extreme case (where each distinct example is its own cluster) it will be equal to zero.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ClusteringMetrics.Dbi">
<summary>
<a href="https://en.wikipedia.org/wiki/Davies%E2%80%93Bouldin_index">Davies-Bouldin Index</a>
DBI is a measure of the how much scatter is in the cluster and the cluster separation.
</summary>
</member>
<member name="P:Microsoft.ML.Data.MultiClassClassifierMetrics.AccuracyMicro">
<summary>
Gets the micro-average accuracy of the model.
</summary>
<remarks>
The micro-average is the fraction of instances predicted correctly.
The micro-average metric weighs each class according to the number of instances that belong
to it in the dataset.
</remarks>
</member>
<member name="P:Microsoft.ML.Data.MultiClassClassifierMetrics.AccuracyMacro">
<summary>
Gets the macro-average accuracy of the model.
</summary>
<remarks>
The macro-average is computed by taking the average over all the classes of the fraction
of correct predictions in this class (the number of correctly predicted instances in the class,
divided by the total number of instances in the class).
The macro-average metric gives the same weight to each class, no matter how many instances from
that class the dataset contains.
</remarks>
</member>
<member name="P:Microsoft.ML.Data.MultiClassClassifierMetrics.LogLoss">
<summary>
Gets the average log-loss of the classifier.
</summary>
<remarks>
The log-loss metric, is computed as follows:
LL = - (1/m) * sum( log(p[i]))
where m is the number of instances in the test set.
p[i] is the probability returned by the classifier if the instance belongs to class 1,
and 1 minus the probability returned by the classifier if the instance belongs to class 0.
</remarks>
</member>
<member name="P:Microsoft.ML.Data.MultiClassClassifierMetrics.LogLossReduction">
<summary>
Gets the log-loss reduction (also known as relative log-loss, or reduction in information gain - RIG)
of the classifier.
</summary>
<remarks>
The log-loss reduction is scaled relative to a classifier that predicts the prior for every example:
(LL(prior) - LL(classifier)) / LL(prior)
This metric can be interpreted as the advantage of the classifier over a random prediction.
For example, if the RIG equals 20, it can be interpreted as "the probability of a correct prediction is
20% better than random guessing".
</remarks>
</member>
<member name="P:Microsoft.ML.Data.MultiClassClassifierMetrics.TopK">
<summary>
If positive, this is the top-K for which the <see cref="P:Microsoft.ML.Data.MultiClassClassifierMetrics.TopKAccuracy"/> is calculated.
</summary>
</member>
<member name="P:Microsoft.ML.Data.MultiClassClassifierMetrics.TopKAccuracy">
<summary>
If <see cref="P:Microsoft.ML.Data.MultiClassClassifierMetrics.TopK"/> is positive, this is the relative number of examples where
the true label is one of the top k predicted labels by the predictor.
</summary>
</member>
<member name="P:Microsoft.ML.Data.MultiClassClassifierMetrics.PerClassLogLoss">
<summary>
Gets the log-loss of the classifier for each class.
</summary>
<remarks>
The log-loss metric, is computed as follows:
LL = - (1/m) * sum( log(p[i]))
where m is the number of instances in the test set.
p[i] is the probability returned by the classifier if the instance belongs to the class,
and 1 minus the probability returned by the classifier if the instance does not belong to the class.
</remarks>
</member>
<member name="P:Microsoft.ML.Data.RankingMetrics.Ndcg">
<summary>
Array of normalized discounted cumulative gains where i-th element represent NDCG@i.
<image src="https://github.com/dotnet/machinelearning/tree/master/docs/images/NDCG.png"></image>
</summary>
</member>
<member name="P:Microsoft.ML.Data.RankingMetrics.Dcg">
<summary>
Array of discounted cumulative gains where i-th element represent DCG@i.
<a href="https://en.wikipedia.org/wiki/Discounted_cumulative_gain">Discounted Cumulative gain</a>
is the sum of the gains, for all the instances i, normalized by the natural logarithm of the instance + 1.
Note that unlike the Wikipedia article, ML.NET uses the natural logarithm.
<image src="https://github.com/dotnet/machinelearning/tree/master/docs/images/DCG.png"></image>
</summary>
</member>
<member name="P:Microsoft.ML.Data.RegressionMetrics.L1">
<summary>
Gets the absolute loss of the model.
</summary>
<remarks>
The absolute loss is defined as
L1 = (1/m) * sum( abs( yi - y'i))
where m is the number of instances in the test set.
y'i are the predicted labels for each instance.
yi are the correct labels of each instance.
</remarks>
</member>
<member name="P:Microsoft.ML.Data.RegressionMetrics.L2">
<summary>
Gets the squared loss of the model.
</summary>
<remarks>
The squared loss is defined as
L2 = (1/m) * sum(( yi - y'i)^2)
where m is the number of instances in the test set.
y'i are the predicted labels for each instance.
yi are the correct labels of each instance.
</remarks>
</member>
<member name="P:Microsoft.ML.Data.RegressionMetrics.Rms">
<summary>
Gets the root mean square loss (or RMS) which is the square root of the L2 loss.
</summary>
</member>
<member name="P:Microsoft.ML.Data.RegressionMetrics.LossFn">
<summary>
Gets the result of user defined loss function.
</summary>
<remarks>
This is the average of a loss function defined by the user,
computed over all the instances in the test set.
</remarks>
</member>
<member name="P:Microsoft.ML.Data.RegressionMetrics.RSquared">
<summary>
Gets the R squared value of the model, which is also known as
the coefficient of determination.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MultiClassClassifierEvaluator.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Evaluates scored multiclass classification data.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="predictedLabel">The name of the predicted label column in <paramref name="data"/>.</param>
<returns>The evaluation results for these outputs.</returns>
</member>
<member name="F:Microsoft.ML.Data.RankingEvaluator.GroupSummary">
<value>
The ranking evaluator outputs a data view by this name, which contains metrics aggregated per group.
It contains four columns: GroupId, NDCG, DCG and MaxDCG. Each row in the data view corresponds to one
group in the scored data.
</value>
</member>
<member name="M:Microsoft.ML.Data.RankingEvaluator.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Evaluates scored regression data.
</summary>
<param name="data">The data to evaluate.</param>
<param name="label">The name of the label column.</param>
<param name="groupId">The name of the groupId column.</param>
<param name="score">The name of the predicted score column.</param>
<returns>The evaluation metrics for these outputs.</returns>
</member>
<member name="P:Microsoft.ML.Data.RankingPerInstanceTransform.Microsoft#Data#DataView#IDataView#Schema">
<summary>
Explicit implementation prevents Schema from being accessed from derived classes.
It's our first step to separate data produced by transform from transform.
</summary>
</member>
<member name="P:Microsoft.ML.Data.RankingPerInstanceTransform.OutputSchema">
<summary>
Shape information of the produced output. Note that the input and the output of this transform (and their types) are identical.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RankingUtils.QueryMaxDcg(System.Double[],System.Int32,System.Collections.Generic.List{System.Int16},System.Collections.Generic.List{System.Single},System.Double[])">
<summary>te
Calculates natural-based max DCG at all truncations from 1 to trunc
</summary>
</member>
<member name="M:Microsoft.ML.Data.RegressionEvaluator.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String)">
<summary>
Evaluates scored regression data.
</summary>
<param name="data">The data to evaluate.</param>
<param name="label">The name of the label column.</param>
<param name="score">The name of the predicted score column.</param>
<returns>The evaluation metrics for these outputs.</returns>
</member>
<member name="T:Microsoft.ML.Data.IModelCombiner">
<summary>
An interface that combines multiple predictors into a single predictor.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BinaryClassifierScorer.WrapIfNeeded(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
This function performs a number of checks on the inputs and, if appropriate and possible, will produce
a mapper with slots names on the output score column properly mapped. If this is not possible for any
reason, it will just return the input bound mapper.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BinaryClassifierScorer.CanWrap(Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.Data.DataView.DataViewType)">
<summary>
This is a utility method used to determine whether <see cref="T:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper"/>
can or should be used to wrap <paramref name="mapper"/>. This will not throw, since the
desired behavior in the event that it cannot be wrapped, is to just back off to the original
"unwrapped" bound mapper.
</summary>
<param name="mapper">The mapper we are seeing if we can wrap</param>
<param name="labelNameType">The type of the label names from the metadata (either
originating from the key value metadata of the training label column, or deserialized
from the model of a bindable mapper)</param>
<returns>Whether we can call <see cref="M:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper.CreateBound``1(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ISchemaBoundRowMapper,Microsoft.ML.Data.VectorType,System.Delegate,System.String,System.Func{Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.Data.DataView.DataViewType,System.Boolean})"/> with
this mapper and expect it to succeed</returns>
</member>
<member name="T:Microsoft.ML.Data.FeatureContributionScorer">
<summary>
Used only by the command line API for scoring and calculation of feature contribution.
</summary>
</member>
<member name="T:Microsoft.ML.Data.FeatureContributionScorer.BindableMapper">
<summary>
Holds the definition of the getters for the FeatureContribution column. It also contains the generic mapper that is used to score the Predictor.
This is only used by the command line API.
</summary>
</member>
<member name="T:Microsoft.ML.Data.FeatureContributionScorer.RowMapper">
<summary>
Maps a schema from input columns to output columns. Keeps track of the input columns that are needed for the mapping.
</summary>
</member>
<member name="M:Microsoft.ML.Data.FeatureContributionScorer.RowMapper.Microsoft#ML#Data#ISchemaBoundRowMapper#GetDependenciesForNewColumns(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Returns the input columns needed for the requested output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.GenericScorer">
<summary>
This class is a scorer that passes through all the ISchemaBound columns without adding any "derived columns".
It also passes through all metadata (except for possibly changing the score column kind), and adds the
score set id metadata.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.Bindings.#ctor(Microsoft.Data.DataView.DataViewSchema,Microsoft.ML.Data.ISchemaBoundRowMapper,System.String,System.Boolean)">
<summary>
The one and only constructor for Bindings.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.Bindings.Create(Microsoft.Data.DataView.DataViewSchema,Microsoft.ML.Data.ISchemaBoundRowMapper,System.String,System.Boolean)">
<summary>
Create the bindings given the input schema, bound mapper, and column name suffix.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.Bindings.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ISchemaBindableMapper,Microsoft.Data.DataView.DataViewSchema,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{Microsoft.ML.Data.RoleMappedSchema.ColumnRole,System.String}},System.String,System.Boolean)">
<summary>
Create the bindings given the env, bindable, input schema, column roles, and column name suffix.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.Bindings.ApplyToSchema(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.DataViewSchema)">
<summary>
Create a new Bindings from this one, but based on a potentially different schema.
Used by the ITransformTemplate.ApplyToData implementation.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.Bindings.Create(Microsoft.ML.ModelLoadContext,Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ISchemaBindableMapper,Microsoft.Data.DataView.DataViewSchema)">
<summary>
Deserialize the bindings, given the env, bindable and input schema.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ScorerArgumentsBase,Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
The <see cref="T:Microsoft.ML.Data.SignatureDataScorer"/> entry point for creating a <see cref="T:Microsoft.ML.Data.GenericScorer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.GenericScorer,Microsoft.Data.DataView.IDataView)">
<summary>
Constructor for <see cref="M:Microsoft.ML.Data.GenericScorer.ApplyToDataCore(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView)"/> method.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.#ctor(Microsoft.ML.IHost,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView)">
<summary>
Constructor for deserialization.
</summary>
</member>
<member name="M:Microsoft.ML.Data.GenericScorer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView)">
<summary>
<see cref="T:Microsoft.ML.Data.SignatureLoadDataTransform"/> entry point - for deserialization.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper">
<summary>
This bindable mapper facilitates the serialization and rebinding of the special bound
mapper that attaches the label metadata to the slot names of the output score column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext)">
<summary>
Method corresponding to <see cref="T:Microsoft.ML.SignatureLoadModel"/>.
</summary>
</member>
<member name="F:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper.Bound`1._mapper">
<summary>The mapper we are wrapping.</summary>
</member>
<member name="M:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper.Bound`1.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ISchemaBoundRowMapper,Microsoft.ML.Data.VectorType,Microsoft.Data.DataView.ValueGetter{Microsoft.ML.Data.VBuffer{`0}},System.String,System.Func{Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.Data.DataView.DataViewType,System.Boolean})">
<summary>
This is the constructor called for the initial wrapping.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper.Bound`1.DecorateOutputSchema(Microsoft.Data.DataView.DataViewSchema,System.Int32,Microsoft.ML.Data.VectorType,Microsoft.Data.DataView.ValueGetter{Microsoft.ML.Data.VBuffer{`0}},System.String)">
<summary>
Append label names to score column as its metadata.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper.Bound`1.Microsoft#ML#Data#ISchemaBoundRowMapper#GetDependenciesForNewColumns(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MultiClassClassifierScorer.WrapIfNeeded(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
This function performs a number of checks on the inputs and, if appropriate and possible, will produce
a mapper with slots names on the output score column properly mapped. If this is not possible for any
reason, it will just return the input bound mapper.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MultiClassClassifierScorer.CanWrap(Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.Data.DataView.DataViewType)">
<summary>
This is a utility method used to determine whether <see cref="T:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper"/>
can or should be used to wrap <paramref name="mapper"/>. This will not throw, since the
desired behavior in the event that it cannot be wrapped, is to just back off to the original
"unwrapped" bound mapper.
</summary>
<param name="mapper">The mapper we are seeing if we can wrap</param>
<param name="labelNameType">The type of the label names from the metadata (either
originating from the key value metadata of the training label column, or deserialized
from the model of a bindable mapper)</param>
<returns>Whether we can call <see cref="M:Microsoft.ML.Data.MultiClassClassifierScorer.LabelNameBindableMapper.CreateBound``1(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ISchemaBoundRowMapper,Microsoft.ML.Data.VectorType,System.Delegate,System.String,System.Func{Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.Data.DataView.DataViewType,System.Boolean})"/> with
this mapper and expect it to succeed</returns>
</member>
<member name="M:Microsoft.ML.Data.MultiClassClassifierScorer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView)">
<summary>
Corresponds to <see cref="T:Microsoft.ML.Data.SignatureLoadDataTransform"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.PredictedLabelScorerBase">
<summary>
Class for scorers that compute on additional "PredictedLabel" column from the score column.
Currently, this scorer is used for binary classification, multi-class classification, and clustering.
</summary>
</member>
<member name="T:Microsoft.ML.Data.PredictionTransformerBase`1">
<summary>
Base class for transformers with no feature column, or more than one feature columns.
</summary>
<typeparam name="TModel">The type of the model parameters used by this prediction transformer.</typeparam>
</member>
<member name="P:Microsoft.ML.Data.PredictionTransformerBase`1.Model">
<summary>
The model.
</summary>
</member>
<member name="P:Microsoft.ML.Data.PredictionTransformerBase`1.Microsoft#ML#ITransformer#IsRowToRowMapper">
<summary>
Whether a call to <see cref="M:Microsoft.ML.ITransformer.GetRowToRowMapper(Microsoft.Data.DataView.DataViewSchema)"/> should succeed, on an
appropriate schema.
</summary>
</member>
<member name="P:Microsoft.ML.Data.PredictionTransformerBase`1.Scorer">
<summary>
This class is more or less a thin wrapper over the <see cref="T:Microsoft.ML.Data.IDataScorerTransform"/> implementing
<see cref="T:Microsoft.ML.Data.RowToRowScorerBase"/>, which publicly is a deprecated concept as far as the public API is
concerned. Nonetheless, until we move all internal infrastructure to be truely transform based, we
retain this as a wrapper. Even though it is mutable, subclasses of this should set this only in
their constructor.
</summary>
</member>
<member name="M:Microsoft.ML.Data.PredictionTransformerBase`1.GetOutputSchema(Microsoft.Data.DataView.DataViewSchema)">
<summary>
Gets the output schema resulting from the <see cref="M:Microsoft.ML.Data.PredictionTransformerBase`1.Transform(Microsoft.Data.DataView.IDataView)"/>
</summary>
<param name="inputSchema">The <see cref="T:Microsoft.Data.DataView.DataViewSchema"/> of the input data.</param>
<returns>The resulting <see cref="T:Microsoft.Data.DataView.DataViewSchema"/>.</returns>
</member>
<member name="M:Microsoft.ML.Data.PredictionTransformerBase`1.Transform(Microsoft.Data.DataView.IDataView)">
<summary>
Transforms the input data.
</summary>
<param name="input">The input data.</param>
<returns>The transformed <see cref="T:Microsoft.Data.DataView.IDataView"/></returns>
</member>
<member name="M:Microsoft.ML.Data.PredictionTransformerBase`1.Microsoft#ML#ITransformer#GetRowToRowMapper(Microsoft.Data.DataView.DataViewSchema)">
<summary>
Gets a IRowToRowMapper instance.
</summary>
<param name="inputSchema"></param>
<returns></returns>
</member>
<member name="T:Microsoft.ML.Data.SingleFeaturePredictionTransformerBase`1">
<summary>
The base class for all the transformers implementing the <see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/>.
Those are all the transformers that work with one feature column.
</summary>
<typeparam name="TModel">The model used to transform the data.</typeparam>
</member>
<member name="P:Microsoft.ML.Data.SingleFeaturePredictionTransformerBase`1.FeatureColumn">
<summary>
The name of the feature column used by the prediction transformer.
</summary>
</member>
<member name="P:Microsoft.ML.Data.SingleFeaturePredictionTransformerBase`1.FeatureColumnType">
<summary>
The type of the prediction transformer
</summary>
</member>
<member name="M:Microsoft.ML.Data.SingleFeaturePredictionTransformerBase`1.#ctor(Microsoft.ML.IHost,`0,Microsoft.Data.DataView.DataViewSchema,System.String)">
<summary>
Initializes a new reference of <see cref="T:Microsoft.ML.Data.SingleFeaturePredictionTransformerBase`1"/>.
</summary>
<param name="host">The local instance of <see cref="T:Microsoft.ML.IHost"/>.</param>
<param name="model">The model used for scoring.</param>
<param name="trainSchema">The schema of the training data.</param>
<param name="featureColumn">The feature column name.</param>
</member>
<member name="M:Microsoft.ML.Data.SingleFeaturePredictionTransformerBase`1.GetOutputSchema(Microsoft.Data.DataView.DataViewSchema)">
<summary>
Schema propagation for this prediction transformer.
</summary>
<param name="inputSchema">The input schema to attempt to map.</param>
<returns>The output schema of the data, given an input schema like <paramref name="inputSchema"/>.</returns>
</member>
<member name="T:Microsoft.ML.Data.AnomalyPredictionTransformer`1">
<summary>
Base class for the <see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/> working on anomaly detection tasks.
</summary>
<typeparam name="TModel">An implementation of the <see cref="T:Microsoft.ML.IPredictorProducing`1"/></typeparam>
</member>
<member name="T:Microsoft.ML.Data.BinaryPredictionTransformer`1">
<summary>
Base class for the <see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/> working on binary classification tasks.
</summary>
<typeparam name="TModel">An implementation of the <see cref="T:Microsoft.ML.IPredictorProducing`1"/></typeparam>
</member>
<member name="T:Microsoft.ML.Data.MulticlassPredictionTransformer`1">
<summary>
Base class for the <see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/> working on multi-class classification tasks.
</summary>
<typeparam name="TModel">An implementation of the <see cref="T:Microsoft.ML.IPredictorProducing`1"/></typeparam>
</member>
<member name="T:Microsoft.ML.Data.RegressionPredictionTransformer`1">
<summary>
Base class for the <see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/> working on regression tasks.
</summary>
<typeparam name="TModel">An implementation of the <see cref="T:Microsoft.ML.IPredictorProducing`1"/></typeparam>
</member>
<member name="T:Microsoft.ML.Data.RankingPredictionTransformer`1">
<summary>
Base class for the <see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/> working on ranking tasks.
</summary>
<typeparam name="TModel">An implementation of the <see cref="T:Microsoft.ML.IPredictorProducing`1"/></typeparam>
</member>
<member name="T:Microsoft.ML.Data.ClusteringPredictionTransformer`1">
<summary>
Base class for the <see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/> working on clustering tasks.
</summary>
<typeparam name="TModel">An implementation of the <see cref="T:Microsoft.ML.IPredictorProducing`1"/></typeparam>
</member>
<member name="M:Microsoft.ML.Data.QuantileRegressionScorerTransform.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.QuantileRegressionScorerTransform.Arguments,Microsoft.Data.DataView.IDataView,Microsoft.ML.Data.ISchemaBoundMapper,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Constructor corresponding to <see cref="T:Microsoft.ML.Data.SignatureDataScorer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.QuantileRegressionScorerTransform.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.QuantileRegressionScorerTransform.Arguments,Microsoft.ML.IPredictor)">
<summary>
Constructor corresponding to <see cref="T:Microsoft.ML.Data.SignatureBindableMapper"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.RowToRowScorerBase">
<summary>
Base class for scoring rows independently. This assumes that all columns produced by the
underlying <see cref="T:Microsoft.ML.Data.ISchemaBoundRowMapper"/> should be exposed, as well as zero or more
"derived" columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowScorerBase.SaveCore(Microsoft.ML.ModelSaveContext)">
<summary>
The main save method handles saving the _bindable. This should do everything else.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowScorerBase.GetBindings">
<summary>
Derived classes provide the specific bindings object.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowScorerBase.GetActive(Microsoft.ML.Data.RowToRowScorerBase.BindingsBase,System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column},System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column}@,System.Func{System.Int32,System.Boolean}@)">
<summary>
Produces the set of active columns for the scorer (as a bool[] of length bindings.ColumnCount),
the set of needed active input columns, and a predicate for the needed active
mapper columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowScorerBase.ShouldUseParallelCursors(System.Func{System.Int32,System.Boolean})">
<summary>
This produces either "true" or "null" according to whether <see cref="M:Microsoft.ML.Data.RowToRowScorerBase.WantParallelCursors(System.Func{System.Int32,System.Boolean})"/>
returns true or false. Note that this will never return false. Any derived class
must support (but not necessarily prefer) parallel cursors.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowScorerBase.WantParallelCursors(System.Func{System.Int32,System.Boolean})">
<summary>
This should return true iff parallel cursors are advantageous. Typically, this
will return true iff some columns added by this scorer are active.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowScorerBase.GetGetters(Microsoft.Data.DataView.DataViewRow,System.Func{System.Int32,System.Boolean})">
<summary>
Create and fill an array of getters of size InfoCount. The indices of the non-null entries in the
result should be exactly those for which predicate(iinfo) is true.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ScorerBindingsBase">
<summary>
Base bindings for a scorer based on an <see cref="T:Microsoft.ML.Data.ISchemaBoundMapper"/>. This assumes that input schema columns
are echoed, followed by zero or more derived columns, followed by the mapper generated columns.
The names of the derived columns and mapper generated columns have an optional suffix appended.
</summary>
</member>
<member name="F:Microsoft.ML.Data.ScorerBindingsBase.Mapper">
<summary>
The schema bound mapper.
</summary>
</member>
<member name="F:Microsoft.ML.Data.ScorerBindingsBase.Suffix">
<summary>
The column name suffix. Non-null, but may be empty.
</summary>
</member>
<member name="F:Microsoft.ML.Data.ScorerBindingsBase.DerivedColumnCount">
<summary>
The number of derived columns. InfoCount == DerivedColumnCount + Mapper.OutputSchema.ColumnCount.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ScorerBindingsBase.GetActiveMapperColumns(System.Boolean[])">
<summary>
Returns a predicate indicating which Mapper columns are active based on the active scorer columns.
This is virtual so scorers with computed columns can do the right thing.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SchemaBindablePredictorWrapperBase">
<summary>
This is a base class for wrapping <see cref="T:Microsoft.ML.IPredictor"/>s in an <see cref="T:Microsoft.ML.Data.ISchemaBindableMapper"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SchemaBindablePredictorWrapperBase.SingleValueRowMapper">
<summary>
The <see cref="T:Microsoft.ML.Data.ISchemaBoundRowMapper"/> implementation for predictor wrappers that produce a
single output column. Note that the Bindable wrapper should do any input schema validation.
This class doesn't care. It DOES care that the role mapped schema specifies a unique Feature column.
It also requires that the output schema has ColumnCount == 1.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SchemaBindablePredictorWrapperBase.SingleValueRowMapper.Microsoft#ML#Data#ISchemaBoundRowMapper#GetDependenciesForNewColumns(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SchemaBindablePredictorWrapper">
<summary>
This class is a wrapper for all <see cref="T:Microsoft.ML.IPredictor"/>s except for quantile regression predictors,
and calibrated binary classification predictors.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SchemaBindableBinaryPredictorWrapper">
<summary>
This is an <see cref="T:Microsoft.ML.Data.ISchemaBindableMapper"/> wrapper for calibrated binary classification predictors.
They need a separate wrapper because they return two values instead of one: the raw score and the probability.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SchemaBindableBinaryPredictorWrapper.CalibratedRowMapper">
<summary>
The <see cref="T:Microsoft.ML.Data.ISchemaBoundRowMapper"/> implementation for distribution predictor wrappers that produce
two Float-valued output columns. Note that the Bindable wrapper does input schema validation.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SchemaBindableBinaryPredictorWrapper.CalibratedRowMapper.Microsoft#ML#Data#ISchemaBoundRowMapper#GetDependenciesForNewColumns(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SchemaBindableQuantileRegressionPredictor">
<summary>
This is an <see cref="T:Microsoft.ML.Data.ISchemaBindableMapper"/> wrapper for quantile regression predictors. They need a separate
wrapper because they need the quantiles to create the <see cref="T:Microsoft.ML.Data.ISchemaBoundMapper"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ScoreSchemaFactory">
<summary>
This class contains method for creating commonly used <see cref="T:Microsoft.Data.DataView.DataViewSchema"/>s.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ScoreSchemaFactory.Create(Microsoft.Data.DataView.DataViewType,System.String,System.String)">
<summary>
Return a <see cref="T:Microsoft.Data.DataView.DataViewSchema"/> which contains a single score column.
</summary>
<param name="scoreType">The type of the score column.</param>
<param name="scoreColumnKindValue">The kind of the score column. It's the value of <see cref="F:Microsoft.ML.Data.AnnotationUtils.Kinds.ScoreColumnKind"/> in the score column's metadata.</param>
<param name="scoreColumnName">The score column's name in the generated <see cref="T:Microsoft.Data.DataView.DataViewSchema"/>.</param>
<returns><see cref="T:Microsoft.Data.DataView.DataViewSchema"/> which contains only one column.</returns>
</member>
<member name="M:Microsoft.ML.Data.ScoreSchemaFactory.CreateBinaryClassificationSchema(System.String,System.String)">
<summary>
Create a <see cref="T:Microsoft.Data.DataView.DataViewSchema"/> with two columns for binary classifier. The first column, indexed by 0, is the score column.
The second column is the probability column. For example, for linear support vector machine, score column stands for the inner product
of linear coefficients and the input feature vector and we convert score column to probability column using a calibrator.
</summary>
<param name="scoreColumnName">Column name of score column</param>
<param name="probabilityColumnName">Column name of probability column</param>
<returns><see cref="T:Microsoft.Data.DataView.DataViewSchema"/> of binary classifier's output.</returns>
</member>
<member name="M:Microsoft.ML.Data.ScoreSchemaFactory.CreateQuantileRegressionSchema(Microsoft.Data.DataView.DataViewType,System.Double[])">
<summary>
This is very similar to <see cref="M:Microsoft.ML.Data.ScoreSchemaFactory.Create(Microsoft.Data.DataView.DataViewType,System.String,System.String)"/> but adds one extra metadata field to the only score column.
</summary>
<param name="scoreType">Output element's type of quantile regressor. Note that a quantile regressor can produce an array of <see cref="T:Microsoft.Data.DataView.PrimitiveDataViewType"/>.</param>
<param name="quantiles">Quantiles used in quantile regressor.</param>
<returns><see cref="T:Microsoft.Data.DataView.DataViewSchema"/> of quantile regressor's output.</returns>
</member>
<member name="M:Microsoft.ML.Data.ScoreSchemaFactory.CreateSequencePredictionSchema(Microsoft.Data.DataView.DataViewType,System.String,Microsoft.ML.Data.VBuffer{System.ReadOnlyMemory{System.Char}})">
<summary>
This function returns a schema for sequence predictor's output. Its output column is always called <see cref="F:Microsoft.ML.Data.AnnotationUtils.Const.ScoreValueKind.PredictedLabel"/>.
</summary>
<param name="scoreType">Score column's type produced by sequence predictor.</param>
<param name="scoreColumnKindValue">A metadata value of score column. It's the value associated with key
<see cref="F:Microsoft.ML.Data.AnnotationUtils.Kinds.ScoreColumnKind"/>.</param>
<param name="keyNames">Sequence predictor usually generates integer outputs. This field tells the tags of all possible output values.
For example, output integer 0 cound be mapped to "Sell" and 0 to "Buy" when predicting stock trend.</param>
<returns><see cref="T:Microsoft.Data.DataView.DataViewSchema"/> of sequence predictor's output.</returns>
</member>
<member name="T:Microsoft.ML.Data.BindingsWrappedRowCursor">
<summary>
A class for mapping an input to an output cursor assuming no output columns
are requested, given a bindings object. This can be useful for transforms
utilizing the <see cref="T:Microsoft.ML.Data.ColumnBindingsBase"/>, but for which it is
inconvenient or inefficient to handle the "no output selected" case in their
own implementation.
</summary>
</member>
<member name="M:Microsoft.ML.Data.BindingsWrappedRowCursor.#ctor(Microsoft.ML.IChannelProvider,Microsoft.Data.DataView.DataViewRowCursor,Microsoft.ML.Data.ColumnBindingsBase)">
<summary>
Creates a wrapped version of the cursor
</summary>
<param name="provider">Channel provider</param>
<param name="input">The input cursor</param>
<param name="bindings">The bindings object, </param>
</member>
<member name="T:Microsoft.ML.Data.CatalogUtils">
<summary>
Set of extension methods to extract <see cref="T:Microsoft.ML.IHostEnvironment"/> from various catalog classes.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SourceNameColumnBase.TryParse(System.String)">
<summary>
For parsing from a string. This supports "name" and "name:source".
Derived classes that want to provide parsing functionality to the CmdParser need to implement
a static Parse method. That method can call this (directly or indirectly) to handle the supported
syntax.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SourceNameColumnBase.TryParse(System.String,System.String@)">
<summary>
For parsing from a string. This supports "name" and "name:source" and "name:extra:source". For the last
form, the out extra parameter is sort accordingly. For the other forms, extra is set to null.
Derived classes that want to provide parsing functionality to the CmdParser need to implement
a static Parse method. That method can call this (directly or indirectly) to handle the supported
syntax.
</summary>
</member>
<member name="M:Microsoft.ML.Data.SourceNameColumnBase.TryUnparseCore(System.Text.StringBuilder)">
<summary>
The core unparsing functionality, for generating succinct command line forms "name" and "name:source".
</summary>
</member>
<member name="M:Microsoft.ML.Data.SourceNameColumnBase.TryUnparseCore(System.Text.StringBuilder,System.String)">
<summary>
The core unparsing functionality, for generating the succinct command line form "name:extra:source".
</summary>
</member>
<member name="M:Microsoft.ML.Data.SourceNameColumnBase.TrySanitize">
<summary>
If both of name and source are null or white-space, return false.
Otherwise, if one is null or white-space, assign that one the other's value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ManyToOneColumn.TryParse(System.String)">
<summary>
The parsing functionality for custom parsing from a string. This supports "name" and "name:sources",
where sources is a comma separated list of source column names.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ManyToOneColumn.TryParse(System.String,System.String@)">
<summary>
Parsing functionality for custom parsing from a string with an "extra" value between name and sources.
This supports "name", "name:sources" and "name:extra:sources".
</summary>
</member>
<member name="T:Microsoft.ML.Data.ColumnBindingsBase">
<summary>
Base class that abstracts passing input columns through (with possibly different indices) and adding
InfoCount additional columns. If an added column has the same name as a non-hidden input column, it hides
the input column, and is placed immediately after the input column. Otherwise, the added column is placed
at the end. By default, newly added columns have no annotations (but this can be overriden).
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindingsBase.#ctor(Microsoft.Data.DataView.DataViewSchema,System.Boolean,System.String[])">
<summary>
Constructor taking the input schema and new column names. Names must be non-empty and
each name must be non-white-space. The names must be unique but can match existing names
in schemaInput. For error reporting, this assumes that the names come from a user-supplied
parameter named "column". This takes ownership of the params array of names.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ColumnBindingsBase.InfoCount">
<summary>
The number of added columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindingsBase.MapColumnIndex(System.Boolean@,System.Int32)">
<summary>
This maps a column index for this schema to either a source column index (when
<paramref name="isSrcColumn"/> is true), or to an "iinfo" index of an added column
(when <paramref name="isSrcColumn"/> is false).
</summary>
<param name="isSrcColumn">Whether the return index is for a source column</param>
<param name="col">The column index for this schema</param>
<returns>The index (either source index or iinfo index)</returns>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindingsBase.MapIinfoToCol(System.Int32)">
<summary>
This maps from an index to an added column "info" to a column index.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindingsBase.GetActive(System.Func{System.Int32,System.Boolean})">
<summary>
The given predicate maps from output column index to whether the column is active.
This builds an array of bools of length ColumnCount containing the results of calling
predicate on each column index.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindingsBase.GetActive(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
This builds an array of bools of length ColumnCount indicating the index of the active column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindingsBase.GetActiveInput(System.Func{System.Int32,System.Boolean})">
<summary>
The given predicate maps from output column index to whether the column is active.
This builds an array of bools of length Input.ColumnCount containing the results of calling
predicate on the output column index corresponding to each input column index.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindingsBase.GetActiveInput(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
This builds an array of bools of length Input.ColumnCount containing indicating the index of the
active input columns, given the actual columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindingsBase.AnyNewColumnsActive(System.Func{System.Int32,System.Boolean})">
<summary>
Determine whether any columns generated by this transform are active.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ColumnBindings">
<summary>
Class that encapsulates passing input columns through (with possibly different indices) and adding
additional columns. If an added column has the same name as a non-hidden input column, it hides
the input column, and is placed immediately after the input column. Otherwise, the added column is placed
at the end.
This class is intended to simplify predicate propagation for this case.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ColumnBindings.AddedColumnIndices">
<summary>
The indices of added columns in the <see cref="P:Microsoft.ML.Data.ColumnBindings.Schema"/>.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ColumnBindings.InputSchema">
<summary>
The input schema.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ColumnBindings.Schema">
<summary>
The merged schema.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindings.#ctor(Microsoft.Data.DataView.DataViewSchema,Microsoft.Data.DataView.DataViewSchema.DetachedColumn[])">
<summary>
Create a new instance of <see cref="T:Microsoft.ML.Data.ColumnBindings"/>.
</summary>
<param name="input">The input schema that we're adding columns to.</param>
<param name="addedColumns">The columns being added.</param>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindings.MapColumnIndex(System.Boolean@,System.Int32)">
<summary>
This maps a column index for this schema to either a source column index (when
<paramref name="isSrcColumn"/> is true), or to an "iinfo" index of an added column
(when <paramref name="isSrcColumn"/> is false).
</summary>
<param name="isSrcColumn">Whether the return index is for a source column</param>
<param name="col">The column index for this schema</param>
<returns>The index (either source index or iinfo index)</returns>
</member>
<member name="M:Microsoft.ML.Data.ColumnBindings.GetActiveInput(System.Func{System.Int32,System.Boolean})">
<summary>
The given predicate maps from output column index to whether the column is active.
This builds an array of bools of length Input.ColumnCount containing the results of calling
predicate on the output column index corresponding to each input column index.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ColumnParsingUtils">
<summary>
Parsing utilities for converting between transform column argument objects and
command line representations.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnParsingUtils.TryParse(System.String,System.String@,System.String@)">
<summary>
For parsing name and source from a string. This supports "name" and "name:source".
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnParsingUtils.TryParse(System.String,System.String@,System.String@,System.String@)">
<summary>
For parsing name and source from a string. This supports "name" and "name:source" and "name:extra:source".
For the last form, the out extra parameter is set accordingly. For the other forms, extra is set to null.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ColumnConcatenatingTransformer">
<summary>
Concatenates columns in an <see cref="T:Microsoft.Data.DataView.IDataView"/> into one single column. Please see <see cref="T:Microsoft.ML.Transforms.ColumnConcatenatingEstimator"/> for
constructing <see cref="T:Microsoft.ML.Data.ColumnConcatenatingTransformer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.ColumnOptions.#ctor(System.String,System.String[])">
<summary>
This denotes a concatenation of all <paramref name="inputColumnNames"/> into column called <paramref name="name"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.ColumnOptions.#ctor(System.String,System.Collections.Generic.IEnumerable{System.ValueTuple{System.String,System.String}})">
<summary>
This denotes a concatenation of input columns into one column called <paramref name="name"/>.
For each input column, an 'alias' can be specified, to be used in constructing the resulting slot names.
If the alias is not specified, it defaults to be column name.
</summary>
</member>
<member name="P:Microsoft.ML.Data.ColumnConcatenatingTransformer.Columns">
<summary>
The names of the output and input column pairs for the transformation.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String[])">
<summary>
Concatename columns in <paramref name="inputColumnNames"/> into one column <paramref name="outputColumnName"/>.
Original columns are also preserved.
The column types must match, and the output column type is always a vector.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ColumnConcatenatingTransformer.ColumnOptions[])">
<summary>
Concatenates multiple groups of columns, each group is denoted by one of <paramref name="columns"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext)">
<summary>
Factory method for SignatureLoadModel.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ColumnConcatenatingTransformer.Options,Microsoft.Data.DataView.IDataView)">
<summary>
Factory method for SignatureDataTransform.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.ColumnConcatenatingTransformer.TaggedOptions,Microsoft.Data.DataView.IDataView)">
<summary>
Factory method corresponding to SignatureDataTransform.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView)">
<summary>
Factory method for SignatureLoadDataTransform.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnConcatenatingTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.DataViewSchema)">
<summary>
Factory method for SignatureLoadRowMapper.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ColumnConcatenatingTransformer.Mapper.BoundColumn">
<summary>
This represents the column information bound to the schema.
</summary>
</member>
<member name="M:Microsoft.ML.Data.InvertHashUtils.ClearDst(System.Text.StringBuilder@)">
<summary>
Clears a destination StringBuilder. If it is currently null, allocates it.
</summary>
</member>
<member name="M:Microsoft.ML.Data.InvertHashUtils.GetSimpleMapper``1(Microsoft.Data.DataView.DataViewSchema,System.Int32)">
<summary>
Gets the mapping from T into a StringBuilder representation, using various heuristics.
This StringBuilder representation will be a component of the composed KeyValues for the
hash outputs.
</summary>
</member>
<member name="T:Microsoft.ML.Data.InvertHashCollector`1.Pair">
<summary>
This is a small struct that is meant to compare akin to the value,
but also maintain the order in which it was inserted, assuming that
we're using something like a hashset where order is not preserved.
</summary>
</member>
<member name="M:Microsoft.ML.Data.InvertHashCollector`1.#ctor(System.Int32,System.Int32,Microsoft.ML.Data.ValueMapper{`0,System.Text.StringBuilder},System.Collections.Generic.IEqualityComparer{`0},Microsoft.ML.Data.ValueMapper{`0,`0})">
<summary>
Constructs an invert hash collector that collects unique keys per slot, then is able
to build a textual description out of that.
</summary>
<param name="slots">The maximum number of slots</param>
<param name="maxCount">The number of distinct keys we can accumulate per slot</param>
<param name="mapper">Utilized in composing the final description, once we have done
collecting the distinct keys.</param>
<param name="comparer">For detecting uniqueness of the keys we're collecting per slot.</param>
<param name="copier">For copying input values into a value to actually store. Useful for
types of objects where it is possible to do a comparison relatively quickly on some sort
of "unsafe" object, but for which when we decide to actually store it we need to provide
a "safe" version of the object. Utilized in the ngram hash transform, for example.</param>
</member>
<member name="T:Microsoft.ML.Data.TextModelHelper">
<summary>
Simple utility class for saving a <see cref="T:Microsoft.ML.Data.VBuffer`1"/> of ReadOnlyMemory
as a model, both in a binary and more easily human readable form.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetadataDispatcherBase">
<summary>
Base class for handling the schema metadata API.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetadataDispatcherBase.ColInfo">
<summary>
Information for a column.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetadataDispatcherBase.GetterInfo">
<summary>
Base class for metadata getters.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetadataDispatcherBase.GetterInfo`1">
<summary>
Strongly typed base class for metadata getters. Introduces the abstract Get method.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetadataDispatcherBase.GetterInfoDelegate`1">
<summary>
A delegate based metadata getter.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetadataDispatcherBase.GetterInfoPrimitive`1">
<summary>
A primitive value based metadata getter.
</summary>
</member>
<member name="P:Microsoft.ML.Data.MetadataDispatcherBase.ColCount">
<summary>
The number of columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcherBase.CreateInfo(Microsoft.Data.DataView.DataViewSchema,System.Int32,System.Func{System.String,System.Int32,System.Boolean})">
<summary>
Create a ColInfo with the indicated information and no GetterInfos. This doesn't
register a column, only creates a ColInfo. Note that multiple columns can share
the same ColInfo, if desired. Simply call RegisterColumn multiple times, passing
the same ColInfo but different index values. This can only be called before Seal is called.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcherBase.RegisterColumn(System.Int32,Microsoft.ML.Data.MetadataDispatcherBase.ColInfo)">
<summary>
Register the given ColInfo as the metadata handling information for the given
column index. Throws if the given column index already has a ColInfo registered for it.
This can only be called before Seal is called.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcherBase.Seal">
<summary>
Seals this dispatcher from further column registrations. This must be called before any
metadata methods are called, otherwise an exception is thrown.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcherBase.GetColInfoOrNull(System.Int32)">
<summary>
Returns the ColInfo registered for the given column index, if there is one. This may be called
before or after Seal is called.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcherBase.GetMetadataTypes(System.Int32)">
<summary>
Gets the metadata kinds and types for the given column index.
This can only be called after Seal is called.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcherBase.GetMetadataTypeOrNull(System.String,System.Int32)">
<summary>
Gets the metadata type for the given metadata kind and column index, if there is one.
This can only be called after Seal is called.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcherBase.GetMetadata``1(Microsoft.ML.IExceptionContext,System.String,System.Int32,``0@)">
<summary>
Gets the metadata for the given metadata kind and column index. Throws if there isn't any.
This can only be called after Seal is called.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetadataDispatcher">
<summary>
For handling the schema metadata API. Call one of the BuildMetadata methods to get
a builder for a particular column. Wrap the return in a using statement. Disposing the builder
records the metadata for the column. Call Seal() once all metadata is constructed.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.BuildMetadata(System.Int32)">
<summary>
Start building metadata for a column that doesn't pass through any metadata from
a source column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.BuildMetadata(System.Int32,Microsoft.Data.DataView.DataViewSchema,System.Int32)">
<summary>
Start building metadata for a column that passes through all metadata from
a source column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.BuildMetadata(System.Int32,Microsoft.Data.DataView.DataViewSchema,System.Int32,System.Func{System.String,System.Int32,System.Boolean})">
<summary>
Start building metadata for a column that passes through metadata of certain kinds from
a source column. The kinds that are passed through are those for which
<paramref name="filterSrc"/> returns true.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.BuildMetadata(System.Int32,Microsoft.Data.DataView.DataViewSchema,System.Int32,System.String)">
<summary>
Start building metadata for a column that passes through metadata of the given kind from
a source column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.BuildMetadata(System.Int32,Microsoft.Data.DataView.DataViewSchema,System.Int32,System.String[])">
<summary>
Start building metadata for a column that passes through metadata of the given kinds from
a source column.
</summary>
</member>
<member name="T:Microsoft.ML.Data.MetadataDispatcher.Builder">
<summary>
The builder for metadata for a particular column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.Builder.#ctor(Microsoft.ML.Data.MetadataDispatcher,System.Int32,Microsoft.Data.DataView.DataViewSchema,System.Int32,System.Func{System.String,System.Int32,System.Boolean})">
<summary>
This should really be private to MetadataDispatcher, but C#'s accessibility model doesn't
allow restricting to an outer class.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.Builder.AddGetter``1(System.String,Microsoft.Data.DataView.DataViewType,Microsoft.ML.Data.AnnotationUtils.AnnotationGetter{``0})">
<summary>
Add metadata of the given kind. When requested, the metadata is fetched by calling the given delegate.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.Builder.AddPrimitive``1(System.String,Microsoft.Data.DataView.DataViewType,``0)">
<summary>
Add metadata of the given kind, with the given value.
</summary>
</member>
<member name="M:Microsoft.ML.Data.MetadataDispatcher.Builder.Dispose">
<summary>
Close out the builder. This registers the metadata with the dispatcher.
</summary>
</member>
<member name="T:Microsoft.ML.Data.NopTransform">
<summary>
A transform that does nothing.
</summary>
</member>
<member name="M:Microsoft.ML.Data.NopTransform.CreateIfNeeded(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView)">
<summary>
Creates a NopTransform if the input is not an IDataTransform.
Otherwise it returns the input.
</summary>
</member>
<member name="P:Microsoft.ML.Data.NopTransform.Microsoft#Data#DataView#IDataView#Schema">
<summary>
Explicit implementation prevents Schema from being accessed from derived classes.
It's our first step to separate data produced by transform from transform.
</summary>
</member>
<member name="P:Microsoft.ML.Data.NopTransform.OutputSchema">
<summary>
Shape information of the produced output. Note that the input and the output of this transform (and their types) are identical.
</summary>
</member>
<member name="M:Microsoft.ML.Data.NopTransform.Microsoft#ML#Data#IRowToRowMapper#GetDependencies(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.SignatureLoadColumnFunction">
<summary>
Signature for a repository based loader of an <see cref="T:Microsoft.ML.Data.IColumnFunction"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.IColumnFunctionBuilder.ProcessValue">
<summary>
Trains on the current value.
</summary>
<returns>True if it can use more values for training.</returns>
</member>
<member name="M:Microsoft.ML.Data.IColumnFunctionBuilder.CreateColumnFunction">
<summary>
Finishes training and returns a column function.
</summary>
</member>
<member name="T:Microsoft.ML.Data.IColumnAggregator`1">
<summary>
Interface to define an aggregate function over values
</summary>
</member>
<member name="M:Microsoft.ML.Data.IColumnAggregator`1.ProcessValue(`0@)">
<summary>
Updates the aggregate function with a value
</summary>
</member>
<member name="M:Microsoft.ML.Data.IColumnAggregator`1.Finish">
<summary>
Finishes the aggregation
</summary>
</member>
<member name="T:Microsoft.ML.Data.Normalize">
<summary>
This contains entry-point definitions related to <see cref="T:Microsoft.ML.Transforms.NormalizeTransform"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Data.OneToOneTransformerBase">
<summary>
Base class for transformer which operates on pairs input and output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.PerGroupTransformBase`3">
<summary>
This is a base implementation for a transform that in order to compute its output columns, needs to look
at an entire group of consecutive input examples. For each example in the group, it looks at the value of
two input columns and after seeing the entire group it computes the output column values. The output values
are the same for every example in the same group.
</summary>
<typeparam name="TLabel">The type of the values in the first input column</typeparam>
<typeparam name="TScore">The type of the values in the second input column</typeparam>
<typeparam name="TState">Each class deriving from this transform should implement a state class that knows
how to return the current group's output column values.</typeparam>
</member>
<member name="T:Microsoft.ML.Data.PerGroupTransformBase`3.BindingsBase">
<summary>
Deriving classes only need to implement <see cref="M:Microsoft.ML.Data.ColumnBindingsBase.GetColumnTypeCore(System.Int32)"/>.
If any of the output columns have metadata, then the metadata methods should be overridden.
</summary>
</member>
<member name="M:Microsoft.ML.Data.PerGroupTransformBase`3.CreateGetters(`2,System.Func{System.Int32,System.Boolean})">
<summary>
Creates the getters for the transform's output columns. It can be assumed that when the getters are called, the state
object contains the current values of the output columns.
</summary>
<param name="state">The state object, containing the current group's output values.</param>
<param name="predicate">Which output columns are active.</param>
</member>
<member name="M:Microsoft.ML.Data.PerGroupTransformBase`3.GetLabelGetter(Microsoft.Data.DataView.DataViewRow)">
<summary>
Get the getter for the first input column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.PerGroupTransformBase`3.GetScoreGetter(Microsoft.Data.DataView.DataViewRow)">
<summary>
Get the getter for the second input column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.PerGroupTransformBase`3.InitializeState(Microsoft.Data.DataView.DataViewRow)">
<summary>
Return a new state object.
</summary>
</member>
<member name="M:Microsoft.ML.Data.PerGroupTransformBase`3.ProcessExample(`2,`0,`1)">
<summary>
Update the state object with one example.
</summary>
</member>
<member name="M:Microsoft.ML.Data.PerGroupTransformBase`3.UpdateState(`2)">
<summary>
This method is called after processing a whole group of examples. In this method the
state object should compute the output values for the group just seen.
</summary>
</member>
<member name="T:Microsoft.ML.Data.RowToRowTransformerBase">
<summary>
Base class for transformer which produce new columns, but doesn't affect existing ones.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TransformBase">
<summary>
Base class for transforms.
</summary>
</member>
<member name="P:Microsoft.ML.Data.TransformBase.Microsoft#Data#DataView#IDataView#Schema">
<summary>
The field is the type information of the produced IDataView of this transformer.
Explicit interface implementation hides <see cref="P:Microsoft.Data.DataView.IDataView.Schema"/> in all derived classes. The reason
is that a transformer should know the type it will produce but shouldn't contain the type of the data it produces.
Thus, this field will be eventually removed while legacy code can still access <see cref="P:Microsoft.Data.DataView.IDataView.Schema"/> for now.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TransformBase.ShouldUseParallelCursors(System.Func{System.Int32,System.Boolean})">
<summary>
This returns false when this transform cannot support parallel cursors, null when it
doesn't care, and true when it benefits from parallel cursors. For example, a transform
that simply affects metadata, but not column values should return null, while a transform
that does a bunch of computation should return true (if legal).
</summary>
</member>
<member name="M:Microsoft.ML.Data.TransformBase.GetRowCursorCore(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column},System.Random)">
<summary>
Create a single (non-parallel) row cursor.
</summary>
</member>
<member name="T:Microsoft.ML.Data.RowToRowTransformBase">
<summary>
Base class for transforms that map single input row to single output row.
</summary>
</member>
<member name="T:Microsoft.ML.Data.FilterBase">
<summary>
Base class for transforms that filter out rows without changing the schema.
</summary>
</member>
<member name="M:Microsoft.ML.Data.RowToRowMapperTransformBase.Microsoft#ML#Data#IRowToRowMapper#GetDependencies(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Data.OneToOneTransformBase">
<summary>
Base class for transforms that operate row by row with each destination column using one
source column. It provides an extension mechanism to allow a destination column to depend
on multiple input columns.
This class provides the implementation of ISchema and IRowCursor.
</summary>
</member>
<member name="T:Microsoft.ML.Data.OneToOneTransformBase.ColInfo">
<summary>
Information about an added column - the name of the new column, the index of the
source column and the type of the source column.
</summary>
</member>
<member name="F:Microsoft.ML.Data.OneToOneTransformBase.Bindings.Infos">
<summary>
Information about each added column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.Bindings.GetDependencies(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.#ctor(Microsoft.ML.IHostEnvironment,System.String,Microsoft.ML.Data.OneToOneTransformBase,Microsoft.Data.DataView.IDataView,System.Func{Microsoft.Data.DataView.DataViewType,System.String})">
<summary>
Re-applying constructor.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.SaveAsPfaCore(Microsoft.ML.Model.Pfa.BoundPfaContext,System.Int32,Microsoft.ML.Data.OneToOneTransformBase.ColInfo,Newtonsoft.Json.Linq.JToken)">
<summary>
Called by <see cref="M:Microsoft.ML.Model.Pfa.ISaveAsPfa.SaveAsPfa(Microsoft.ML.Model.Pfa.BoundPfaContext)"/>. Should be implemented by subclasses that return
<c>true</c> from <see cref="P:Microsoft.ML.Model.Pfa.ICanSavePfa.CanSavePfa"/>. Will be called
</summary>
<param name="ctx">The context. Can be used to declare cells, access other information,
and whatnot. This method should not actually, however, declare the variable corresponding
to the output column. The calling method will do that.</param>
<param name="iinfo">The index of the output column whose PFA is being composed</param>
<param name="info">The column info</param>
<param name="srcToken">The token in the PFA corresponding to the source col</param>
<returns>Shuold return the declaration corresponding to the value of this column. Will
return <c>null</c> in the event that we do not know how to express this column as PFA</returns>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.ColumnIndex(System.Int32)">
<summary>
Return the (destination) column index for the indicated added column.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.ActivateSourceColumns(System.Int32,System.Boolean[])">
<summary>
Activates the source column.
Override when you don't need the source column to generate the value for this column or when you need
other auxiliary source columns that iinfo destination column depends on.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.GetGetterCore(Microsoft.ML.IChannel,Microsoft.Data.DataView.DataViewRow,System.Int32,System.Action@)">
<summary>
Sub-classes implement this to provide, for a cursor, a getter delegate and optional disposer.
If no action is needed when the cursor is Disposed, the override should set disposer to null,
otherwise it should be set to a delegate to be invoked by the cursor's Dispose method. It's best
for this action to be idempotent - calling it multiple times should be equivalent to calling it once.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.ShouldUseParallelCursors(System.Func{System.Int32,System.Boolean})">
<summary>
This produces either "true" or "null" according to whether <see cref="M:Microsoft.ML.Data.OneToOneTransformBase.WantParallelCursors(System.Func{System.Int32,System.Boolean})"/>
returns true or false. Note that this will never return false. Any derived class
must support (but not necessarily prefer) parallel cursors.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.WantParallelCursors(System.Func{System.Int32,System.Boolean})">
<summary>
This should return true iff parallel cursors are advantageous. The default implementation
returns true iff some columns added by this transform are active.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.ExceptGetSlotCursor(System.Int32)">
<summary>
Returns a standard exception for responding to an invalid call to <see cref="M:Microsoft.ML.Data.ITransposeDataView.GetSlotCursor(System.Int32)"/>
implementation in <see langword="this"/> on a column that is not transposable.
</summary>
</member>
<member name="M:Microsoft.ML.Data.OneToOneTransformBase.GetSlotCursorCore(System.Int32)">
<summary>
Implementors should note this only called if <see cref="M:Microsoft.ML.Data.OneToOneTransformBase.GetSlotTypeCore(System.Int32)"/>
returns a non-null value for this <paramref name="iinfo"/>, so in principle
it should always return a valid value, if called. This implementation throws,
since the default implementation of <see cref="M:Microsoft.ML.Data.OneToOneTransformBase.GetSlotTypeCore(System.Int32)"/> will return
null for all new columns, and so reaching this is only possible if there is a
bug.
</summary>
</member>
<member name="T:Microsoft.ML.Data.ApplyTransformUtils">
<summary>
Utilities to rebind data transforms
</summary>
</member>
<member name="M:Microsoft.ML.Data.ApplyTransformUtils.ApplyTransformToData(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.IDataTransform,Microsoft.Data.DataView.IDataView)">
<summary>
Attempt to apply the data transform to a different data view source.
If the transform in question implements <see cref="T:Microsoft.ML.Data.ITransformTemplate"/>, <see cref="M:Microsoft.ML.Data.ITransformTemplate.ApplyToData(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView)"/>
is called. Otherwise, the transform is serialized into a byte array and then deserialized.
</summary>
<param name="env">The host to use</param>
<param name="transform">The transform to apply.</param>
<param name="newSource">The data view to apply the transform to.</param>
<returns>The resulting data view.</returns>
</member>
<member name="M:Microsoft.ML.Data.ApplyTransformUtils.ApplyAllTransformsToData(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.IDataView)">
<summary>
Walks back the Source chain of the <see cref="T:Microsoft.ML.Data.IDataTransform"/> up to the <paramref name="oldSource"/>
(or <see cref="T:Microsoft.ML.Data.ILegacyDataLoader"/> if <paramref name="oldSource"/> is <c>null</c>),
and reapplies all transforms in the chain, to produce the same chain but bound to the different data.
It is valid to have no transforms: in this case the result will be equal to <paramref name="newSource"/>
If <paramref name="oldSource"/> is specified and not found in the pipe, an exception is thrown.
</summary>
<param name="env">The environment to use.</param>
<param name="chain">The end of the chain.</param>
<param name="newSource">The new data to attach the chain to.</param>
<param name="oldSource">The 'old source' of the pipe, that doesn't need to be reapplied. If null, all transforms are reapplied.</param>
<returns>The resulting data view.</returns>
</member>
<member name="T:Microsoft.ML.Data.ColumnCursorExtensions">
<summary>
Extension methods that allow to extract values of a single column of an <see cref="T:Microsoft.Data.DataView.IDataView"/> as an
<see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ColumnCursorExtensions.GetColumn``1(Microsoft.Data.DataView.IDataView,Microsoft.ML.IHostEnvironment,System.String)">
<summary>
Extract all values of one column of the data view in a form of an <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
<typeparam name="T">The type of the values. This must match the actual column type.</typeparam>
<param name="data">The data view to get the column from.</param>
<param name="env">The current host environment.</param>
<param name="columnName">The name of the column to extract.</param>
</member>
<member name="T:Microsoft.ML.Data.ComponentCreation">
<summary>
This class defines extension methods for an <see cref="T:Microsoft.ML.IHostEnvironment"/> to facilitate creating
components (loaders, transforms, trainers, scorers, evaluators, savers).
</summary>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.Zip(Microsoft.ML.IHostEnvironment,System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.IDataView})">
<summary>
Create a new data view which is obtained by appending all columns of all the source data views.
If the data views are of different length, the resulting data view will have the length equal to the
length of the shortest source.
</summary>
<param name="env">The host environment to use.</param>
<param name="sources">A non-empty collection of data views to zip together.</param>
<returns>The resulting data view.</returns>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateExamples(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{Microsoft.ML.Data.RoleMappedSchema.ColumnRole,System.String}})">
<summary>
Generate training examples for training a predictor or instantiating a scorer.
</summary>
<param name="env">The host environment to use.</param>
<param name="data">The data to use for training or scoring.</param>
<param name="features">The name of the features column. Can be null.</param>
<param name="label">The name of the label column. Can be null.</param>
<param name="group">The name of the group ID column (for ranking). Can be null.</param>
<param name="weight">The name of the weight column. Can be null.</param>
<param name="custom">Additional column mapping to be passed to the trainer or scorer (specific to the prediction type). Can be null or empty.</param>
<returns>The constructed examples.</returns>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreatePredictionEngine``2(Microsoft.ML.IHostEnvironment,Microsoft.ML.ITransformer,System.Boolean,Microsoft.ML.Data.SchemaDefinition,Microsoft.ML.Data.SchemaDefinition)">
<summary>
Create an on-demand prediction engine.
</summary>
<param name="env">The host environment to use.</param>
<param name="transformer">The transformer.</param>
<param name="ignoreMissingColumns">Whether to ignore missing columns in the data view.</param>
<param name="inputSchemaDefinition">The optional input schema. If <c>null</c>, the schema is inferred from the <typeparamref name="TSrc"/> type.</param>
<param name="outputSchemaDefinition">The optional output schema. If <c>null</c>, the schema is inferred from the <typeparamref name="TDst"/> type.</param>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.LoadTransforms(Microsoft.ML.IHostEnvironment,System.IO.Stream,Microsoft.Data.DataView.IDataView)">
<summary>
Load the transforms (but not loader) from the model steram and apply them to the specified data.
It is acceptable to have no transforms in the model stream: in this case the original
<paramref name="data"/> will be returned.
</summary>
<param name="env">The host environment to use.</param>
<param name="modelStream">The model stream to load from.</param>
<param name="data">The data to apply transforms to.</param>
<returns>The transformed data.</returns>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateLoader``1(Microsoft.ML.IHostEnvironment,``0,Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Creates a data loader from the arguments object.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateLoader(Microsoft.ML.IHostEnvironment,System.String,Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Creates a data loader from the 'LoadName{settings}' string.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateSaver``1(Microsoft.ML.IHostEnvironment,``0)">
<summary>
Creates a data saver from the arguments object.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateSaver(Microsoft.ML.IHostEnvironment,System.String)">
<summary>
Creates a data saver from the 'LoadName{settings}' string.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateTransform``1(Microsoft.ML.IHostEnvironment,``0,Microsoft.Data.DataView.IDataView)">
<summary>
Creates a data transform from the arguments object.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateTransform(Microsoft.ML.IHostEnvironment,System.String,Microsoft.Data.DataView.IDataView)">
<summary>
Creates a data transform from the 'LoadName{settings}' string.
</summary>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateScorer(Microsoft.ML.IHostEnvironment,System.String,Microsoft.ML.Data.RoleMappedData,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Creates a data scorer from the 'LoadName{settings}' string.
</summary>
<param name="env">The host environment to use.</param>
<param name="settings">The settings string.</param>
<param name="data">The data to score.</param>
<param name="predictor">The predictor to score.</param>
<param name="trainSchema">The training data schema from which the scorer can optionally extract
additional information, for example, label names. If this is <c>null</c>, no information will be
extracted.</param>
<returns>The scored data.</returns>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.CreateDefaultScorer(Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.RoleMappedData,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Creates a default data scorer appropriate to the predictor's prediction kind.
</summary>
<param name="env">The host environment to use.</param>
<param name="data">The data to score.</param>
<param name="predictor">The predictor to score.</param>
<param name="trainSchema">The training data schema from which the scorer can optionally extract
additional information, for example, label names. If this is <c>null</c>, no information will be
extracted.</param>
<returns>The scored data.</returns>
</member>
<member name="M:Microsoft.ML.Data.ComponentCreation.LoadPredictorOrNull(Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Loads a predictor from the model stream. Returns null iff there's no predictor.
</summary>
<param name="env">The host environment to use.</param>
<param name="modelStream">The model stream.</param>
</member>
<member name="T:Microsoft.ML.Data.LocalEnvironment">
<summary>
An ML.NET environment for local execution.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LocalEnvironment.#ctor(System.Nullable{System.Int32},System.Int32)">
<summary>
Create an ML.NET <see cref="T:Microsoft.ML.IHostEnvironment"/> for local execution.
</summary>
<param name="seed">Random seed. Set to <c>null</c> for a non-deterministic environment.</param>
<param name="conc">Concurrency level. Set to 1 to run single-threaded. Set to 0 to pick automatically.</param>
</member>
<member name="M:Microsoft.ML.Data.LocalEnvironment.AddListener(System.Action{Microsoft.ML.Data.IMessageSource,Microsoft.ML.ChannelMessage})">
<summary>
Add a custom listener to the messages of ML.NET components.
</summary>
</member>
<member name="M:Microsoft.ML.Data.LocalEnvironment.RemoveListener(System.Action{Microsoft.ML.Data.IMessageSource,Microsoft.ML.ChannelMessage})">
<summary>
Remove a previously added a custom listener.
</summary>
</member>
<member name="T:Microsoft.ML.Data.TypeParsingUtils">
<summary>
Utilities to parse command-line representations of <see cref="T:Microsoft.Data.DataView.IDataView"/> types.
</summary>
</member>
<member name="M:Microsoft.ML.Data.TypeParsingUtils.TryParseDataKind(System.String,Microsoft.ML.Data.InternalDataKind@,Microsoft.ML.Data.KeyCount@)">
<summary>
Attempt to parse the string into a data kind and (optionally) a keyCount. This method does not check whether
the returned <see cref="T:Microsoft.ML.Data.InternalDataKind"/> can really be made into a key with the specified <paramref name="keyCount"/>.
</summary>
<param name="str">The string to parse.</param>
<param name="dataKind">The parsed data kind.</param>
<param name="keyCount">The parsed key count, or null if there's no key specification.</param>
<returns>Whether the parsing succeeded or not.</returns>
</member>
<member name="M:Microsoft.ML.Data.TypeParsingUtils.ConstructKeyType(System.Nullable{Microsoft.ML.Data.InternalDataKind},Microsoft.ML.Data.KeyCount)">
<summary>
Construct a <see cref="T:Microsoft.ML.Data.KeyType"/> out of the data kind and the keyCount.
</summary>
</member>
<member name="T:Microsoft.ML.Data.KeyCount">
<summary>
Defines the cardinality, or count, of valid values of a <see cref="T:Microsoft.ML.Data.KeyType"/> column. This needs to be strictly positive.
It is used by <see cref="T:Microsoft.ML.Data.TextLoader"/> and <see cref="T:Microsoft.ML.Transforms.TypeConvertingEstimator"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.KeyCount.#ctor">
<summary>
Initializes the cardinality, or count, of valid values of a <see cref="T:Microsoft.ML.Data.KeyType"/> column to the
largest integer that can be expresed by the underlying datatype of the <see cref="T:Microsoft.ML.Data.KeyType"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Data.KeyCount.#ctor(System.UInt64)">
<summary>
Initializes the cardinality, or count, of valid values of a <see cref="T:Microsoft.ML.Data.KeyType"/> column to <paramref name="count"/>
</summary>
</member>
<member name="M:Microsoft.ML.Data.KeyCount.Parse(System.String)">
<summary>
Parses the string format for a KeyCount, also supports the old KeyRange format for backwards compatibility.
</summary>
</member>
<member name="M:Microsoft.ML.Tools.SavePredictorCommand.CreateFile(System.String)">
<summary>
Create a file handle from path if it was not empty.
</summary>
</member>
<member name="M:Microsoft.ML.Tools.SavePredictorCommand.CreateStrm(Microsoft.ML.IFileHandle)">
<summary>
Create the write stream from the file, if not null.
</summary>
</member>
<member name="M:Microsoft.ML.BinaryLoaderSaverCatalog.LoadFromBinary(Microsoft.ML.DataOperationsCatalog,Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Load a <see cref="T:Microsoft.Data.DataView.IDataView"/> from an <see cref="T:Microsoft.ML.Data.IMultiStreamSource"/> on a binary file.
Note that <see cref="T:Microsoft.Data.DataView.IDataView"/>'s are lazy, so no actual loading happens here, just schema validation.
</summary>
<param name="catalog">The catalog.</param>
<param name="fileSource">The file source to load from. This can be a <see cref="T:Microsoft.ML.Data.MultiFileSource"/>, for example.</param>
</member>
<member name="M:Microsoft.ML.BinaryLoaderSaverCatalog.LoadFromBinary(Microsoft.ML.DataOperationsCatalog,System.String)">
<summary>
Load a <see cref="T:Microsoft.Data.DataView.IDataView"/> from a binary file.
Note that <see cref="T:Microsoft.Data.DataView.IDataView"/>'s are lazy, so no actual loading happens here, just schema validation.
</summary>
<param name="catalog">The catalog.</param>
<param name="path">The path to the file to load from.</param>
</member>
<member name="M:Microsoft.ML.BinaryLoaderSaverCatalog.SaveAsBinary(Microsoft.ML.DataOperationsCatalog,Microsoft.Data.DataView.IDataView,System.IO.Stream,System.Boolean)">
<summary>
Save the <see cref="T:Microsoft.Data.DataView.IDataView"/> into a binary stream.
</summary>
<param name="catalog">The catalog.</param>
<param name="data">The data view to save.</param>
<param name="stream">The stream to write to.</param>
<param name="keepHidden">Whether to keep hidden columns in the dataset.</param>
</member>
<member name="T:Microsoft.ML.Internal.Internallearn.UnsafeTypeOps`1">
<summary>
Represents some common global operations over a type
including many unsafe operations.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.FeatureNameCollection.Sparse.#ctor(System.Int32,System.String[],System.Int32)">
<summary>
This does NOT take ownership of the names array.
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.FeatureNameCollection.Sparse.#ctor(System.Int32,System.Int32,System.Int32[],System.String[])">
<summary>
This takes ownership of the arrays.
</summary>
</member>
<member name="T:Microsoft.ML.Internal.Internallearn.PredictionUtil">
<summary>
Various utilities
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictionUtil.ParseArguments(Microsoft.ML.IHostEnvironment,System.Object,System.String,System.String)">
<summary>
generic method for parsing arguments using CommandLine. If there's a problem, it throws an InvalidOperationException, with a message giving usage.
</summary>
<param name="env">The host environment</param>
<param name="args">The argument object</param>
<param name="settings">The settings string (for example, "threshold-")</param>
<param name="name">The name is used for error reporting only</param>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictionUtil.Array2String(System.Single[],System.String)">
<summary>
Make a string representation of an array
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictionUtil.SeparatorFromString(System.String)">
<summary>
Convert string representation of char separator(s)
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictionUtil.SepCharFromString(System.String)">
<summary>
Convert from a string representation of separator to a char
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictorUtils.SaveSummary(Microsoft.ML.IChannel,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedSchema,System.IO.TextWriter)">
<summary>
Save the model summary.
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictorUtils.SaveText(Microsoft.ML.IChannel,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedSchema,System.IO.TextWriter)">
<summary>
Save the model in text format (if it can save itself)
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictorUtils.SaveBinary(Microsoft.ML.IChannel,Microsoft.ML.IPredictor,System.IO.BinaryWriter)">
<summary>
Save the model in binary format (if it can save itself).
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictorUtils.SaveIni(Microsoft.ML.IChannel,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedSchema,System.IO.TextWriter)">
<summary>
Save the model in text format (if it can save itself)
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.PredictorUtils.SaveCode(Microsoft.ML.IChannel,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedSchema,System.IO.TextWriter)">
<summary>
Save the model in text format (if it can save itself)
</summary>
</member>
<member name="T:Microsoft.ML.Internal.Internallearn.SlotDropper">
<summary>
Drops slots from a fixed or variable sized column based on slot ranges.
</summary>
</member>
<member name="P:Microsoft.ML.Internal.Internallearn.SlotDropper.DstLength">
<summary>
Returns -1 for non vector and unknown length vectors.
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.SlotDropper.#ctor(System.Int32,System.Int32[],System.Int32[])">
<summary>
Constructs slot dropper. It expects the slot ranges to be in sorted order and not overlap.
</summary>
<param name="srcLength">0 indicates variable sized vector.</param>
<param name="slotsMin">Low limit of ranges to be dropped.</param>
<param name="slotsMax">Upper limit of ranges to be dropped. </param>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.SlotDropper.SubsetGetter``1(Microsoft.Data.DataView.ValueGetter{Microsoft.ML.Data.VBuffer{``0}})">
<summary>
Returns a getter that drops slots.
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Internallearn.SlotDropper.DropSlots``1(Microsoft.ML.Data.VBuffer{``0}@,Microsoft.ML.Data.VBuffer{``0}@)">
<summary>
Drops slots from src and populates the dst with the resulting vector. Slots are
dropped based on min and max slots that were passed at the constructor.
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Utilities.StreamUtils.Expand(System.String)">
<summary>
Expand an extended wildcard pattern into a set of file paths.
</summary>
<param name="pattern">the pattern to expand</param>
<returns>the set of file paths matching the pattern</returns>
<remarks>
The wildcard pattern accepts the standard "*" and "?" placeholders.
"..." also refers to a recursive search over subdirectories.
"+" can also be used to make a union of several filenames or patterns.
Names of files that do not exist will be excluded.
</remarks>
</member>
<member name="T:Microsoft.ML.Internal.Utilities.TimerScope">
<summary>
A timer scope class that starts a <see cref="T:System.Diagnostics.Stopwatch"/> when created, calculates and prints elapsed time, physical and virtual memory usages before sending these to the telemetry when disposed.
</summary>
</member>
<member name="T:Microsoft.ML.Internal.Utilities.SequencePool">
<summary>
A dictionary of uint sequences of variable length. Stores the sequences as
byte sequences encoded with LEB128. Empty sequences (or null) are also valid.
</summary>
</member>
<member name="M:Microsoft.ML.Internal.Utilities.SequencePool.TryAdd(System.UInt32[],System.Int32,System.Int32,System.Int32@)">
<summary>
Returns true if the sequence was added, or false if it was already in the pool.
</summary>
<param name="sequence">The array containing the sequence to add to the pool.</param>
<param name="min">The location in the array of the first sequence element.</param>
<param name="lim">The exclusive end of the sequence.</param>
<param name="id">To be populated with the id of the added sequence.</param>
<returns>True if the sequence was added, false if the sequence was already present in the pool.</returns>
</member>
<member name="M:Microsoft.ML.Internal.Utilities.SequencePool.Get(System.UInt32[],System.Int32,System.Int32)">
<summary>
Find the given sequence in the pool. If not found, returns -1.
</summary>
<param name="sequence">An integer sequence</param>
<param name="min">The starting index of the sequence to find in the pool</param>
<param name="lim">The length of the sequence to find in the pool</param>
<returns>The ID of the sequence if it is found, -1 otherwise</returns>
</member>
<member name="M:Microsoft.ML.Internal.Utilities.SequencePool.AddCore(System.UInt32[],System.Int32,System.Int32,System.UInt32)">
<summary>
Adds the item. Does NOT check for whether the item is already present.
</summary>
</member>
<member name="M:Microsoft.ML.DataLoaderExtensions.Load(Microsoft.ML.IDataLoader{Microsoft.ML.Data.IMultiStreamSource},System.String[])">
<summary>
Loads data from one or more file <paramref name="path"/> into an <see cref="T:Microsoft.Data.DataView.IDataView"/>.
Note that <see cref="T:Microsoft.Data.DataView.IDataView"/>'s are lazy, so no actual loading happens here, just schema validation.
</summary>
<param name="loader">The loader to use.</param>
<param name="path">One or more paths from which to load data.</param>
</member>
<member name="T:Microsoft.ML.DataOperationsCatalog">
<summary>
A catalog of operations over data that are not transformers or estimators.
This includes data loaders, saving, caching, filtering etc.
</summary>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.LoadFromEnumerable``1(System.Collections.Generic.IEnumerable{``0},Microsoft.ML.Data.SchemaDefinition)">
<summary>
Create a new <see cref="T:Microsoft.Data.DataView.IDataView"/> over an enumerable of the items of user-defined type.
The user maintains ownership of the <paramref name="data"/> and the resulting data view will
never alter the contents of the <paramref name="data"/>.
Since <see cref="T:Microsoft.Data.DataView.IDataView"/> is assumed to be immutable, the user is expected to support
multiple enumeration of the <paramref name="data"/> that would return the same results, unless
the user knows that the data will only be cursored once.
One typical usage for streaming data view could be: create the data view that lazily loads data
as needed, then apply pre-trained transformations to it and cursor through it for transformation
results.
</summary>
<typeparam name="TRow">The user-defined item type.</typeparam>
<param name="data">The data to wrap around.</param>
<param name="schemaDefinition">The optional schema definition of the data view to create. If <c>null</c>,
the schema definition is inferred from <typeparamref name="TRow"/>.</param>
<returns>The constructed <see cref="T:Microsoft.Data.DataView.IDataView"/>.</returns>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.CreateEnumerable``1(Microsoft.Data.DataView.IDataView,System.Boolean,System.Boolean,Microsoft.ML.Data.SchemaDefinition)">
<summary>
Convert an <see cref="T:Microsoft.Data.DataView.IDataView"/> into a strongly-typed <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
<typeparam name="TRow">The user-defined row type.</typeparam>
<param name="data">The underlying data view.</param>
<param name="reuseRowObject">Whether to return the same object on every row, or allocate a new one per row.</param>
<param name="ignoreMissingColumns">Whether to ignore the case when a requested column is not present in the data view.</param>
<param name="schemaDefinition">Optional user-provided schema definition. If it is not present, the schema is inferred from the definition of T.</param>
<returns>The <see cref="T:System.Collections.Generic.IEnumerable`1"/> that holds the data in <paramref name="data"/>. It can be enumerated multiple times.</returns>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.BootstrapSample(Microsoft.Data.DataView.IDataView,System.Nullable{System.Int32},System.Boolean)">
<summary>
Take an approximate bootstrap sample of <paramref name="input"/>.
</summary>
<remarks>
This sampler is a streaming version of <a href="https://en.wikipedia.org/wiki/Bootstrapping_(statistics)">bootstrap resampling</a>.
Instead of taking the whole dataset into memory and resampling, <see cref="M:Microsoft.ML.DataOperationsCatalog.BootstrapSample(Microsoft.Data.DataView.IDataView,System.Nullable{System.Int32},System.Boolean)"/> streams through the dataset and
uses a <a href="https://en.wikipedia.org/wiki/Poisson_distribution">Poisson</a>(1) distribution to select the number of times a
given row will be added to the sample. The <paramref name="complement"/> parameter allows for the creation of a bootstap sample
and complementary out-of-bag sample by using the same <paramref name="seed"/>.
</remarks>
<param name="input">The input data.</param>
<param name="seed">The random seed. If unspecified, the random state will be instead derived from the <see cref="T:Microsoft.ML.MLContext"/>.</param>
<param name="complement">Whether this is the out-of-bag sample, that is, all those rows that are not selected by the transform.
Can be used to create a complementary pair of samples by using the same seed.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.Cache(Microsoft.Data.DataView.IDataView,System.String[])">
<summary>
Creates a lazy in-memory cache of <paramref name="input"/>.
</summary>
<remarks>
Caching happens per-column. A column is only cached when it is first accessed.
In addition, <paramref name="columnsToPrefetch"/> are considered 'always needed', so these columns
will be cached the first time any data is requested.
</remarks>
<param name="input">The input data.</param>
<param name="columnsToPrefetch">The columns that must be cached whenever anything is cached. An empty array or null
value means that columns are cached upon their first access.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.FilterRowsByColumn(Microsoft.Data.DataView.IDataView,System.String,System.Double,System.Double)">
<summary>
Filter the dataset by the values of a numeric column.
</summary>
<remarks>
Keep only those rows that satisfy the range condition: the value of column <paramref name="columnName"/>
must be between <paramref name="lowerBound"/> (inclusive) and <paramref name="upperBound"/> (exclusive).
</remarks>
<param name="input">The input data.</param>
<param name="columnName">The name of a column to use for filtering.</param>
<param name="lowerBound">The inclusive lower bound.</param>
<param name="upperBound">The exclusive upper bound.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.FilterRowsByKeyColumnFraction(Microsoft.Data.DataView.IDataView,System.String,System.Double,System.Double)">
<summary>
Filter the dataset by the values of a <see cref="T:Microsoft.ML.Data.KeyType"/> column.
</summary>
<remarks>
Keep only those rows that satisfy the range condition: the value of a key column <paramref name="columnName"/>
(treated as a fraction of the entire key range) must be between <paramref name="lowerBound"/> (inclusive) and <paramref name="upperBound"/> (exclusive).
This filtering is useful if the <paramref name="columnName"/> is a key column obtained by some 'stable randomization',
for example, hashing.
</remarks>
<param name="input">The input data.</param>
<param name="columnName">The name of a column to use for filtering.</param>
<param name="lowerBound">The inclusive lower bound.</param>
<param name="upperBound">The exclusive upper bound.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.FilterRowsByMissingValues(Microsoft.Data.DataView.IDataView,System.String[])">
<summary>
Drop rows where any column in <paramref name="columns"/> contains a missing value.
</summary>
<param name="input">The input data.</param>
<param name="columns">Name of the columns to filter on. If a row is has a missing value in any of
these columns, it will be dropped from the dataset.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.ShuffleRows(Microsoft.Data.DataView.IDataView,System.Nullable{System.Int32},System.Int32,System.Boolean)">
<summary>
Shuffle the rows of <paramref name="input"/>.
</summary>
<remarks>
<see cref="M:Microsoft.ML.DataOperationsCatalog.ShuffleRows(Microsoft.Data.DataView.IDataView,System.Nullable{System.Int32},System.Int32,System.Boolean)"/> will shuffle the rows of any input <see cref="T:Microsoft.Data.DataView.IDataView"/> using a streaming approach.
In order to not load the entire dataset in memory, a pool of <paramref name="shufflePoolSize"/> rows will be used
to randomly select rows to output. The pool is constructed from the first <paramref name="shufflePoolSize"/> rows
in <paramref name="input"/>. Rows will then be randomly yielded from the pool and replaced with the next row from <paramref name="input"/>
until all the rows have been yielded, resulting in a new <see cref="T:Microsoft.Data.DataView.IDataView"/> of the same size as <paramref name="input"/>
but with the rows in a randomized order.
If the <see cref="P:Microsoft.Data.DataView.IDataView.CanShuffle"/> property of <paramref name="input"/> is true, then it will also be read into the
pool in a random order, offering two sources of randomness.
</remarks>
<param name="input">The input data.</param>
<param name="seed">The random seed. If unspecified, the random state will be instead derived from the <see cref="T:Microsoft.ML.MLContext"/>.</param>
<param name="shufflePoolSize">The number of rows to hold in the pool. Setting this to 1 will turn off pool shuffling and
<see cref="M:Microsoft.ML.DataOperationsCatalog.ShuffleRows(Microsoft.Data.DataView.IDataView,System.Nullable{System.Int32},System.Int32,System.Boolean)"/> will only perform a shuffle by reading <paramref name="input"/> in a random order.</param>
<param name="shuffleSource">If <see langword="false"/>, the transform will not attempt to read <paramref name="input"/> in a random order and only use
pooling to shuffle. This parameter has no effect if the <see cref="P:Microsoft.Data.DataView.IDataView.CanShuffle"/> property of <paramref name="input"/> is <see langword="false"/>.
</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.SkipRows(Microsoft.Data.DataView.IDataView,System.Int64)">
<summary>
Skip <paramref name="count"/> rows in <paramref name="input"/>.
</summary>
<remarks>
Skips the first <paramref name="count"/> rows from <paramref name="input"/> and returns an <see cref="T:Microsoft.Data.DataView.IDataView"/> with all other rows.
</remarks>
<param name="input">The input data.</param>
<param name="count">Number of rows to skip.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.DataOperationsCatalog.TakeRows(Microsoft.Data.DataView.IDataView,System.Int64)">
<summary>
Take <paramref name="count"/> rows from <paramref name="input"/>.
</summary>
<remarks>
Returns returns an <see cref="T:Microsoft.Data.DataView.IDataView"/> with the first <paramref name="count"/> rows from <paramref name="input"/>.
</remarks>
<param name="input">The input data.</param>
<param name="count">Number of rows to take.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="T:Microsoft.ML.LearningPipelineExtensions">
<summary>
Extension methods that allow chaining estimator and transformer pipes together.
</summary>
</member>
<member name="M:Microsoft.ML.LearningPipelineExtensions.Append``2(Microsoft.ML.IDataLoaderEstimator{``0,Microsoft.ML.IDataLoader{``0}},Microsoft.ML.IEstimator{``1})">
<summary>
Create a new composite loader estimator, by appending another estimator to the end of this data loader estimator.
</summary>
</member>
<member name="M:Microsoft.ML.LearningPipelineExtensions.Append``2(Microsoft.ML.IDataLoader{``0},Microsoft.ML.IEstimator{``1})">
<summary>
Create a new composite loader estimator, by appending an estimator to this data loader.
</summary>
</member>
<member name="M:Microsoft.ML.LearningPipelineExtensions.Append``1(Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},Microsoft.ML.IEstimator{``0},Microsoft.ML.Data.TransformerScope)">
<summary>
Create a new estimator chain, by appending another estimator to the end of this estimator.
</summary>
</member>
<member name="M:Microsoft.ML.LearningPipelineExtensions.AppendCacheCheckpoint``1(Microsoft.ML.IEstimator{``0},Microsoft.ML.IHostEnvironment)">
<summary>
Append a 'caching checkpoint' to the estimator chain. This will ensure that the downstream estimators will be trained against
cached data. It is helpful to have a caching checkpoint before trainers that take multiple data passes.
</summary>
<param name="start">The starting estimator</param>
<param name="env">The host environment to use for caching.</param>
</member>
<member name="M:Microsoft.ML.LearningPipelineExtensions.Append``2(Microsoft.ML.IDataLoader{``0},``1)">
<summary>
Create a new composite loader, by appending a transformer to this data loader.
</summary>
</member>
<member name="M:Microsoft.ML.LearningPipelineExtensions.Append``1(Microsoft.ML.ITransformer,``0)">
<summary>
Create a new transformer chain, by appending another transformer to the end of this transformer chain.
</summary>
</member>
<member name="M:Microsoft.ML.LearningPipelineExtensions.WithOnFitDelegate``1(Microsoft.ML.IEstimator{``0},System.Action{``0})">
<summary>
Given an estimator, return a wrapping object that will call a delegate once <see cref="M:Microsoft.ML.IEstimator`1.Fit(Microsoft.Data.DataView.IDataView)"/>
is called. It is often important for an estimator to return information about what was fit, which is why the
<see cref="M:Microsoft.ML.IEstimator`1.Fit(Microsoft.Data.DataView.IDataView)"/> method returns a specifically typed object, rather than just a general
<see cref="T:Microsoft.ML.ITransformer"/>. However, at the same time, <see cref="T:Microsoft.ML.IEstimator`1"/> are often formed into pipelines
with many objects, so we may need to build a chain of estimators via <see cref="T:Microsoft.ML.Data.EstimatorChain`1"/> where the
estimator for which we want to get the transformer is buried somewhere in this chain. For that scenario, we can through this
method attach a delegate that will be called once fit is called.
</summary>
<typeparam name="TTransformer">The type of <see cref="T:Microsoft.ML.ITransformer"/> returned by <paramref name="estimator"/></typeparam>
<param name="estimator">The estimator to wrap</param>
<param name="onFit">The delegate that is called with the resulting <typeparamref name="TTransformer"/> instances once
<see cref="M:Microsoft.ML.IEstimator`1.Fit(Microsoft.Data.DataView.IDataView)"/> is called. Because <see cref="M:Microsoft.ML.IEstimator`1.Fit(Microsoft.Data.DataView.IDataView)"/>
may be called multiple times, this delegate may also be called multiple times.</param>
<returns>A wrapping estimator that calls the indicated delegate whenever fit is called</returns>
</member>
<member name="M:Microsoft.ML.TextLoaderSaverCatalog.CreateTextLoader(Microsoft.ML.DataOperationsCatalog,Microsoft.ML.Data.TextLoader.Column[],System.Char,System.Boolean,Microsoft.ML.Data.IMultiStreamSource,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Create a text loader <see cref="T:Microsoft.ML.Data.TextLoader"/>.
</summary>
<param name="catalog">The <see cref="T:Microsoft.ML.DataOperationsCatalog"/> catalog.</param>
<param name="columns">Array of columns <see cref="T:Microsoft.ML.Data.TextLoader.Column"/> defining the schema.</param>
<param name="separatorChar">The character used as separator between data points in a row. By default the tab character is used as separator.</param>
<param name="hasHeader">Whether the file has a header.</param>
<param name="dataSample">The optional location of a data sample. The sample can be used to infer column names and number of slots in each column.</param>
<param name="allowQuoting">Whether the file can contain column defined by a quoted string.</param>
<param name="trimWhitespace">Remove trailing whitespace from lines</param>
<param name="allowSparse">Whether the file can contain numerical vectors in sparse format.</param>
</member>
<member name="M:Microsoft.ML.TextLoaderSaverCatalog.CreateTextLoader(Microsoft.ML.DataOperationsCatalog,Microsoft.ML.Data.TextLoader.Options,Microsoft.ML.Data.IMultiStreamSource)">
<summary>
Create a text loader <see cref="T:Microsoft.ML.Data.TextLoader"/>.
</summary>
<param name="catalog">The <see cref="T:Microsoft.ML.DataOperationsCatalog"/> catalog.</param>
<param name="options">Defines the settings of the load operation.</param>
<param name="dataSample">The optional location of a data sample. The sample can be used to infer column names and number of slots in each column.</param>
</member>
<member name="M:Microsoft.ML.TextLoaderSaverCatalog.CreateTextLoader``1(Microsoft.ML.DataOperationsCatalog,System.Char,System.Boolean,Microsoft.ML.Data.IMultiStreamSource,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Create a text loader <see cref="T:Microsoft.ML.Data.TextLoader"/> by inferencing the dataset schema from a data model type.
</summary>
<param name="catalog">The <see cref="T:Microsoft.ML.DataOperationsCatalog"/> catalog.</param>
<param name="separatorChar">Column separator character. Default is '\t'</param>
<param name="hasHeader">Does the file contains header?</param>
<param name="dataSample">The optional location of a data sample. The sample can be used to infer column names and number of slots in each column.</param>
<param name="allowQuoting">Whether the input may include quoted values,
which can contain separator characters, colons,
and distinguish empty values from missing values. When true, consecutive separators
denote a missing value and an empty value is denoted by \"\".
When false, consecutive separators denote an empty value.</param>
<param name="trimWhitespace">Remove trailing whitespace from lines</param>
<param name="allowSparse">Whether the input may include sparse representations for example,
if one of the row contains "5 2:6 4:3" that's mean there are 5 columns all zero
except for 3rd and 5th columns which have values 6 and 3</param>
</member>
<member name="M:Microsoft.ML.TextLoaderSaverCatalog.LoadFromTextFile(Microsoft.ML.DataOperationsCatalog,System.String,Microsoft.ML.Data.TextLoader.Column[],System.Char,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Load a <see cref="T:Microsoft.Data.DataView.IDataView"/> from a text file using <see cref="T:Microsoft.ML.Data.TextLoader"/>.
Note that <see cref="T:Microsoft.Data.DataView.IDataView"/>'s are lazy, so no actual loading happens here, just schema validation.
</summary>
<param name="catalog">The <see cref="T:Microsoft.ML.DataOperationsCatalog"/> catalog.</param>
<param name="path">The path to the file.</param>
<param name="columns">The columns of the schema.</param>
<param name="separatorChar">The character used as separator between data points in a row. By default the tab character is used as separator.</param>
<param name="hasHeader">Whether the file has a header.</param>
<param name="allowQuoting">Whether the file can contain column defined by a quoted string.</param>
<param name="trimWhitespace">Remove trailing whitespace from lines</param>
<param name="allowSparse">Whether the file can contain numerical vectors in sparse format.</param>
<returns>The data view.</returns>
</member>
<member name="M:Microsoft.ML.TextLoaderSaverCatalog.LoadFromTextFile``1(Microsoft.ML.DataOperationsCatalog,System.String,System.Char,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Load a <see cref="T:Microsoft.Data.DataView.IDataView"/> from a text file using <see cref="T:Microsoft.ML.Data.TextLoader"/>.
Note that <see cref="T:Microsoft.Data.DataView.IDataView"/>'s are lazy, so no actual loading happens here, just schema validation.
</summary>
<param name="catalog">The <see cref="T:Microsoft.ML.DataOperationsCatalog"/> catalog.</param>
<param name="path">The path to the file.</param>
<param name="separatorChar">Column separator character. Default is '\t'</param>
<param name="hasHeader">Does the file contains header?</param>
<param name="allowQuoting">Whether the input may include quoted values,
which can contain separator characters, colons,
and distinguish empty values from missing values. When true, consecutive separators
denote a missing value and an empty value is denoted by \"\".
When false, consecutive separators denote an empty value.</param>
<param name="trimWhitespace">Remove trailing whitespace from lines</param>
<param name="allowSparse">Whether the input may include sparse representations for example,
if one of the row contains "5 2:6 4:3" that's mean there are 5 columns all zero
except for 3rd and 5th columns which have values 6 and 3</param>
<returns>The data view.</returns>
</member>
<member name="M:Microsoft.ML.TextLoaderSaverCatalog.LoadFromTextFile(Microsoft.ML.DataOperationsCatalog,System.String,Microsoft.ML.Data.TextLoader.Options)">
<summary>
Load a <see cref="T:Microsoft.Data.DataView.IDataView"/> from a text file using <see cref="T:Microsoft.ML.Data.TextLoader"/>.
Note that <see cref="T:Microsoft.Data.DataView.IDataView"/>'s are lazy, so no actual loading happens here, just schema validation.
</summary>
<param name="catalog">The <see cref="T:Microsoft.ML.DataOperationsCatalog"/> catalog.</param>
<param name="path">Specifies a file from which to load.</param>
<param name="options">Defines the settings of the load operation.</param>
</member>
<member name="M:Microsoft.ML.TextLoaderSaverCatalog.SaveAsText(Microsoft.ML.DataOperationsCatalog,Microsoft.Data.DataView.IDataView,System.IO.Stream,System.Char,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Save the <see cref="T:Microsoft.Data.DataView.IDataView"/> as text.
</summary>
<param name="catalog">The <see cref="T:Microsoft.ML.DataOperationsCatalog"/> catalog.</param>
<param name="data">The data view to save.</param>
<param name="stream">The stream to write to.</param>
<param name="separatorChar">The column separator.</param>
<param name="headerRow">Whether to write the header row.</param>
<param name="schema">Whether to write the header comment with the schema.</param>
<param name="keepHidden">Whether to keep hidden columns in the dataset.</param>
<param name="forceDense">Whether to save columns in dense format even if they are sparse vectors.</param>
</member>
<member name="T:Microsoft.ML.DebuggerExtensions">
<summary>
Static extensions for data preview.
</summary>
</member>
<member name="M:Microsoft.ML.DebuggerExtensions.Preview(Microsoft.Data.DataView.IDataView,System.Int32)">
<summary>
Extract a 'head' of the data view in a view that is convenient to debug.
</summary>
<param name="data">The data view to preview</param>
<param name="maxRows">Maximum number of rows to pull</param>
</member>
<member name="M:Microsoft.ML.DebuggerExtensions.Preview(Microsoft.ML.ITransformer,Microsoft.Data.DataView.IDataView,System.Int32)">
<summary>
Preview an effect of the <paramref name="transformer"/> on a given <paramref name="data"/>.
</summary>
<param name="transformer">The transformer which effect we are previewing</param>
<param name="data">The data view to use for preview</param>
<param name="maxRows">Maximum number of rows to pull</param>
</member>
<member name="M:Microsoft.ML.DebuggerExtensions.Preview(Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},Microsoft.Data.DataView.IDataView,System.Int32,System.Int32)">
<summary>
Preview an effect of the <paramref name="estimator"/> on a given <paramref name="data"/>.
</summary>
<param name="estimator">The estimnator which effect we are previewing</param>
<param name="data">The data view to use for preview</param>
<param name="maxRows">Maximum number of rows to show in preview</param>
<param name="maxTrainingRows">Maximum number of rows to fit the estimator</param>
</member>
<member name="M:Microsoft.ML.DebuggerExtensions.Preview``1(Microsoft.ML.IDataLoader{``0},``0,System.Int32)">
<summary>
Preview an effect of the <paramref name="loader"/> on a given <paramref name="source"/>.
</summary>
<param name="loader">The data loader to preview</param>
<param name="source">The source to pull the data from</param>
<param name="maxRows">Maximum number of rows to pull</param>
</member>
<member name="T:Microsoft.ML.Numeric.VectorUtils">
<summary>
A series of vector utility functions, generally operating over arrays or <see cref="T:Microsoft.ML.Data.VBuffer`1"/>
structures. The convention is that if a array or buffer is not modified, that is, it is treated
as a constant, it might have the name <c>a</c> or <c>b</c> or <c>src</c>, but in a situation
where the vector structure might be changed the parameter might have the name <c>dst</c>.
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.NormSquared(Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Returns the L2 norm squared of the vector (sum of squares of the components).
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.NormSquared(System.ReadOnlySpan{System.Single})">
<summary>
Returns the L2 norm squared of the vector (sum of squares of the components).
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.Norm(Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Returns the L2 norm of the vector.
</summary>
<returns>L2 norm of the vector</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.L1Norm(Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Returns the L1 norm of the vector.
</summary>
<returns>L1 norm of the vector</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.MaxNorm(Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Returns the L-infinity norm of the vector (i.e., the maximum absolute value).
</summary>
<returns>L-infinity norm of the vector</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.Sum(Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Returns the sum of elements in the vector.
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.ScaleBy(Microsoft.ML.Data.VBuffer{System.Single}@,System.Single)">
<summary>
Scales the vector by a real value.
</summary>
<param name="dst">Incoming vector</param>
<param name="c">Value to multiply vector with</param>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.ScaleBy(Microsoft.ML.Data.VBuffer{System.Single}@,Microsoft.ML.Data.VBuffer{System.Single}@,System.Single)">
<summary>
Scales the vector by a real value.
<c><paramref name="dst"/> = <paramref name="c"/> * <paramref name="src"/></c>
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.Add(Microsoft.ML.Data.VBuffer{System.Single}@,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Perform in-place vector addition <c><paramref name="dst"/> += <paramref name="src"/></c>.
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.AddMult(Microsoft.ML.Data.VBuffer{System.Single}@,System.Single,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Perform in-place scaled vector addition
<c><paramref name="dst"/> += <paramref name="c"/> * <paramref name="src"/></c>.
If either vector is dense, <paramref name="dst"/> will be dense, unless
<paramref name="c"/> is 0 in which case this method does nothing.
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.AddMult(Microsoft.ML.Data.VBuffer{System.Single}@,System.Single,Microsoft.ML.Data.VBuffer{System.Single}@,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Perform scalar vector addition
<c><paramref name="res"/> = <paramref name="c"/> * <paramref name="src"/> + <paramref name="dst"/></c>
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.AddMultInto(Microsoft.ML.Data.VBuffer{System.Single}@,System.Single,Microsoft.ML.Data.VBuffer{System.Single}@,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Calculate
<c><paramref name="a"/> + <paramref name="c"/> * <paramref name="b"/></c>
and store the result in <paramref name="dst"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.AddMultWithOffset(Microsoft.ML.Data.VBuffer{System.Single}@,System.Single,Microsoft.ML.Data.VBuffer{System.Single}@,System.Int32)">
<summary>
Perform in-place scaled vector addition
<c><paramref name="dst"/> += <paramref name="c"/> * <paramref name="src"/></c>,
except that this takes place in the section of <paramref name="dst"/> starting
at slot <paramref name="offset"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.ScaleInto(Microsoft.ML.Data.VBuffer{System.Single}@,System.Single,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Perform in-place scaling of a vector into another vector as
<c><paramref name="dst"/> = <paramref name="src"/> * <paramref name="c"/></c>.
This is more or less equivalent to performing the same operation with
<see cref="M:Microsoft.ML.Internal.Utilities.VBufferUtils.ApplyInto``3(Microsoft.ML.Data.VBuffer{``0}@,Microsoft.ML.Data.VBuffer{``1}@,Microsoft.ML.Data.VBuffer{``2}@,System.Func{System.Int32,``0,``1,``2})"/> except perhaps more efficiently,
with one exception: if <paramref name="c"/> is 0 and <paramref name="src"/>
is sparse, <paramref name="dst"/> will have a count of zero, instead of the
same count as <paramref name="src"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.SparsifyNormalize(Microsoft.ML.Data.VBuffer{System.Single}@,System.Int32,System.Int32,System.Boolean)">
<summary>
Sparsify vector A (keep at most <paramref name="top"/>+<paramref name="bottom"/> values)
and optionally rescale values to the [-1, 1] range.
<param name="a">Vector to be sparsified and normalized.</param>
<param name="top">How many top (positive) elements to preserve after sparsification.</param>
<param name="bottom">How many bottom (negative) elements to preserve after sparsification.</param>
<param name="normalize">Whether to normalize results to [-1,1] range.</param>
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.MulElementWise(Microsoft.ML.Data.VBuffer{System.Single}@,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Multiplies arrays Dst *= A element by element and returns the result in <paramref name="dst"/> (Hadamard product).
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.DotProductWithOffset(Microsoft.ML.Data.VBuffer{System.Single}@,System.Int32,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Computes the dot product of two arrays
Where "offset" is considered to be a's zero index
</summary>
<param name="a">one array</param>
<param name="b">the second array (given as a VBuffer)</param>
<param name="offset">offset in 'a'</param>
<returns>the dot product</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.DotProductWithOffset(System.Single[],System.Int32,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Computes the dot product of two arrays
Where "offset" is considered to be a's zero index
</summary>
<param name="a">one array</param>
<param name="b">the second array (given as a VBuffer)</param>
<param name="offset">offset in 'a'</param>
<returns>the dot product</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.L1Distance(Microsoft.ML.Data.VBuffer{System.Single}@,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Computes the L1 distance between two VBuffers
</summary>
<param name="a">one VBuffer</param>
<param name="b">another VBuffer</param>
<returns>L1 Distance from a to b</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.Distance(Microsoft.ML.Data.VBuffer{System.Single}@,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Computes the Euclidean distance between two VBuffers
</summary>
<param name="a">one VBuffer</param>
<param name="b">another VBuffer</param>
<returns>Distance from a to b</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.L2DistSquared(Microsoft.ML.Data.VBuffer{System.Single}@,Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Computes the Euclidean distance squared between two VBuffers
</summary>
<param name="a">one VBuffer</param>
<param name="b">another VBuffer</param>
<returns>Distance from a to b</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.L2DistSquared(System.Single[],Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Given two vectors a and b, calculate their L2 distance squared (|a-b|^2).
</summary>
<param name="a">The first vector, given as an array</param>
<param name="b">The second vector, given as a VBuffer{Float}</param>
<returns>The squared L2 distance between a and b</returns>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.Add(System.Single[],System.Single[])">
<summary>
Perform in-place vector addition <c><paramref name="dst"/> += <paramref name="src"/></c>.
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.AddMult(Microsoft.ML.Data.VBuffer{System.Single}@,System.Span{System.Single},System.Single)">
<summary>
Adds a multiple of a <see cref="T:Microsoft.ML.Data.VBuffer`1"/> to a <see cref="T:System.Single"/> array.
</summary>
<param name="src">Buffer to add</param>
<param name="dst">Span to add to</param>
<param name="c">Coefficient</param>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.AddMultWithOffset(Microsoft.ML.Data.VBuffer{System.Single}@,System.Single[],System.Int32,System.Single)">
<summary>
Adds a multiple of a <see cref="T:Microsoft.ML.Data.VBuffer`1"/> to a <see cref="T:System.Single"/> array, with an offset into the destination.
</summary>
<param name="src">Buffer to add</param>
<param name="dst">Array to add to</param>
<param name="offset">The offset into <paramref name="dst"/> at which to add</param>
<param name="c">Coefficient</param>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.AddMult(System.Single[],System.Single[],System.Single)">
<summary>
Adds a multiple of an array to a second array.
</summary>
<param name="src">Array to add</param>
<param name="dst">Array to add to</param>
<param name="c">Multiple</param>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.Norm(System.Single[])">
<summary>
Returns the L2 norm of the vector (sum of squares of the components).
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.Sum(System.Single[])">
<summary>
Returns sum of elements in array
</summary>
</member>
<member name="M:Microsoft.ML.Numeric.VectorUtils.ScaleBy(System.Single[],System.Single)">
<summary>
Multiples the array by a real value
</summary>
<param name="dst">The array</param>
<param name="c">Value to multiply vector with</param>
</member>
<member name="M:Microsoft.ML.ILossFunction`2.Loss(`0,`1)">
<summary>
Computes the loss given the output and the ground truth.
Note that the return value has type Double because the loss is usually accumulated over many instances.
</summary>
</member>
<member name="M:Microsoft.ML.IScalarOutputLoss.Derivative(System.Single,System.Single)">
<summary>
Derivative of the loss function with respect to output
</summary>
</member>
<member name="T:Microsoft.ML.SignatureClassificationLoss">
<summary>
Delegate signature for standardized classification loss functions.
</summary>
</member>
<member name="T:Microsoft.ML.SignatureRegressionLoss">
<summary>
Delegate signature for standardized regression loss functions.
</summary>
</member>
<member name="T:Microsoft.ML.Model.ModelParametersBase`1">
<summary>
A base class for predictors producing <typeparamref name="TOutput"/>.
Note: This provides essentially no value going forward. New predictors should just
derive from the interfaces they need.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelParametersBase`1.WarnOnOldNormalizer(Microsoft.ML.ModelLoadContext,System.Type,Microsoft.ML.IChannelProvider)">
<summary>
This emits a warning if there is Normalizer sub-model.
</summary>
</member>
<member name="T:Microsoft.ML.Model.IParameterMixer">
<summary>
A generic interface for models that can average parameters from multiple instance of self
</summary>
</member>
<member name="T:Microsoft.ML.Model.IParameterMixer`1">
<summary>
A generic interface for models that can average parameters from multiple instance of self
</summary>
</member>
<member name="T:Microsoft.ML.Model.IQuantileRegressionPredictor">
<summary>
Predictor that can specialize for quantile regression. It will produce a <see cref="T:Microsoft.ML.Data.ISchemaBindableMapper"/>, given
an array of quantiles.
</summary>
</member>
<member name="T:Microsoft.ML.Model.IDistribution`1">
<summary>
A generic interface for probability distributions
</summary>
<typeparam name="TResult">Type of statistics result</typeparam>
</member>
<member name="M:Microsoft.ML.Model.ISampleableDistribution`1.GetSupportSample(`0[]@)">
<summary>
Returns Support sample for the distribution.
</summary>
<param name="weights">Weights for the distribution.It will be null if the distribution is uniform.</param>
<returns>Returns Support sample</returns>
</member>
<member name="T:Microsoft.ML.Model.ICanSaveInTextFormat">
<summary>
Predictors that can output themselves in a human-readable text format
</summary>
</member>
<member name="T:Microsoft.ML.Model.ICanSaveInIniFormat">
<summary>
Predictors that can output themselves in the Bing ini format.
</summary>
</member>
<member name="T:Microsoft.ML.Model.ICanSaveSummary">
<summary>
Predictors that can output Summary.
</summary>
</member>
<member name="T:Microsoft.ML.Model.ICanGetSummaryInKeyValuePairs">
<summary>
Predictors that can output Summary in key value pairs.
The content of value 'object' can be any type such as integer, float, string or an array of them.
It is up the caller to check and decide how to consume the values.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ICanGetSummaryInKeyValuePairs.GetSummaryInKeyValuePairs(Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Gets model summary including model statistics (if exists) in key value pairs.
</summary>
</member>
<member name="T:Microsoft.ML.Model.ICanSaveInSourceCode">
<summary>
Predictors that can output themselves in C#/C++ code.
</summary>
</member>
<member name="T:Microsoft.ML.Model.SignatureFeatureScorerTrainer">
<summary>
Signature for trainers that produce predictors that in turn can be use to score features.
</summary>
</member>
<member name="T:Microsoft.ML.Model.IHaveFeatureWeights">
<summary>
Interface implemented by components that can assign weights to features.
</summary>
</member>
<member name="M:Microsoft.ML.Model.IHaveFeatureWeights.GetFeatureWeights(Microsoft.ML.Data.VBuffer{System.Single}@)">
<summary>
Returns the weights for the features.
There should be at most as many weights as there are features.
If there are less weights, it is implied that the remaining features have a weight of zero.
The larger the absolute value of a weights, the more informative/important the feature.
A weights of zero signifies that the feature is not used by the model.
</summary>
</member>
<member name="T:Microsoft.ML.Model.IPredictorWithFeatureWeights`1">
<summary>
Interface implemented by predictors that can score features.
</summary>
</member>
<member name="T:Microsoft.ML.Model.IFeatureContributionMapper">
<summary>
Interface for mapping input values to corresponding feature contributions.
This interface is commonly implemented by predictors.
</summary>
</member>
<member name="M:Microsoft.ML.Model.IFeatureContributionMapper.GetFeatureContributionMapper``2(System.Int32,System.Int32,System.Boolean)">
<summary>
Get a delegate for mapping Contributions to Features.
Result will contain vector with topN positive contributions(if available) and
bottomN negative contributions (if available).
For example linear predictor will have both negative and positive contributions.
For trees we will not have negative contributions, so bottom param will be ignored.
If normalization is requested that resulting values will be normalized to [-1, 1].
</summary>
</member>
<member name="T:Microsoft.ML.Model.ICalculateFeatureContribution">
<summary>
Allows support for feature contribution calculation by model parameters.
</summary>
</member>
<member name="T:Microsoft.ML.Model.FeatureContributionCalculator">
<summary>
Support for feature contribution calculation.
</summary>
</member>
<member name="T:Microsoft.ML.Model.ICanGetTrainingLabelNames">
<summary>
Interface for predictors that can return a string array containing the label names from the label column they were trained on.
If the training label is a key with text key value metadata, it should return this metadata. The order of the labels should be consistent
with the key values. Otherwise, it returns null.
</summary>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.ICanSaveOnnx.CanSaveOnnx(Microsoft.ML.Model.OnnxConverter.OnnxContext)">
<summary>
Whether this object really is capable of saving itself as part of an ONNX
pipeline. An implementor of this object might implement this interface,
but still return <c>false</c> if there is some characteristic of this object
only detectable during runtime that would prevent its being savable. (For example,
it may wrap some other object that may or may not be savable.)
</summary>
</member>
<member name="T:Microsoft.ML.Model.OnnxConverter.ISaveAsOnnx">
<summary>
This component know how to save himself in ONNX format.
</summary>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.ISaveAsOnnx.SaveAsOnnx(Microsoft.ML.Model.OnnxConverter.OnnxContext)">
<summary>
Save as ONNX.
</summary>
<param name="ctx">The ONNX program being built</param>
</member>
<member name="T:Microsoft.ML.Model.OnnxConverter.ITransformCanSaveOnnx">
<summary>
This data model component is savable as ONNX.
</summary>
</member>
<member name="T:Microsoft.ML.Model.OnnxConverter.IBindableCanSaveOnnx">
<summary>
This <see cref="T:Microsoft.ML.Data.ISchemaBindableMapper"/> is savable in ONNX. Note that this is
typically called within an <see cref="T:Microsoft.ML.Data.IDataScorerTransform"/> that is wrapping
this mapper, and has already been bound to it.
</summary>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.IBindableCanSaveOnnx.SaveAsOnnx(Microsoft.ML.Model.OnnxConverter.OnnxContext,Microsoft.ML.Data.RoleMappedSchema,System.String[])">
<summary>
Save as ONNX. If <see cref="M:Microsoft.ML.Model.OnnxConverter.ICanSaveOnnx.CanSaveOnnx(Microsoft.ML.Model.OnnxConverter.OnnxContext)"/> is
<c>false</c> this should not be called. This method is intended to be called
by the wrapping scorer transform, and is intended to produce enough information
for that purpose.
</summary>
<param name="ctx">The ONNX program being built</param>
<param name="schema">The role mappings that was passed to this bindable
object, when the <see cref="T:Microsoft.ML.Data.ISchemaBoundMapper"/> was created that this transform
is wrapping</param>
<param name="outputNames">Since this method is called from a scorer transform,
it is that transform that controls what the output column names will be, of
the outputs produced by this bindable mapper. This is the array that holds
those names, so that implementors of this method know what to produce in
<paramref name="ctx"/>.</param>
</member>
<member name="T:Microsoft.ML.Model.OnnxConverter.ISingleCanSaveOnnx">
<summary>
For simple mappers. Intended to be used for <see cref="T:Microsoft.ML.Data.IValueMapper"/> and
<see cref="T:Microsoft.ML.Calibrators.ICalibrator"/> instances.
</summary>
</member>
<member name="T:Microsoft.ML.Model.OnnxConverter.IDistCanSaveOnnx">
<summary>
For simple mappers. Intended to be used for <see cref="T:Microsoft.ML.Data.IValueMapperDist"/>
instances.
</summary>
</member>
<member name="T:Microsoft.ML.Model.OnnxConverter.OnnxContext">
<summary>
A context for defining a ONNX output. The context internally contains the model-in-progress being built. This
same context object is iteratively given to exportable components via the <see cref="T:Microsoft.ML.Model.OnnxConverter.ICanSaveOnnx"/> interface
and subinterfaces, that attempt to express their operations as ONNX nodes, if they can. At the point that it is
given to a component, all other components up to that component have already attempted to express themselves in
this context, with their outputs possibly available in the ONNX graph.
</summary>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.GetNodeName(System.String)">
<summary>
Generates a unique name for the node based on a prefix.
</summary>
<param name="prefix">The prefix for the node</param>
<returns>A name that has not yet been returned from this function, starting with <paramref name="prefix"/></returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.IsVariableDefined(System.String)">
<summary>
Determine if a string has been used as ONNX variable name somewhere.
</summary>
<param name="variableName">examined string</param>
<returns>True if the input argument has been used to denote an ONNX variable. Otherwise, False.</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.ContainsColumn(System.String)">
<summary>
Looks up whether a given data view column has a mapping in the ONNX context. Once confirmed, callers can
safely call <see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.GetVariableName(System.String)"/>.
</summary>
<param name="colName">The data view column name</param>
<returns>Whether the column is mapped in this context</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.RemoveColumn(System.String,System.Boolean)">
<summary>
Stops tracking a column.
</summary>
<param name="colName">Column name to stop tracking</param>
<param name="removeVariable">Remove associated ONNX variable. This is useful in the event where an output
variable is created through <see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddIntermediateVariable(Microsoft.Data.DataView.DataViewType,System.String,System.Boolean)"/>before realizing
the transform cannot actually save as ONNX.</param>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.RemoveVariable(System.String,System.Boolean)">
<summary>
Removes an ONNX variable. If removeColumn is true then it also removes the tracking for the <see
cref="T:Microsoft.Data.DataView.IDataView"/> column associated with it.
</summary>
<param name="variableName">ONNX variable to remove. Note that this is an ONNX variable name, not an <see
cref="T:Microsoft.Data.DataView.IDataView"/> column name</param>
<param name="removeColumn">IDataView column to stop tracking</param>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.GetVariableName(System.String)">
<summary>
ONNX variables are referred to by name. At each stage of a ML.NET pipeline, the corresponding
<see cref="T:Microsoft.Data.DataView.IDataView"/>'s column names will map to a variable in the ONNX graph if the intermediate steps
used to calculate that value are things we knew how to save as ONNX. Retrieves the variable name that maps
to the <see cref="T:Microsoft.Data.DataView.IDataView"/> column name at a given point in the pipeline execution. Callers should
probably confirm with <see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.ContainsColumn(System.String)"/> whether a mapping for that data view column
already exists.
</summary>
<param name="colName">The data view column name</param>
<returns>The ONNX variable name corresponding to that data view column</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddIntermediateVariable(Microsoft.Data.DataView.DataViewType,System.String,System.Boolean)">
<summary>
Establishes a new mapping from an data view column in the context, if necessary generates a unique name, and
returns that newly allocated name.
</summary>
<param name="type">The data view type associated with this column name</param>
<param name="colName">The data view column name</param>
<param name="skip">Whether we should skip the process of establishing the mapping from data view column to
ONNX variable name.</param>
<returns>The returned value is the name of the variable corresponding </returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.CreateNode(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.String)">
<summary>
Creates an ONNX node
</summary>
<param name="opType">The name of the ONNX operator to apply</param>
<param name="inputs">The names of the variables as inputs</param>
<param name="outputs">The names of the variables to create as outputs,
which ought to have been something returned from <see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddIntermediateVariable(Microsoft.Data.DataView.DataViewType,System.String,System.Boolean)"/></param>
<param name="name">The name of the operator, which ought to be something returned from <see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.GetNodeName(System.String)"/></param>
<param name="domain">The domain of the ONNX operator, if non-default</param>
<returns>A node added to the in-progress ONNX graph, that attributes can be set on</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.CreateNode(System.String,System.String,System.String,System.String,System.String)">
<summary>
Convenience alternative to <see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.CreateNode(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"/>
for the case where there is exactly one input and output.
</summary>
<param name="opType">The name of the ONNX operator to apply</param>
<param name="input">The name of the variable as input</param>
<param name="output">The name of the variable as output,
which ought to have been something returned from <see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddIntermediateVariable(Microsoft.Data.DataView.DataViewType,System.String,System.Boolean)"/></param>
<param name="name">The name of the operator, which ought to be something returned from <see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.GetNodeName(System.String)"/></param>
<param name="domain">The domain of the ONNX operator, if non-default</param>
<returns>A node added to the in-progress ONNX graph, that attributes can be set on</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.GetOnnxVersion">
<summary>
Get the targeted ONNX version string. Only two values are allowed now: "Stable" and "Experimental".
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.RetrieveShapeOrNull(System.String)">
<summary>
Retrieve the shape of an ONNX variable. Returns null if no shape for the specified variable can be found.
</summary>
<param name="variableName">The ONNX name of the returned shape</param>
<returns>The shape of the retrieved variable</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddInitializer(System.Single,System.String)">
<summary>
Call this function can declare a global float
</summary>
<param name="value">The float number which is going to be added</param>
<param name="name">A string used as a seed to generate this initializer's name in the ONNX graph.</param>
<returns>The initializer's ONNX name</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddInitializer(System.Int64,System.String)">
<summary>
Call this function can declare a global long
</summary>
<param name="value">The long number which is going to be added into the ONNX graph</param>
<param name="name">A string used as a seed to generate this initializer's name in the ONNX graph.</param>
<returns>The initializer's ONNX name</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddInitializer(System.String,System.String)">
<summary>
Call this function can declare a global string
</summary>
<param name="value">The string which is going to be added into the ONNX graph</param>
<param name="name">A string used as a seed to generate this initializer's name in the ONNX graph.</param>
<returns>The initializer's ONNX name</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddInitializer(System.Collections.Generic.IEnumerable{System.Single},System.Collections.Generic.IEnumerable{System.Int64},System.String)">
<summary>
Call this function can declare a global float tensor
</summary>
<param name="values">The floats which are going to be added into the ONNX graph</param>
<param name="dims">The shape that the floats</param>
<param name="name">A string used as a seed to generate this initializer's name in the ONNX graph.</param>
<returns>The initializer's ONNX name</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddInitializer(System.Collections.Generic.IEnumerable{System.Int64},System.Collections.Generic.IEnumerable{System.Int64},System.String)">
<summary>
Call this function can declare a global long tensor
</summary>
<param name="values">The longs which are going to be added into the ONNX graph</param>
<param name="dims">The shape that the floats</param>
<param name="name">A string used as a seed to generate this initializer's name in the ONNX graph.</param>
<returns>The initializer's ONNX name</returns>
</member>
<member name="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.AddInitializer(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.Int64},System.String)">
<summary>
Call this function can declare a global string tensor
</summary>
<param name="values">The strings which are going to be added into the ONNX graph</param>
<param name="dims">The shape that the strings</param>
<param name="name">A string used as a seed to generate this initializer's name in the ONNX graph.</param>
<returns>The initializer's ONNX name</returns>
</member>
<member name="T:Microsoft.ML.Model.OnnxConverter.OnnxNode">
<summary>
An abstraction for an ONNX node as created by
<see cref="M:Microsoft.ML.Model.OnnxConverter.OnnxContext.CreateNode(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"/>.
That method creates a with inputs and outputs, but this object can modify the node further
by adding attributes (in ONNX parlance, attributes are more or less constant parameterizations).
</summary>
</member>
<member name="T:Microsoft.ML.Model.Pfa.BoundPfaContext">
<summary>
This wraps a <see cref="T:Microsoft.ML.Model.Pfa.PfaContext"/>, except with auxiliary information
that enables its inclusion relative to the <see cref="T:Microsoft.Data.DataView.IDataView"/> ecosystem.
The idea is that one starts with a context built from some starting point,
then subsequent transforms via <see cref="T:Microsoft.ML.Model.Pfa.ITransformCanSavePfa"/> augment this context.
Beyond what is offered in <see cref="T:Microsoft.ML.Model.Pfa.PfaContext"/>, <see cref="T:Microsoft.ML.Model.Pfa.BoundPfaContext"/>
has facilities to remember what column name in <see cref="T:Microsoft.Data.DataView.IDataView"/> maps to
what token in the PFA being built up.
</summary>
</member>
<member name="P:Microsoft.ML.Model.Pfa.BoundPfaContext.Pfa">
<summary>
The internal PFA context, for an escape hatch.
</summary>
</member>
<member name="F:Microsoft.ML.Model.Pfa.BoundPfaContext._nameToVarName">
<summary>
This will map from the "current" name of a data view column, to a corresponding
token string.
</summary>
</member>
<member name="F:Microsoft.ML.Model.Pfa.BoundPfaContext._unavailable">
<summary>
This contains a map of those names in
</summary>
</member>
<member name="M:Microsoft.ML.Model.Pfa.BoundPfaContext.Finalize(Microsoft.Data.DataView.DataViewSchema,System.String[])">
<summary>
This call will set <see cref="P:Microsoft.ML.Model.Pfa.PfaContext.OutputType"/> to an appropriate output type based
on the columns requested.
</summary>
<param name="schema">The schema corresponding to what we are outputting</param>
<param name="toOutput">The columns to output</param>
<returns>Returns a complete PFA program, where the output will correspond to the subset
of columns from <paramref name="schema"/>.</returns>
</member>
<member name="M:Microsoft.ML.Model.Pfa.BoundPfaContext.DeclareVar(System.Collections.Generic.KeyValuePair{System.String,Newtonsoft.Json.Linq.JToken}[])">
<summary>
Attempts to declare variables corresponding to a given column name. This
will attempt to produce a PFA <c>let</c>/<c>set</c> declaration, and also
do name mapping. The idea is that any transform implementing <see cref="T:Microsoft.ML.Model.Pfa.ITransformCanSavePfa"/>
will call this method to say, "hey, I produce this column, and this is the equivalent
PFA for it."
</summary>
<param name="vars">The map from requested name, usually a dataview name,
to the declaration</param>
<returns>An array of assigned names in the PFA corresponding to the items in
vars</returns>
</member>
<member name="M:Microsoft.ML.Model.Pfa.BoundPfaContext.Hide(System.String[])">
<summary>
As a complimentary operation to <see cref="M:Microsoft.ML.Model.Pfa.BoundPfaContext.DeclareVar(System.Collections.Generic.KeyValuePair{System.String,Newtonsoft.Json.Linq.JToken}[])"/>,
this provides a mechanism for a transform to say, "hey, I am producing this column, but I
am not writing any PFA for it, so if anyone asks for this column downstream don't say I
have it."
</summary>
<param name="names">The names to hide</param>
</member>
<member name="M:Microsoft.ML.Model.Pfa.BoundPfaContext.TokenOrNullForName(System.String)">
<summary>
Given an <see cref="T:Microsoft.Data.DataView.IDataView"/> column name, return the string for referencing the corresponding
token in the PFA, or <c>null</c> if such a thing does not exist.
</summary>
</member>
<member name="M:Microsoft.ML.Model.Pfa.BoundPfaContext.IsInput(System.String)">
<summary>
Given an <see cref="T:Microsoft.Data.DataView.IDataView"/> column name, return whether in the PFA being built up
whether the corresponding PFA variable is still the input. This will return <c>false</c>
also in the event that the column is hidden, or simply not present.
</summary>
</member>
<member name="P:Microsoft.ML.Model.Pfa.ICanSavePfa.CanSavePfa">
<summary>
Whether this object really is capable of saving itself as part of a PFA
pipeline. An implementor of this object might implement this interface,
but still return <c>false</c> if there is some characteristic of this object
only detectable during runtime that would prevent its being savable. (For example,
it may wrap some other object that may or may not be savable.)
</summary>
</member>
<member name="T:Microsoft.ML.Model.Pfa.ISaveAsPfa">
<summary>
This component know how to save himself in Pfa format.
</summary>
</member>
<member name="M:Microsoft.ML.Model.Pfa.ISaveAsPfa.SaveAsPfa(Microsoft.ML.Model.Pfa.BoundPfaContext)">
<summary>
Save as PFA. For any columns that are output, this interface should use
<see cref="M:Microsoft.ML.Model.Pfa.BoundPfaContext.DeclareVar(System.String,Newtonsoft.Json.Linq.JToken)"/> to declare themselves,
while any unwritable columns should be registered <see cref="M:Microsoft.ML.Model.Pfa.BoundPfaContext.Hide(System.String[])"/>.
If <see cref="P:Microsoft.ML.Model.Pfa.ICanSavePfa.CanSavePfa"/> is <c>false</c> this should not be called.
</summary>
<param name="ctx">The PFA program being built</param>
</member>
<member name="T:Microsoft.ML.Model.Pfa.ITransformCanSavePfa">
<summary>
This data model component is savable as PFA. See https://dmg.org/pfa/ .
</summary>
</member>
<member name="T:Microsoft.ML.Model.Pfa.IBindableCanSavePfa">
<summary>
This <see cref="T:Microsoft.ML.Data.ISchemaBindableMapper"/> is savable as a PFA. Note that this is
typically called within an <see cref="T:Microsoft.ML.Data.IDataScorerTransform"/> that is wrapping
this mapper, and has already been bound to it.
</summary>
</member>
<member name="M:Microsoft.ML.Model.Pfa.IBindableCanSavePfa.SaveAsPfa(Microsoft.ML.Model.Pfa.BoundPfaContext,Microsoft.ML.Data.RoleMappedSchema,System.String[])">
<summary>
Save as PFA. If <see cref="P:Microsoft.ML.Model.Pfa.ICanSavePfa.CanSavePfa"/> is
<c>false</c> this should not be called. This method is intended to be called
by the wrapping scorer transform, and is intended to produce enough information
for that purpose.
</summary>
<param name="ctx">The PFA program being built</param>
<param name="schema">The role mappings that was passed to this bindable
object, when the <see cref="T:Microsoft.ML.Data.ISchemaBoundMapper"/> was created that this transform
is wrapping</param>
<param name="outputNames">Since this method is called from a scorer transform,
it is that transform that controls what the output column names will be, of
the outputs produced by this bindable mapper. This is the array that holds
those names, so that implementors of this method know what to produce in
<paramref name="ctx"/>.</param>
</member>
<member name="T:Microsoft.ML.Model.Pfa.ISingleCanSavePfa">
<summary>
For simple mappers. Intended to be used for <see cref="T:Microsoft.ML.Data.IValueMapper"/> and
<see cref="T:Microsoft.ML.Calibrators.ICalibrator"/> instances.
</summary>
</member>
<member name="M:Microsoft.ML.Model.Pfa.ISingleCanSavePfa.SaveAsPfa(Microsoft.ML.Model.Pfa.BoundPfaContext,Newtonsoft.Json.Linq.JToken)">
<summary>
Implementors of this method are responsible for providing the PFA expression that
computes the output of this object. Note that this method does not control what name
will be given to the output, and is not responsible for declaring the variable into
which the output will be returned. (Though, the method may of course declare other
variables, cells, or such to enable this computation.)
</summary>
<param name="ctx">The PFA context</param>
<param name="input">The PFA token representing the input. In the case of
a predictor, for example, this would be a reference to the variable holding
the features array.</param>
<returns>A PFA expression</returns>
</member>
<member name="T:Microsoft.ML.Model.Pfa.IDistCanSavePfa">
<summary>
For simple mappers. Intended to be used for <see cref="T:Microsoft.ML.Data.IValueMapperDist"/>
instances.
</summary>
</member>
<member name="M:Microsoft.ML.Model.Pfa.IDistCanSavePfa.SaveAsPfa(Microsoft.ML.Model.Pfa.BoundPfaContext,Newtonsoft.Json.Linq.JToken,System.String,Newtonsoft.Json.Linq.JToken@,System.String,Newtonsoft.Json.Linq.JToken@)">
<summary>
The call for distribution predictors. Unlike <see cref="M:Microsoft.ML.Model.Pfa.ISingleCanSavePfa.SaveAsPfa(Microsoft.ML.Model.Pfa.BoundPfaContext,Newtonsoft.Json.Linq.JToken)"/>,
this method requires this method to handle the declaration of the variables for their
outputs, into the names <paramref name="score"/> and <paramref name="prob"/> provided.
</summary>
<param name="ctx">The PFA context</param>
<param name="input">The PFA token representing the input. In nearly all cases this will
be the name of the variable holding the features array.</param>
<param name="score">The name of the column where the implementing method should
save the expression, through <see cref="M:Microsoft.ML.Model.Pfa.BoundPfaContext.DeclareVar(System.String,Newtonsoft.Json.Linq.JToken)"/>,
or if <c>null</c></param>
<param name="scoreToken"></param>
<param name="prob">Similar to <paramref name="score"/>, except the probability expression.</param>
<param name="probToken"></param>
</member>
<member name="T:Microsoft.ML.Model.Pfa.PfaContext">
<summary>
A context for defining a restricted sort of PFA output.
</summary>
</member>
<member name="M:Microsoft.ML.Model.Pfa.PfaContext.CreateFuncBlock(Newtonsoft.Json.Linq.JArray,Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken)">
<summary>
For creating an anonymous function block. This in itself will not modify the context.
</summary>
</member>
<member name="M:Microsoft.ML.Model.Pfa.PfaContext.RegisterType(System.String)">
<summary>
PFA is weird in that you do not declare types separately, you declare them as part of a variable
declaration. So, if you use a record type three times, that means one of the three usages must be
accompanied by a full type declaration, whereas the other two can just then identify it by name.
This is extremely silly, but there you go.
Anyway: this will attempt to add a type to the list of registered types. If it returns <c>true</c>
then the caller is responsible, then, for ensuring that their PFA code they are generating contains
not only a reference of the type, but a declaration of the type. If however this returns <c>false</c>
then it can just refer to the type by name, since it has already been declared.
</summary>
<param name="name">The type to register</param>
<returns>If this name was not already registered</returns>
<seealso cref="M:Microsoft.ML.Model.Pfa.PfaContext.ContainsType(System.String)"/>
</member>
<member name="M:Microsoft.ML.Model.Pfa.PfaUtils.Call(System.String,Newtonsoft.Json.Linq.JToken[])">
<summary>
Generic facilities for calling a function.
</summary>
<param name="func">The function to call</param>
<param name="prms">The parameters for the function</param>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Model.Pfa.PfaUtils.VectorCase(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken,System.String,Newtonsoft.Json.Linq.JToken,System.String,Newtonsoft.Json.Linq.JToken)">
<summary>
Builds a "cast" statement to the two vector types.
</summary>
<param name="itemType">The type of the item in the vector</param>
<param name="src">The token we are casting</param>
<param name="asMapName">The name for the token as it will appear in the <paramref name="mapDo"/></param>
<param name="mapDo">The map case expression</param>
<param name="asArrName">The name for the token as it will appear in the <paramref name="arrDo"/></param>
<param name="arrDo">The array case expression</param>
<returns>The cast/case expression</returns>
</member>
<member name="M:Microsoft.ML.Model.Pfa.PfaUtils.EnsureCount(Microsoft.ML.Model.Pfa.PfaContext,Newtonsoft.Json.Linq.JToken)">
<summary>
This ensures that there is a function formatted as "count_type" (for example, "count_double"),
that takes either a map or array and returns the number of items in that map or array.
</summary>
<param name="ctx">The context to check for the existence of this</param>
<param name="itemType">The item type this will operate on</param>
</member>
<member name="M:Microsoft.ML.Model.Pfa.PfaUtils.EnsureHasChars(Microsoft.ML.Model.Pfa.PfaContext)">
<summary>
A string -> bool function for determining whether a string has content.
</summary>
</member>
<member name="T:Microsoft.ML.Model.ModelFileUtils">
<summary>
This class provides utilities for loading components from the model file generated by MAML commands.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadPipeline(Microsoft.ML.IHostEnvironment,System.IO.Stream,Microsoft.ML.Data.IMultiStreamSource,System.Boolean)">
<summary>
Loads and returns the loader and transforms from the specified model stream.
</summary>
<param name="env">The host environment to use.</param>
<param name="modelStream">The model stream.</param>
<param name="files">The data source to initialize the loader with.</param>
<param name="extractInnerPipe">Whether to extract the transforms and loader from the wrapped CompositeDataLoader.</param>
<returns>The created data view.</returns>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadPipeline(Microsoft.ML.IHostEnvironment,Microsoft.ML.RepositoryReader,Microsoft.ML.Data.IMultiStreamSource,System.Boolean)">
<summary>
Loads and returns the loader and transforms from the specified repository reader.
</summary>
<param name="env">The host environment to use.</param>
<param name="rep">The repository reader.</param>
<param name="files">The data source to initialize the loader with.</param>
<param name="extractInnerPipe">Whether to extract the transforms and loader from the wrapped CompositeDataLoader.</param>
<returns>The created data view.</returns>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadTransforms(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.IO.Stream)">
<summary>
Loads all transforms from the model stream, applies them sequentially to the provided data, and returns
the resulting data. If there are no transforms in the stream, or if there's no DataLoader stream at all
(this can happen if the model is produced by old TL), returns the source data.
If the DataLoader stream is invalid, throws.
</summary>
<param name="env">The host environment to use.</param>
<param name="data">The starting data view.</param>
<param name="modelStream">The model stream.</param>
<returns>The resulting data view.</returns>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadTransforms(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,Microsoft.ML.RepositoryReader)">
<summary>
Loads all transforms from the model stream, applies them sequentially to the provided data, and returns
the resulting data. If there are no transforms in the stream, or if there's no DataLoader stream at all
(this can happen if the model is produced by old TL), returns the source data.
If the DataLoader stream is invalid, throws.
</summary>
<param name="env">The host environment to use.</param>
<param name="data">The starting data view.</param>
<param name="rep">The repository reader.</param>
<returns>The resulting data view.</returns>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadPredictorOrNull(Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Loads a predictor from the model stream. Returns null iff there's no predictor.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadPredictorOrNull(Microsoft.ML.IHostEnvironment,Microsoft.ML.RepositoryReader)">
<summary>
Loads a predictor from the repository. Returns null iff there's no predictor.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.GetDataModelSavingContext(Microsoft.ML.RepositoryWriter)">
<summary>
Given a repository, returns the save context for saving the data loader model.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadLoader(Microsoft.ML.IHostEnvironment,Microsoft.ML.RepositoryReader,Microsoft.ML.Data.IMultiStreamSource,System.Boolean)">
<summary>
Loads data view (loader and transforms) from <paramref name="rep"/> if <paramref name="loadTransforms"/> is set to true,
otherwise loads loader only.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.TryLoadFeatureNames(Microsoft.ML.Internal.Internallearn.FeatureNameCollection@,Microsoft.ML.RepositoryReader)">
<summary>
REVIEW: consider adding an overload that returns <see cref="T:System.ReadOnlyMemory`1"/> of <see cref="T:System.Char"/>
Loads optionally feature names from the repository directory.
Returns false iff no stream was found for feature names, iff result is set to null.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.SaveRoleMappings(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.ML.Data.RoleMappedSchema,Microsoft.ML.RepositoryWriter)">
<summary>
Save schema associations of role/column-name in <paramref name="rep"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadRoleMappingsOrNull(Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Return role/column-name pairs loaded from <paramref name="modelStream"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadRoleMappingsOrNull(Microsoft.ML.IHostEnvironment,Microsoft.ML.RepositoryReader)">
<summary>
Return role/column-name pairs loaded from a repository.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadRoleMappedSchemaOrNull(Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Returns the <see cref="T:Microsoft.ML.Data.RoleMappedSchema"/> from a model stream, or <c>null</c> if there were no
role mappings present.
</summary>
</member>
<member name="M:Microsoft.ML.Model.ModelFileUtils.LoadRoleMappedSchemaOrNull(Microsoft.ML.IHostEnvironment,Microsoft.ML.RepositoryReader)">
<summary>
Returns the <see cref="T:Microsoft.ML.Data.RoleMappedSchema"/> from a repository, or <c>null</c> if there were no
role mappings present.
</summary>
</member>
<member name="T:Microsoft.ML.Model.ModelFileUtils.RepositoryStreamWrapper">
<summary>
The RepositoryStreamWrapper is a IMultiStreamSource wrapper of a Stream object in a repository.
It is used to deserialize RoleMappings.txt from a model zip file.
</summary>
</member>
<member name="T:Microsoft.ML.Model.ModelFileUtils.RepositoryStreamWrapper.EntryStream">
<summary>
A custom entry stream wrapper that includes custom dispose logic for disposing the entry
when the stream is disposed.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs">
<summary>
Common output classes for trainers and transform entry-points.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.TransformOutput">
<summary>
The common output class for all transforms.
The output consists of the transformed dataset and the transformation model.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.ITransformOutput">
<summary>
Interface that all API transform output classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.TrainerOutput">
<summary>
The common output class for all trainers.
The output is a trained predictor model.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.CalibratorOutput">
<summary>
The common output for calibrators.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.ICalibratorOutput">
<summary>
Marker interface for calibrators output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.BinaryClassificationOutput">
<summary>
The common output for binary classification trainers.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IBinaryClassificationOutput">
<summary>
Marker interface for binary classification trainer output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.MulticlassClassificationOutput">
<summary>
The common output for multiclass classification trainers.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IMulticlassClassificationOutput">
<summary>
Marker interface for multiclass classification trainer output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.RegressionOutput">
<summary>
The common output for regression trainers.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IRegressionOutput">
<summary>
Marker interface for regression trainer output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.MultiRegressionOutput">
<summary>
The common output for multi regression trainers.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IMultiRegressionOutput">
<summary>
Marker interface for multi regression trainer output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.ClusteringOutput">
<summary>
The common output for clustering trainers.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IClusteringOutput">
<summary>
Marker interface for clustering trainer output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.AnomalyDetectionOutput">
<summary>
The common output for anomaly detection trainers.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IAnomalyDetectionOutput">
<summary>
Marker interface for anomaly detection trainer output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.RankingOutput">
<summary>
The common output for ranking trainers.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IRankingOutput">
<summary>
Marker interface for ranking trainer output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.SequencePredictionOutput">
<summary>
The common output for sequence prediction trainers.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.ISequencePredictionOutput">
<summary>
Marker interface for sequence prediction trainer output.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.ITrainerOutput">
<summary>
Interface that all API trainer output classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.MacroOutput">
<summary>
Macro output class base.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.MacroOutput`1">
<summary>
The common output class for all macro entry points.
The output class is the type parameter. The expansion must guarantee
that the generated graph will generate all the outputs.
</summary>
<typeparam name="TOut">The output class of the macro.</typeparam>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.EvaluateOutputBase">
<summary>
The common output class for all evaluators.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.ClassificationEvaluateOutput">
<summary>
The output class for classification evaluators.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.CommonEvaluateOutput">
<summary>
The output class for regression evaluators.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IEvaluatorOutput">
<summary>
Interface that all API evaluator output classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonOutputs.IClassificationEvaluatorOutput">
<summary>
Interface that all API evaluator output classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.Var`1">
<summary>
Marker class for the arguments that can be used as variables
in an entry point graph.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.ArrayVar`1">
<summary>
Marker class for the arguments that can be used as array output variables
in an entry point graph.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.DictionaryVar`1">
<summary>
Marker class for the arguments that can be used as dictionary output variables
in an entry point graph.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.EntryPointVariable">
<summary>
A descriptor of one 'variable' of the graph (input or output that is referenced as a $variable in the graph definition).
</summary>
</member>
<member name="P:Microsoft.ML.EntryPoints.EntryPointVariable.Value">
<summary>
The value. It will originally start as null, and then assigned to the value,
once it is available. The type is one of the valid types according to <see cref="M:Microsoft.ML.EntryPoints.EntryPointVariable.IsValidType(System.Type)"/>.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.EntryPointVariable.IsValidType(System.Type)">
<summary>
Whether the given type is a valid one to be a variable.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.EntryPointVariable.SetValue(System.Object)">
<summary>
Set the value. It is only allowed once.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.RunContext">
<summary>
A collection of all known variables, with an interface to add new variables, get values based on names etc.
This is populated by individual nodes when they parse their respective JSON definitions, and then the values are updated
during the node execution.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.RunContext.AddOutputVariable(System.String,System.Type)">
<summary>
Returns true if added new variable, false if variable already exists.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.EntryPointNode">
<summary>
A representation of one graph node.
</summary>
</member>
<member name="P:Microsoft.ML.EntryPoints.EntryPointNode.StageId">
<summary>
An alphanumeric string indicating the stage of a node.
The fact that the nodes share the same stage ID hints that they should be executed together whenever possible.
</summary>
</member>
<member name="P:Microsoft.ML.EntryPoints.EntryPointNode.Checkpoint">
<summary>
Hints that the output of this node should be checkpointed.
</summary>
</member>
<member name="P:Microsoft.ML.EntryPoints.EntryPointNode.Cost">
<summary>
The cost of running this node. NaN indicates unknown.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.EntryPointNode.CheckAndSetInputValue(System.Collections.Generic.KeyValuePair{System.String,Newtonsoft.Json.Linq.JToken})">
<summary>
Checks the given JSON object key-value pair is a valid EntryPoint input and
extracts out any variables that need to be populated. These variables will be
added to the EntryPoint context. Input parameters that are not set to variables
will be immediately set using the input builder instance.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.EntryPointNode.CheckAndMarkOutputValue(System.Collections.Generic.KeyValuePair{System.String,Newtonsoft.Json.Linq.JToken})">
<summary>
Checks the given JSON object key-value pair is a valid EntryPoint output.
Extracts out any variables that need to be populated and adds them to the
EntryPoint context.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.EntryPointNode.CanStart">
<summary>
Whether the node can run right now.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.VariableBinding">
<summary>
Represents a delayed binding in a JSON graph to an <see cref="T:Microsoft.ML.EntryPoints.EntryPointVariable"/>.
The subclasses allow us to express that we either desire the variable itself,
or a array-indexed or dictionary-keyed value from the variable, assuming it is
of an Array or Dictionary type.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.VariableBinding.IsValidVariableName(Microsoft.ML.IExceptionContext,System.String)">
<summary>
Verifies that the name of the graph variable is a valid one
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.ParameterBinding">
<summary>
Represents the l-value assignable destination of a <see cref="T:Microsoft.ML.EntryPoints.VariableBinding"/>.
Subclasses exist to express the needed bindinds for subslots
of a yet-to-be-constructed array or dictionary EntryPoint input parameter
(for example, "myVar": ["$var1", "$var2"] would yield two <see cref="T:Microsoft.ML.EntryPoints.ArrayIndexParameterBinding"/>: (myVar, 0), (myVar, 1))
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.TransformInputBase">
<summary>
The base class for all transform inputs.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.TransformInputBase.Data">
<summary>
The input dataset. Used only in entry-point methods, since the normal API mechanism for feeding in a dataset to
create an <see cref="T:Microsoft.ML.ITransformer"/> is to use the <see cref="M:Microsoft.ML.IEstimator`1.Fit(Microsoft.Data.DataView.IDataView)"/> method.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.LearnerInputBase">
<summary>
The base class for all learner inputs.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.LearnerInputBase.TrainingData">
<summary>
The data to be used for training. Used only in entry-points, since in the API the expected mechanism is
that the user will use the <see cref="M:Microsoft.ML.IEstimator`1.Fit(Microsoft.Data.DataView.IDataView)"/> or some other train
method.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.LearnerInputBase.FeatureColumn">
<summary>
Column to use for features.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.LearnerInputBase.NormalizeFeatures">
<summary>
Normalize option for the feature column. Used only in entry-points, since in the API the user is expected to do this themselves.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.LearnerInputBase.Caching">
<summary>
Whether learner should cache input training data. Used only in entry-points, since the intended API mechanism
is that the user will use the <see cref="M:Microsoft.ML.DataOperationsCatalog.Cache(Microsoft.Data.DataView.IDataView,System.String[])"/> or other method
like <see cref="M:Microsoft.ML.Data.EstimatorChain`1.AppendCacheCheckpoint(Microsoft.ML.IHostEnvironment)"/>.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.LearnerInputBaseWithLabel">
<summary>
The base class for all learner inputs that support a Label column.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.LearnerInputBaseWithLabel.LabelColumn">
<summary>
Column to use for labels.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.LearnerInputBaseWithWeight">
<summary>
The base class for all learner inputs that support a weight column.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.LearnerInputBaseWithWeight.WeightColumn">
<summary>
The name of the example weight column.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.UnsupervisedLearnerInputBaseWithWeight">
<summary>
The base class for all unsupervised learner inputs that support a weight column.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.UnsupervisedLearnerInputBaseWithWeight.WeightColumn">
<summary>
Column to use for example weight.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.EvaluateInputBase">
<summary>
The base class for all evaluators inputs.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.LearnerInputBaseWithGroupId.GroupIdColumn">
<summary>
Column to use for example groupId.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs">
<summary>
Common input interfaces for TLC components.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.ITransformInput">
<summary>
Interface that all API transform input classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.IFeaturizerInput">
<summary>
Interface that all API trainable featurizers will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.ITrainerInput">
<summary>
Interface that all API trainer input classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.ITrainerInputWithLabel">
<summary>
Interface that all API trainer input classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.IUnsupervisedTrainerWithWeight">
<summary>
Interface that all API trainer input classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.ITrainerInputWithWeight">
<summary>
Interface that all API trainer input classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.ITrainerInputWithGroupId">
<summary>
Interface that all API trainer input classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.ICalibratorInput">
<summary>
Interface that all API calibrator input classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.CommonInputs.IEvaluatorInput">
<summary>
Interface that all API evaluator input classes will implement.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.InputBuilder">
<summary>
The class that creates and wraps around an instance of an input object and gradually populates all fields, keeping track of missing
required values. The values can be set from their JSON representation (during the graph parsing stage), as well as directly
(in the process of graph execution).
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.InputBuilder.GetFieldIndex(System.String)">
<summary>
Retreives the field index for a field with the given alias, or -1 if
that field alias is not found.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.InputBuilder.GetFieldTypeOrNull(System.String)">
<summary>
Returns the Type of the given field, unwrapping any option
types to be of their inner type. If the given alias doesn't exist
this method returns null.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.InputBuilder.GetMissingValues">
<summary>
Returns the array of required values that were not specified using <see cref="M:Microsoft.ML.EntryPoints.InputBuilder.TrySetValue(System.String,System.Object)"/>.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.InputBuilder.TrySetValueJson(System.String,Newtonsoft.Json.Linq.JToken)">
<summary>
Set a value of a field specified by <paramref name="name"/> by parsing <paramref name="value"/>.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.InputBuilder.TrySetValue(System.String,System.Object)">
<summary>
Set a value of a field specified by <paramref name="name"/> directly to <paramref name="value"/>.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.InputBuilder.GetFieldAssignableValue(Microsoft.ML.IExceptionContext,System.Type,System.Object)">
<summary>
Ensures that the given value can be assigned to an entry point field with
type <paramref name="type"/>. This method will wrap the value in the option
type if needed and throw an exception if the value isn't assignable.
</summary>
<param name="ectx">The exception context.</param>
<param name="type">Type type of the field this value is to be assigned to.</param>
<param name="value">The value, typically originates from either ParseJsonValue, or is an external, user-provided object.</param>
</member>
<member name="M:Microsoft.ML.EntryPoints.InputBuilder.MakeOptionalIfNeeded(Microsoft.ML.IExceptionContext,System.Object,System.Type)">
<summary>
If outerType is an Optional{T}, the innerValue is wrapped in a constructed, explicit
Optional instance, otherwise the value is directly returned.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.InputBuilder.GetInstance">
<summary>
Returns the created instance.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.OutputHelper">
<summary>
This class wraps around the output object type, does not create an instance, and provides utility methods for field type checking
and extracting values.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.OutputHelper.ExtractValues(System.Object)">
<summary>
Extract all values of a specified output object.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.FieldNames">
<summary>
These are the common field names used in the JSON objects for defining the manifest.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.FieldNames.Range">
<summary>
Range specific field names.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.FieldNames.Deprecated">
<summary>
Obsolete Attribute specific field names.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.FieldNames.SweepableLongParam">
<summary>
SweepableLongParam specific field names.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.FieldNames.SweepableFloatParam">
<summary>
SweepableFloatParam specific field names.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.FieldNames.SweepableDiscreteParam">
<summary>
SweepableDiscreteParam specific field names.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.PredictorModelImpl">
<summary>
This class encapsulates the predictor and a preceding transform model, as the concrete and hidden
implementation of <see cref="T:Microsoft.ML.EntryPoints.PredictorModel"/>.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.SelectRows">
<summary>
Entry point methods for row filtering and selection.
</summary>
</member>
<member name="T:Microsoft.ML.EntryPoints.TransformModelImpl">
<summary>
This encapsulates zero or more transform models. It does this by recording
the initial schema, together with the sequence of transforms applied to that
schema.
</summary>
</member>
<member name="F:Microsoft.ML.EntryPoints.TransformModelImpl._chain">
<summary>
This contains the transforms to save instantiated on an <see cref="T:Microsoft.Data.DataView.IDataView"/> with
appropriate initial schema. Note that the "root" of this is typically either
an empty <see cref="T:Microsoft.Data.DataView.IDataView"/> or a <see cref="T:Microsoft.ML.Data.IO.BinaryLoader"/> with no rows. However, other root
types are possible, since we don't insist on this when loading a model
from a zip file. However, whenever we save, we force a <see cref="T:Microsoft.ML.Data.IO.BinaryLoader"/> to
be serialized for the root.
</summary>
</member>
<member name="P:Microsoft.ML.EntryPoints.TransformModelImpl.InputSchema">
<summary>
The input schema that this transform model was originally instantiated on.
Note that the schema may have columns that aren't needed by this transform model.
If an <see cref="T:Microsoft.Data.DataView.IDataView"/> exists with this schema, then applying this transform model to it
shouldn't fail because of column type issues.
REVIEW: Would be nice to be able to trim this to the minimum needed somehow. Note
however that doing so may cause issues for composing transform models. For example,
if transform model A needs column X and model B needs Y, that is NOT produced by A,
then trimming A's input schema would cause composition to fail.
</summary>
</member>
<member name="P:Microsoft.ML.EntryPoints.TransformModelImpl.OutputSchema">
<summary>
The resulting schema once applied to this model. The <see cref="P:Microsoft.ML.EntryPoints.TransformModelImpl.InputSchema"/> might have
columns that are not needed by this transform and these columns will be seen in the
<see cref="P:Microsoft.ML.EntryPoints.TransformModelImpl.OutputSchema"/> produced by this transform.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.TransformModelImpl.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.IDataView)">
<summary>
Create a TransformModel containing the transforms from "result" back to "input".
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.TransformModelImpl.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.DataViewSchema,Microsoft.ML.Data.IDataTransform[])">
<summary>
Create a TransformModel containing the given (optional) transforms applied to the
given root schema.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.TransformModelImpl.#ctor(Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Load a transform model.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.TransformModelImpl.Apply(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView)">
<summary>
Apply this transform model to the given input data.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.TransformModelImpl.Apply(Microsoft.ML.IHostEnvironment,Microsoft.ML.EntryPoints.TransformModel)">
<summary>
Apply this transform model to the given input transform model to produce a composite transform model.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.TransformModelImpl.Save(Microsoft.ML.IHostEnvironment,System.IO.Stream)">
<summary>
Save this transform model.
</summary>
</member>
<member name="M:Microsoft.ML.EntryPoints.TransformModelImpl.CompositeRowToRowMapper.Microsoft#ML#Data#IRowToRowMapper#GetDependencies(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="T:Microsoft.ML.LoggingEventArgs">
<summary>
Provides data for the <see cref="E:Microsoft.ML.MLContext.Log"/> event.
</summary>
</member>
<member name="M:Microsoft.ML.LoggingEventArgs.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ML.LoggingEventArgs"/> class.
</summary>
<param name="message">The message being logged.</param>
</member>
<member name="P:Microsoft.ML.LoggingEventArgs.Message">
<summary>
Gets the message being logged.
</summary>
</member>
<member name="T:Microsoft.ML.MLContext">
<summary>
The <see cref="T:Microsoft.ML.MLContext"/> is a starting point for all ML.NET operations. It is instantiated by user,
provides mechanisms for logging and entry points for training, prediction, model operations etc.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.BinaryClassification">
<summary>
Trainers and tasks specific to binary classification problems.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.MulticlassClassification">
<summary>
Trainers and tasks specific to multiclass classification problems.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.Regression">
<summary>
Trainers and tasks specific to regression problems.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.Clustering">
<summary>
Trainers and tasks specific to clustering problems.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.Ranking">
<summary>
Trainers and tasks specific to ranking problems.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.AnomalyDetection">
<summary>
Trainers and tasks specific to anomaly detection problems.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.Transforms">
<summary>
Data processing operations.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.Model">
<summary>
Operations with trained models.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.Data">
<summary>
Data loading and saving.
</summary>
</member>
<member name="E:Microsoft.ML.MLContext.Log">
<summary>
The handler for the log messages.
</summary>
</member>
<member name="P:Microsoft.ML.MLContext.ComponentCatalog">
<summary>
This is a catalog of components that will be used for model loading.
</summary>
</member>
<member name="M:Microsoft.ML.MLContext.#ctor(System.Nullable{System.Int32},System.Int32)">
<summary>
Create the ML context.
</summary>
<param name="seed">Random seed. Set to <c>null</c> for a non-deterministic environment.</param>
<param name="conc">Concurrency level. Set to 1 to run single-threaded. Set to 0 to pick automatically.</param>
</member>
<member name="T:Microsoft.ML.ModelOperationsCatalog">
<summary>
An object serving as a 'catalog' of available model operations.
</summary>
</member>
<member name="P:Microsoft.ML.ModelOperationsCatalog.Environment">
<summary>
This is a best friend because an extension method defined in another assembly needs this field.
</summary>
</member>
<member name="M:Microsoft.ML.ModelOperationsCatalog.Save(Microsoft.ML.ITransformer,System.IO.Stream)">
<summary>
Save the model to the stream.
</summary>
<param name="model">The trained model to be saved.</param>
<param name="stream">A writeable, seekable stream to save to.</param>
</member>
<member name="M:Microsoft.ML.ModelOperationsCatalog.Load(System.IO.Stream)">
<summary>
Load the model from the stream.
</summary>
<param name="stream">A readable, seekable stream to load from.</param>
<returns>The loaded model.</returns>
</member>
<member name="T:Microsoft.ML.ModelOperationsCatalog.ExplainabilityTransforms">
<summary>
The catalog of model explainability operations.
</summary>
</member>
<member name="M:Microsoft.ML.ModelOperationsCatalog.CreatePredictionEngine``2(Microsoft.ML.ITransformer,Microsoft.ML.Data.SchemaDefinition,Microsoft.ML.Data.SchemaDefinition)">
<summary>
Create a prediction engine for one-time prediction.
</summary>
<typeparam name="TSrc">The class that defines the input data.</typeparam>
<typeparam name="TDst">The class that defines the output data.</typeparam>
<param name="transformer">The transformer to use for prediction.</param>
<param name="inputSchemaDefinition">Additional settings of the input schema.</param>
<param name="outputSchemaDefinition">Additional settings of the output schema.</param>
</member>
<member name="T:Microsoft.ML.PredictionEngineExtensions">
<summary>
Extension methods to create a prediction engine.
</summary>
</member>
<member name="M:Microsoft.ML.PredictionEngineExtensions.CreatePredictionEngine``2(Microsoft.ML.ITransformer,Microsoft.ML.IHostEnvironment,Microsoft.ML.Data.SchemaDefinition,Microsoft.ML.Data.SchemaDefinition)">
<summary>
Create a prediction engine for one-time prediction.
</summary>
<typeparam name="TSrc">The class that defines the input data.</typeparam>
<typeparam name="TDst">The class that defines the output data.</typeparam>
<param name="transformer">The transformer to use for prediction.</param>
<param name="env">The environment to use.</param>
<param name="inputSchemaDefinition">Additional settings of the input schema.</param>
<param name="outputSchemaDefinition">Additional settings of the output schema.</param>
</member>
<member name="T:Microsoft.ML.Calibrators.SignatureCalibrator">
<summary>
Signature for the loaders of calibrators.
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.ICalibratorTrainer">
<summary>
This is a legacy interface still used for the command line and entry-points. All applications should transition away
from this interface and still work instead via <see cref="T:Microsoft.ML.IEstimator`1"/> of <see cref="T:Microsoft.ML.Calibrators.CalibratorTransformer`1"/>,
for example, the subclasses of <see cref="T:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1"/>. However for now we retain this
until such time as those components making use of it can transition to the new way. No public surface should use
this, and even new internal code should avoid its use if possible.
</summary>
</member>
<member name="P:Microsoft.ML.Calibrators.ICalibratorTrainer.NeedsTraining">
<summary>
True if the calibrator needs training, false otherwise.
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.ICalibratorTrainer.ProcessTrainingExample(System.Single,System.Boolean,System.Single)">
<summary> Training calibrators: provide the output and the class label </summary>
<returns> True if it needs more examples, false otherwise</returns>
</member>
<member name="M:Microsoft.ML.Calibrators.ICalibratorTrainer.FinishTraining(Microsoft.ML.IChannel)">
<summary> Finish up training after seeing all examples </summary>
</member>
<member name="T:Microsoft.ML.Calibrators.IHaveCalibratorTrainer">
<summary>
This is a shim interface implemented only by <see cref="T:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1"/> to enable
access to the underlying legacy <see cref="T:Microsoft.ML.Calibrators.ICalibratorTrainer"/> interface for those components that use
that old mechanism that we do not care to change right now.
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.ISelfCalibratingPredictor">
<summary>
An interface for predictors that take care of their own calibration given an input data view.
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.IWeaklyTypedCalibratedModelParameters">
<summary>
<see cref="T:Microsoft.ML.Calibrators.IWeaklyTypedCalibratedModelParameters"/> provides a weekly-typed way to access strongly-typed
<see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.SubModel"/> and
<see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.Calibrator"/>.
<see cref="T:Microsoft.ML.Calibrators.IWeaklyTypedCalibratedModelParameters"/> is commonly used in weekly-typed expressions. The
existence of this interface is just for supporting existing codebase, so we discourage its uses.
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2">
<summary>
Class for allowing a post-processing step, defined by <see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.Calibrator"/>, to <see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.SubModel"/>'s
output.
</summary>
<typeparam name="TSubModel">Type being calibrated.</typeparam>
<typeparam name="TCalibrator">Type used to calibrate.</typeparam>
<remarks>
For example, in binary classification, <see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.Calibrator"/> can convert support vector machine's
output value to the probability of belonging to the positive (or negative) class. Detailed math materials
can be found at <a href="https://www.csie.ntu.edu.tw/~cjlin/papers/plattprob.pdf">this paper</a>.
</remarks>
</member>
<member name="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.SubModel">
<summary>
<see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.SubModel"/>'s output would calibrated by <see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.Calibrator"/>.
</summary>
</member>
<member name="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.Calibrator">
<summary>
<see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.Calibrator"/> is used to post-process score produced by <see cref="P:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.SubModel"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratedModelParametersBase`2.Microsoft#ML#Model#ICanGetSummaryInKeyValuePairs#GetSummaryInKeyValuePairs(Microsoft.ML.Data.RoleMappedSchema)">
<inheritdoc/>
</member>
<member name="T:Microsoft.ML.Calibrators.ParameterMixingCalibratedModelParameters`2">
<summary>
Encapsulates a predictor and a calibrator that implement <see cref="T:Microsoft.ML.Model.IParameterMixer"/>.
Its implementation of <see cref="M:Microsoft.ML.Model.IParameterMixer.CombineParameters(System.Collections.Generic.IList{Microsoft.ML.Model.IParameterMixer})"/> combines both the predictors and the calibrators.
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.SchemaBindableCalibratedModelParameters`2.Bound.Microsoft#ML#Data#ISchemaBoundRowMapper#GetDependenciesForNewColumns(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="P:Microsoft.ML.Calibrators.SchemaBindableCalibratedModelParameters`2.Microsoft#ML#Model#Pfa#ICanSavePfa#CanSavePfa">
<summary>
Whether we can save as PFA. Note that this depends on whether the underlying predictor
can save as PFA, since in the event that this in particular does not get saved,
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratorUtils.TrainCalibratorIfNeeded(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.ML.Calibrators.ICalibratorTrainer,System.Int32,Microsoft.ML.ITrainer,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedData)">
<summary>
Trains a calibrator, if needed.
</summary>
<param name="env">The environment to use.</param>
<param name="ch">The channel.</param>
<param name="calibrator">The calibrator trainer.</param>
<param name="maxRows">The maximum rows to use for calibrator training.</param>
<param name="trainer">The trainer used to train the predictor.</param>
<param name="predictor">The predictor that needs calibration.</param>
<param name="data">The examples to used for calibrator training.</param>
<returns>The original predictor, if no calibration is needed,
or a metapredictor that wraps the original predictor and the newly trained calibrator.</returns>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratorUtils.GetCalibratedPredictor(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.ML.Calibrators.ICalibratorTrainer,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedData,System.Int32)">
<summary>
Trains a calibrator.
</summary>
<param name="env">The environment to use.</param>
<param name="ch">The channel.</param>
<param name="caliTrainer">The calibrator trainer.</param>
<param name="predictor">The predictor that needs calibration.</param>
<param name="data">The examples to used for calibrator training.</param>
<param name="maxRows">The maximum rows to use for calibrator training.</param>
<returns>The original predictor, if no calibration is needed,
or a metapredictor that wraps the original predictor and the newly trained calibrator.</returns>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratorUtils.TrainCalibrator(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.ML.Calibrators.ICalibratorTrainer,Microsoft.ML.IPredictor,Microsoft.ML.Data.RoleMappedData,System.Int32)">
<summary>
Trains a calibrator.
</summary>
<param name="env">The environment to use.</param>
<param name="ch">The channel.</param>
<param name="caliTrainer">The calibrator trainer.</param>
<param name="predictor">The predictor that needs calibration.</param>
<param name="data">The examples to used for calibrator training.</param>
<param name="maxRows">The maximum rows to use for calibrator training.</param>
<returns>The original predictor, if no calibration is needed,
or a metapredictor that wraps the original predictor and the newly trained calibrator.</returns>
</member>
<member name="T:Microsoft.ML.Calibrators.NaiveCalibratorTrainer">
<summary>
Trains a <see cref="T:Microsoft.ML.Calibrators.NaiveCalibrator"/> by dividing the range of the outputs into equally sized bins.
The probability of belonging to a particular class, for example class 1, is the number of class 1 instances in the bin, divided by the total number
of instances in that bin.
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.NaiveCalibratorTrainer.#ctor(Microsoft.ML.IHostEnvironment)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Calibrators.NaiveCalibratorTrainer"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.NaiveCalibrator">
<summary>
The naive binning-based calibrator.
</summary>
</member>
<member name="F:Microsoft.ML.Calibrators.NaiveCalibrator.BinSize">
<summary> The bin size.</summary>
</member>
<member name="F:Microsoft.ML.Calibrators.NaiveCalibrator.Min">
<summary> The minimum value in the first bin.</summary>
</member>
<member name="P:Microsoft.ML.Calibrators.NaiveCalibrator.BinProbs">
<summary> The value of probability in each bin.</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.NaiveCalibrator.#ctor(Microsoft.ML.IHostEnvironment,System.Single,System.Single,System.Single[])">
<summary> Initializes a new instance of <see cref="T:Microsoft.ML.Calibrators.NaiveCalibrator"/>.</summary>
<param name="env">The <see cref="T:Microsoft.ML.IHostEnvironment"/> to use.</param>
<param name="min">The minimum value in the first bin.</param>
<param name="binProbs">The values of the probability in each bin.</param>
<param name="binSize">The bin size.</param>
</member>
<member name="M:Microsoft.ML.Calibrators.NaiveCalibrator.PredictProbability(System.Single)">
<summary>
Given a classifier output, produce the probability
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.CalibratorTrainerBase">
<summary>
Base class for calibrator trainers.
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratorTrainerBase.DataStore.GetEnumerator">
<summary>
An enumerator over the <see cref="T:Microsoft.ML.Calibrators.CalibratorTrainerBase.DataStore.DataItem"/> entries sorted by score.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratorTrainerBase.Microsoft#ML#Calibrators#ICalibratorTrainer#ProcessTrainingExample(System.Single,System.Boolean,System.Single)">
<summary>
Training calibrators: provide the classifier output and the class label
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.PlattCalibrator">
<summary> The Platt calibrator calculates the probability following:
P(x) = 1 / (1 + exp(-<see cref="P:Microsoft.ML.Calibrators.PlattCalibrator.Slope"/> * x + <see cref="P:Microsoft.ML.Calibrators.PlattCalibrator.Offset"/>) </summary>.
</member>
<member name="P:Microsoft.ML.Calibrators.PlattCalibrator.Slope">
<summary>
Slope value for this calibrator.
</summary>
</member>
<member name="P:Microsoft.ML.Calibrators.PlattCalibrator.Offset">
<summary>
Offset value for this calibrator
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.PlattCalibrator.#ctor(Microsoft.ML.IHostEnvironment,System.Double,System.Double)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Calibrators.PlattCalibrator"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.PlattCalibrator.PredictProbability(System.Single)">
<summary> Given a classifier output, produce the probability.</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.PavCalibrator">
<summary>
The pair-adjacent violators calibrator.
</summary>
<remarks>
The function that is implemented by this calibrator is:
P(x) =
<list type="bullet">
<item><description><see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Values"/>[i], if <see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Mins"/>[i] <= x <= <see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Maxes"/>[i]</description>></item>
<item> <description>Linear interpolation between <see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Values"/>[i] and <see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Values"/>[i+1], if <see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Maxes"/>[i] < x < <see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Mins"/>[i+1]</description></item>
<item><description><see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Values"/>[0], if x < <see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Mins"/>[0]</description></item>
<item><description><see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Values"/>[n], if x > <see cref="F:Microsoft.ML.Calibrators.PavCalibrator.Maxes"/>[n]</description></item>
</list>
</remarks>
</member>
<member name="F:Microsoft.ML.Calibrators.PavCalibrator.Mins">
<summary>
Bottom borders of PAV intervals.
</summary>
</member>
<member name="F:Microsoft.ML.Calibrators.PavCalibrator.Maxes">
<summary>
Upper borders of PAV intervals.
</summary>
</member>
<member name="F:Microsoft.ML.Calibrators.PavCalibrator.Values">
<summary>
Values of PAV intervals.
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.PavCalibrator.#ctor(Microsoft.ML.IHostEnvironment,System.Collections.Immutable.ImmutableArray{System.Single},System.Collections.Immutable.ImmutableArray{System.Single},System.Collections.Immutable.ImmutableArray{System.Single})">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Calibrators.PavCalibrator"/>.
</summary>
<param name="env">The <see cref="T:Microsoft.ML.IHostEnvironment"/> to use.</param>
<param name="mins">The minimum values for each piece.</param>
<param name="maxes">The maximum values for each piece.</param>
<param name="values">The actual values for each piece.</param>
</member>
<member name="M:Microsoft.ML.Calibrators.PavCalibrator.PredictProbability(System.Single)">
<summary> Given a classifier output, produce the probability.</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.Calibrate.CalibratePredictor``1(Microsoft.ML.IHost,Microsoft.ML.Calibrators.Calibrate.CalibrateInputBase,Microsoft.ML.Calibrators.ICalibratorTrainer)">
<summary>
This method calibrates the specified predictor using the specified calibrator, training on the specified data.
</summary>
<param name="host">A host to pass to the components created in this method.</param>
<param name="input">The input object, containing the predictor, the data and an integer indicating the maximum number
of examples to use for training the calibrator.</param>
<param name="calibratorTrainer">The kind of calibrator to use.</param>
<returns>A <see cref="T:Microsoft.ML.EntryPoints.CommonOutputs.TrainerOutput"/> object, containing an <see cref="T:Microsoft.ML.EntryPoints.PredictorModel"/>.</returns>
</member>
<member name="T:Microsoft.ML.Calibrators.ICalibrator">
<summary>
An interface for probability calibrators.
</summary>
</member>
<member name="M:Microsoft.ML.Calibrators.ICalibrator.PredictProbability(System.Single)">
<summary> Given a classifier output, produce the probability.</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1">
<summary>
Base class for calibrator estimators.
</summary>
<remarks>
CalibratorEstimators take an <see cref="T:Microsoft.Data.DataView.IDataView"/> (the output of a <see cref="T:Microsoft.ML.Data.BinaryClassifierScorer"/>)
that contains a "Score" column, and converts the scores to probabilities(through binning, interpolation etc.), based on the <typeparamref name="TICalibrator"/> type.
They are used in pipelines where the binary classifier produces non-calibrated scores.
</remarks>
<example>
<format type="text/markdown">
<]
]]></format>
</example>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1.Microsoft#ML#IEstimator{Microsoft#ML#Calibrators#CalibratorTransformer{TICalibrator}}#GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Gets the output <see cref="T:Microsoft.ML.SchemaShape"/> of the <see cref="T:Microsoft.Data.DataView.IDataView"/> after fitting the calibrator.
Fitting the calibrator will add a column named "Probability" to the schema. If you already had such a column, a new one will be added.
</summary>
<param name="inputSchema">The input <see cref="T:Microsoft.ML.SchemaShape"/>.</param>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1.Fit(Microsoft.Data.DataView.IDataView)">
<summary>
Fits the scored <see cref="T:Microsoft.Data.DataView.IDataView"/> creating a <see cref="T:Microsoft.ML.Calibrators.CalibratorTransformer`1"/> that can transform the data by adding a
<see cref="F:Microsoft.ML.Data.DefaultColumnNames.Probability"/> column containing the calibrated <see cref="F:Microsoft.ML.Data.DefaultColumnNames.Score"/>.
</summary>
<param name="input"></param>
<returns>A trained <see cref="T:Microsoft.ML.Calibrators.CalibratorTransformer`1"/> that will transform the data by adding the
<see cref="F:Microsoft.ML.Data.DefaultColumnNames.Probability"/> column.</returns>
</member>
<member name="M:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1.Create(Microsoft.ML.IHostEnvironment,`0)">
<summary>
Implemented by deriving classes that create a concrete calibrator.
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.CalibratorTransformer`1">
<summary>
An instance of this class is the result of calling <see cref="M:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1.Fit(Microsoft.Data.DataView.IDataView)"/>.
If you pass a scored data, to the <see cref="T:Microsoft.ML.Calibrators.CalibratorTransformer`1"/> Transform method, it will add the Probability column
to the dataset. The Probability column is the value of the Score normalized to be a valid probability.
The <see cref="T:Microsoft.ML.Calibrators.CalibratorTransformer`1"/> is an instance of <see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/>
where score can be viewed as a feature while probability is treated as the label.
</summary>
<typeparam name="TICalibrator">The <see cref="T:Microsoft.ML.Calibrators.ICalibrator"/> used to transform the data.</typeparam>
</member>
<member name="T:Microsoft.ML.Calibrators.PlattCalibratorEstimator">
<summary>
The Platt calibrator estimator.
</summary>
<remarks>
For the usage pattern see the example in <see cref="T:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1"/>.
</remarks>
</member>
<member name="M:Microsoft.ML.Calibrators.PlattCalibratorEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String,System.String)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Calibrators.PlattCalibratorEstimator"/>
</summary>
<param name="env">The environment to use.</param>
<param name="labelColumn">The label column name. This is consumed when this estimator is fit,
but not consumed by the resulting transformer.</param>
<param name="scoreColumn">The score column name. This is consumed both when this estimator
is fit and when the estimator is consumed.</param>
<param name="weightColumn">The optional weight column name. Note that if specified this is
consumed when this estimator is fit, but not consumed by the resulting transformer.</param>
</member>
<member name="T:Microsoft.ML.Calibrators.FixedPlattCalibratorEstimator">
<summary>
Obtains the probability values by applying the sigmoid: f(x) = 1 / (1 + exp(-slope * x + offset).
Note that unlike, say, <see cref="T:Microsoft.ML.Calibrators.PlattCalibratorEstimator"/>, the fit function here is trivial
and just "fits" a calibrator with the provided parameters.
</summary>
<remarks>
For the usage pattern see the example in <see cref="T:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1"/>.
</remarks>
</member>
<member name="M:Microsoft.ML.Calibrators.FixedPlattCalibratorEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.Double,System.Double,System.String)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Calibrators.FixedPlattCalibratorEstimator"/>.
</summary>
<remarks>
Note that unlike many other calibrator estimators this one has the parameters pre-specified.
This means that it does not have a label or weight column specified as an input during training.
</remarks>
<param name="env">The environment to use.</param>
<param name="slope">The slope in the function of the exponent of the sigmoid.</param>
<param name="offset">The offset in the function of the exponent of the sigmoid.</param>
<param name="scoreColumn">The score column name. This is consumed both when this estimator
is fit and when the estimator is consumed.</param>
</member>
<member name="T:Microsoft.ML.Calibrators.PlattCalibratorTransformer">
<summary>
The <see cref="T:Microsoft.ML.ITransformer"/> implementation obtained by training a <see cref="T:Microsoft.ML.Calibrators.FixedPlattCalibratorEstimator"/> or a <see cref="T:Microsoft.ML.Calibrators.PlattCalibratorEstimator"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.NaiveCalibratorEstimator">
<summary>
The naive binning-based calbirator estimator.
</summary>
<remarks>
It divides the range of the outputs into equally sized bins. In each bin,
the probability of belonging to class 1, is the number of class 1 instances in the bin, divided by the total number
of instances in the bin.
For the usage pattern see the example in <see cref="T:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1"/>.
</remarks>
</member>
<member name="M:Microsoft.ML.Calibrators.NaiveCalibratorEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String,System.String)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Calibrators.NaiveCalibratorEstimator"/>
</summary>
<param name="env">The environment to use.</param>
<param name="labelColumn">The label column name. This is consumed when this estimator is fit,
but not consumed by the resulting transformer.</param>
<param name="scoreColumn">The score column name. This is consumed both when this estimator
is fit and when the estimator is consumed.</param>
<param name="weightColumn">The optional weight column name. Note that if specified this is
consumed when this estimator is fit, but not consumed by the resulting transformer.</param>
</member>
<member name="T:Microsoft.ML.Calibrators.NaiveCalibratorTransformer">
<summary>
The <see cref="T:Microsoft.ML.ITransformer"/> implementation obtained by training a <see cref="T:Microsoft.ML.Calibrators.NaiveCalibratorEstimator"/>
</summary>
</member>
<member name="T:Microsoft.ML.Calibrators.PavCalibratorEstimator">
<summary>
The pair-adjacent violators calibrator estimator.
</summary>
<remarks>
For the usage pattern see the example in <see cref="T:Microsoft.ML.Calibrators.CalibratorEstimatorBase`1"/>.
</remarks>
</member>
<member name="M:Microsoft.ML.Calibrators.PavCalibratorEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String,System.String)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Calibrators.PavCalibratorEstimator"/>
</summary>
<param name="env">The environment to use.</param>
<param name="labelColumn">The label column name. This is consumed when this estimator is fit,
but not consumed by the resulting transformer.</param>
<param name="scoreColumn">The score column name. This is consumed both when this estimator
is fit and when the estimator is consumed.</param>
<param name="weightColumn">The optional weight column name. Note that if specified this is
consumed when this estimator is fit, but not consumed by the resulting transformer.</param>
</member>
<member name="T:Microsoft.ML.Calibrators.PavCalibratorTransformer">
<summary>
The <see cref="T:Microsoft.ML.ITransformer"/> implementation obtained by training a <see cref="T:Microsoft.ML.Calibrators.PavCalibratorEstimator"/>
</summary>
</member>
<member name="T:Microsoft.ML.IPredictionTransformer`1">
<summary>
An interface for all the transformer that can transform data based on the <see cref="T:Microsoft.ML.IPredictor"/> field.
The implemendations of this interface either have no feature column, or have more than one feature column, and cannot implement the
<see cref="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1"/>, which most of the ML.Net tranformer implement.
</summary>
<typeparam name="TModel">The <see cref="T:Microsoft.ML.IPredictor"/> or <see cref="T:Microsoft.ML.Calibrators.ICalibrator"/> used for the data transformation.</typeparam>
</member>
<member name="T:Microsoft.ML.ISingleFeaturePredictionTransformer`1">
<summary>
An ISingleFeaturePredictionTransformer contains the name of the <see cref="P:Microsoft.ML.ISingleFeaturePredictionTransformer`1.FeatureColumn"/>
and its type, <see cref="P:Microsoft.ML.ISingleFeaturePredictionTransformer`1.FeatureColumnType"/>. Implementations of this interface, have the ability
to score the data of an input <see cref="T:Microsoft.Data.DataView.IDataView"/> through the <see cref="M:Microsoft.ML.ITransformer.Transform(Microsoft.Data.DataView.IDataView)"/>
</summary>
<typeparam name="TModel">The <see cref="T:Microsoft.ML.IPredictor"/> or <see cref="T:Microsoft.ML.Calibrators.ICalibrator"/> used for the data transformation.</typeparam>
</member>
<member name="P:Microsoft.ML.ISingleFeaturePredictionTransformer`1.FeatureColumn">
<summary>The name of the feature column.</summary>
</member>
<member name="P:Microsoft.ML.ISingleFeaturePredictionTransformer`1.FeatureColumnType">
<summary>Holds information about the type of the feature column.</summary>
</member>
<member name="T:Microsoft.ML.PipeEngine`1">
<summary>
Utility class to run the pipeline to completion and produce a strongly-typed IEnumerable as a result.
Doesn't allocate memory for every row: instead, yields the same row object on every step.
</summary>
</member>
<member name="M:Microsoft.ML.PredictionEngine`2.Predict(`0,`1@)">
<summary>
Run prediction pipeline on one example.
</summary>
<param name="example">The example to run on.</param>
<param name="prediction">The object to store the prediction in. If it's <c>null</c>, a new one will be created, otherwise the old one
is reused.</param>
</member>
<member name="T:Microsoft.ML.PredictionEngineBase`2">
<summary>
A class that runs the previously trained model (and the preceding transform pipeline) on the
in-memory data, one example at a time.
This can also be used with trained pipelines that do not end with a predictor: in this case, the
'prediction' will be just the outcome of all the transformations.
</summary>
<typeparam name="TSrc">The user-defined type that holds the example.</typeparam>
<typeparam name="TDst">The user-defined type that holds the prediction.</typeparam>
</member>
<member name="F:Microsoft.ML.PredictionEngineBase`2.OutputSchema">
<summary>
Provides output schema.
</summary>
</member>
<member name="M:Microsoft.ML.PredictionEngineBase`2.Predict(`0)">
<summary>
Run prediction pipeline on one example.
</summary>
<param name="example">The example to run on.</param>
<returns>The result of prediction. A new object is created for every call.</returns>
</member>
<member name="M:Microsoft.ML.PredictionEngineBase`2.Predict(`0,`1@)">
<summary>
Run prediction pipeline on one example.
</summary>
<param name="example">The example to run on.</param>
<param name="prediction">The object to store the prediction in. If it's <c>null</c>, a new one will be created, otherwise the old one
is reused.</param>
</member>
<member name="T:Microsoft.ML.TrainCatalogBase">
<summary>
A training catalog is an object instantiable by a user to do various tasks relating to a particular
"area" of machine learning. A subclass would represent a particular task in machine learning. The idea
is that a user can instantiate that particular area, and get trainers and evaluators.
</summary>
</member>
<member name="T:Microsoft.ML.TrainCatalogBase.TrainTestData">
<summary>
A pair of datasets, for the train and test set.
</summary>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.TrainTestData.TrainSet">
<summary>
Training set.
</summary>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.TrainTestData.TestSet">
<summary>
Testing set.
</summary>
</member>
<member name="M:Microsoft.ML.TrainCatalogBase.TrainTestData.#ctor(Microsoft.Data.DataView.IDataView,Microsoft.Data.DataView.IDataView)">
<summary>
Create pair of datasets.
</summary>
<param name="trainSet">Training set.</param>
<param name="testSet">Testing set.</param>
</member>
<member name="M:Microsoft.ML.TrainCatalogBase.TrainTestSplit(Microsoft.Data.DataView.IDataView,System.Double,System.String,System.Nullable{System.UInt32})">
<summary>
Split the dataset into the train set and test set according to the given fraction.
Respects the <paramref name="samplingKeyColumn"/> if provided.
</summary>
<param name="data">The dataset to split.</param>
<param name="testFraction">The fraction of data to go into the test set.</param>
<param name="samplingKeyColumn">Name of a column to use for grouping rows. If two examples share the same value of the <paramref name="samplingKeyColumn"/>,
they are guaranteed to appear in the same subset (train or test). This can be used to ensure no label leakage from the train to the test set.
If <see langword="null"/> no row grouping will be performed.</param>
<param name="seed">Seed for the random number generator used to select rows for the train-test split.</param>
</member>
<member name="T:Microsoft.ML.TrainCatalogBase.CrossValidationResult">
<summary>
Results for specific cross-validation fold.
</summary>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.CrossValidationResult.Model">
<summary>
Model trained during cross validation fold.
</summary>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.CrossValidationResult.Scores">
<summary>
Scored test set with <see cref="F:Microsoft.ML.TrainCatalogBase.CrossValidationResult.Model"/> for this fold.
</summary>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.CrossValidationResult.Fold">
<summary>
Fold number.
</summary>
</member>
<member name="T:Microsoft.ML.TrainCatalogBase.CrossValidationResult`1">
<summary>
Results of running cross-validation.
</summary>
<typeparam name="T">Type of metric class.</typeparam>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.CrossValidationResult`1.Metrics">
<summary>
Metrics for this cross-validation fold.
</summary>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.CrossValidationResult`1.Model">
<summary>
Model trained during cross-validation fold.
</summary>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.CrossValidationResult`1.ScoredHoldOutSet">
<summary>
The scored hold-out set for this fold.
</summary>
</member>
<member name="F:Microsoft.ML.TrainCatalogBase.CrossValidationResult`1.Fold">
<summary>
Fold number.
</summary>
</member>
<member name="M:Microsoft.ML.TrainCatalogBase.CrossValidateTrain(Microsoft.Data.DataView.IDataView,Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},System.Int32,System.String,System.Nullable{System.UInt32})">
<summary>
Train the <paramref name="estimator"/> on <paramref name="numFolds"/> folds of the data sequentially.
Return each model and each scored test dataset.
</summary>
</member>
<member name="M:Microsoft.ML.TrainCatalogBase.EnsureGroupPreservationColumn(Microsoft.Data.DataView.IDataView@,System.String@,System.Nullable{System.UInt32})">
<summary>
Ensures the provided <paramref name="samplingKeyColumn"/> is valid for <see cref="T:Microsoft.ML.Transforms.RangeFilter"/>, hashing it if necessary, or creates a new column <paramref name="samplingKeyColumn"/> is null.
</summary>
</member>
<member name="T:Microsoft.ML.TrainCatalogBase.CatalogInstantiatorBase">
<summary>
Subclasses of <see cref="T:Microsoft.ML.TrainContext"/> will provide little "extension method" hookable objects
(for example, something like <see cref="P:Microsoft.ML.BinaryClassificationCatalog.Trainers"/>). User code will only
interact with these objects by invoking the extension methods. The actual component code can work
through <see cref="T:Microsoft.ML.Data.CatalogUtils"/> to get more "hidden" information from this object,
for example, the environment.
</summary>
</member>
<member name="T:Microsoft.ML.BinaryClassificationCatalog">
<summary>
The central catalog for binary classification tasks and trainers.
</summary>
</member>
<member name="P:Microsoft.ML.BinaryClassificationCatalog.Trainers">
<summary>
The list of trainers for performing binary classification.
</summary>
</member>
<member name="M:Microsoft.ML.BinaryClassificationCatalog.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String,System.String)">
<summary>
Evaluates scored binary classification data.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="probability">The name of the probability column in <paramref name="data"/>, the calibrated version of <paramref name="score"/>.</param>
<param name="predictedLabel">The name of the predicted label column in <paramref name="data"/>.</param>
<returns>The evaluation results for these calibrated outputs.</returns>
</member>
<member name="M:Microsoft.ML.BinaryClassificationCatalog.EvaluateNonCalibrated(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Evaluates scored binary classification data, without probability-based metrics.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="predictedLabel">The name of the predicted label column in <paramref name="data"/>.</param>
<returns>The evaluation results for these uncalibrated outputs.</returns>
</member>
<member name="M:Microsoft.ML.BinaryClassificationCatalog.CrossValidateNonCalibrated(Microsoft.Data.DataView.IDataView,Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},System.Int32,System.String,System.String,System.Nullable{System.UInt32})">
<summary>
Run cross-validation over <paramref name="numFolds"/> folds of <paramref name="data"/>, by fitting <paramref name="estimator"/>,
and respecting <paramref name="samplingKeyColumn"/> if provided.
Then evaluate each sub-model against <paramref name="labelColumn"/> and return metrics.
</summary>
<param name="data">The data to run cross-validation on.</param>
<param name="estimator">The estimator to fit.</param>
<param name="numFolds">Number of cross-validation folds.</param>
<param name="labelColumn">The label column (for evaluation).</param>
<param name="samplingKeyColumn">Name of a column to use for grouping rows. If two examples share the same value of the <paramref name="samplingKeyColumn"/>,
they are guaranteed to appear in the same subset (train or test). This can be used to ensure no label leakage from the train to the test set.
If <see langword="null"/> no row grouping will be performed.</param>
<param name="seed">Seed for the random number generator used to select rows for cross-validation folds.</param>
<returns>Per-fold results: metrics, models, scored datasets.</returns>
</member>
<member name="M:Microsoft.ML.BinaryClassificationCatalog.CrossValidate(Microsoft.Data.DataView.IDataView,Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},System.Int32,System.String,System.String,System.Nullable{System.UInt32})">
<summary>
Run cross-validation over <paramref name="numFolds"/> folds of <paramref name="data"/>, by fitting <paramref name="estimator"/>,
and respecting <paramref name="samplingKeyColumn"/> if provided.
Then evaluate each sub-model against <paramref name="labelColumn"/> and return metrics.
</summary>
<param name="data">The data to run cross-validation on.</param>
<param name="estimator">The estimator to fit.</param>
<param name="numFolds">Number of cross-validation folds.</param>
<param name="labelColumn">The label column (for evaluation).</param>
<param name="samplingKeyColumn">Name of a column to use for grouping rows. If two examples share the same value of the <paramref name="samplingKeyColumn"/>,
they are guaranteed to appear in the same subset (train or test). This can be used to ensure no label leakage from the train to the test set.
If <see langword="null"/> no row grouping will be performed.</param>
<param name="seed">Seed for the random number generator used to select rows for cross-validation folds.</param>
<returns>Per-fold results: metrics, models, scored datasets.</returns>
</member>
<member name="T:Microsoft.ML.ClusteringCatalog">
<summary>
The central catalog for clustering tasks and trainers.
</summary>
</member>
<member name="P:Microsoft.ML.ClusteringCatalog.Trainers">
<summary>
The list of trainers for performing clustering.
</summary>
</member>
<member name="M:Microsoft.ML.ClusteringCatalog.#ctor(Microsoft.ML.IHostEnvironment)">
<summary>
The clustering context.
</summary>
</member>
<member name="M:Microsoft.ML.ClusteringCatalog.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Evaluates scored clustering data.
</summary>
<param name="data">The scored data.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="label">The name of the optional label column in <paramref name="data"/>.
If present, the <see cref="P:Microsoft.ML.Data.ClusteringMetrics.Nmi"/> metric will be computed.</param>
<param name="features">The name of the optional features column in <paramref name="data"/>.
If present, the <see cref="P:Microsoft.ML.Data.ClusteringMetrics.Dbi"/> metric will be computed.</param>
<returns>The evaluation result.</returns>
</member>
<member name="M:Microsoft.ML.ClusteringCatalog.CrossValidate(Microsoft.Data.DataView.IDataView,Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},System.Int32,System.String,System.String,System.String,System.Nullable{System.UInt32})">
<summary>
Run cross-validation over <paramref name="numFolds"/> folds of <paramref name="data"/>, by fitting <paramref name="estimator"/>,
and respecting <paramref name="samplingKeyColumn"/> if provided.
Then evaluate each sub-model against <paramref name="labelColumn"/> and return metrics.
</summary>
<param name="data">The data to run cross-validation on.</param>
<param name="estimator">The estimator to fit.</param>
<param name="numFolds">Number of cross-validation folds.</param>
<param name="labelColumn">Optional label column for evaluation (clustering tasks may not always have a label).</param>
<param name="featuresColumn">Optional features column for evaluation (needed for calculating Dbi metric)</param>
<param name="samplingKeyColumn">Name of a column to use for grouping rows. If two examples share the same value of the <paramref name="samplingKeyColumn"/>,
they are guaranteed to appear in the same subset (train or test). This can be used to ensure no label leakage from the train to the test set.
If <see langword="null"/> no row grouping will be performed.</param>
<param name="seed">Seed for the random number generator used to select rows for cross-validation folds.</param>
</member>
<member name="T:Microsoft.ML.MulticlassClassificationCatalog">
<summary>
The central catalog for multiclass classification tasks and trainers.
</summary>
</member>
<member name="P:Microsoft.ML.MulticlassClassificationCatalog.Trainers">
<summary>
The list of trainers for performing multiclass classification.
</summary>
</member>
<member name="M:Microsoft.ML.MulticlassClassificationCatalog.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String,System.Int32)">
<summary>
Evaluates scored multiclass classification data.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="predictedLabel">The name of the predicted label column in <paramref name="data"/>.</param>
<param name="topK">If given a positive value, the <see cref="P:Microsoft.ML.Data.MultiClassClassifierMetrics.TopKAccuracy"/> will be filled with
the top-K accuracy, that is, the accuracy assuming we consider an example with the correct class within
the top-K values as being stored "correctly."</param>
<returns>The evaluation results for these calibrated outputs.</returns>
</member>
<member name="M:Microsoft.ML.MulticlassClassificationCatalog.CrossValidate(Microsoft.Data.DataView.IDataView,Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},System.Int32,System.String,System.String,System.Nullable{System.UInt32})">
<summary>
Run cross-validation over <paramref name="numFolds"/> folds of <paramref name="data"/>, by fitting <paramref name="estimator"/>,
and respecting <paramref name="samplingKeyColumn"/> if provided.
Then evaluate each sub-model against <paramref name="labelColumn"/> and return metrics.
</summary>
<param name="data">The data to run cross-validation on.</param>
<param name="estimator">The estimator to fit.</param>
<param name="numFolds">Number of cross-validation folds.</param>
<param name="labelColumn">The label column (for evaluation).</param>
<param name="samplingKeyColumn">Name of a column to use for grouping rows. If two examples share the same value of the <paramref name="samplingKeyColumn"/>,
they are guaranteed to appear in the same subset (train or test). This can be used to ensure no label leakage from the train to the test set.
If <see langword="null"/> no row grouping will be performed.</param>
<param name="seed">Seed for the random number generator used to select rows for cross-validation folds.</param>
<returns>Per-fold results: metrics, models, scored datasets.</returns>
<returns>Per-fold results: metrics, models, scored datasets.</returns>
</member>
<member name="T:Microsoft.ML.RegressionCatalog">
<summary>
The central catalog for regression tasks and trainers.
</summary>
</member>
<member name="P:Microsoft.ML.RegressionCatalog.Trainers">
<summary>
The list of trainers for performing regression.
</summary>
</member>
<member name="M:Microsoft.ML.RegressionCatalog.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String)">
<summary>
Evaluates scored regression data.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<returns>The evaluation results for these calibrated outputs.</returns>
</member>
<member name="M:Microsoft.ML.RegressionCatalog.CrossValidate(Microsoft.Data.DataView.IDataView,Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},System.Int32,System.String,System.String,System.Nullable{System.UInt32})">
<summary>
Run cross-validation over <paramref name="numFolds"/> folds of <paramref name="data"/>, by fitting <paramref name="estimator"/>,
and respecting <paramref name="samplingKeyColumn"/> if provided.
Then evaluate each sub-model against <paramref name="labelColumn"/> and return metrics.
</summary>
<param name="data">The data to run cross-validation on.</param>
<param name="estimator">The estimator to fit.</param>
<param name="numFolds">Number of cross-validation folds.</param>
<param name="labelColumn">The label column (for evaluation).</param>
<param name="samplingKeyColumn">Name of a column to use for grouping rows. If two examples share the same value of the <paramref name="samplingKeyColumn"/>,
they are guaranteed to appear in the same subset (train or test). This can be used to ensure no label leakage from the train to the test set.
If <see langword="null"/> no row grouping will be performed.</param>
<param name="seed">Seed for the random number generator used to select rows for cross-validation folds.</param>
<returns>Per-fold results: metrics, models, scored datasets.</returns>
</member>
<member name="T:Microsoft.ML.RankingCatalog">
<summary>
The central catalog for ranking tasks and trainers.
</summary>
</member>
<member name="P:Microsoft.ML.RankingCatalog.Trainers">
<summary>
The list of trainers for performing regression.
</summary>
</member>
<member name="M:Microsoft.ML.RankingCatalog.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Evaluates scored ranking data.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="groupId">The name of the groupId column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<returns>The evaluation results for these calibrated outputs.</returns>
</member>
<member name="T:Microsoft.ML.AnomalyDetectionCatalog">
<summary>
The central catalog for anomaly detection tasks and trainers.
</summary>
</member>
<member name="P:Microsoft.ML.AnomalyDetectionCatalog.Trainers">
<summary>
The list of trainers for anomaly detection.
</summary>
</member>
<member name="M:Microsoft.ML.AnomalyDetectionCatalog.Evaluate(Microsoft.Data.DataView.IDataView,System.String,System.String,System.String,System.Int32)">
<summary>
Evaluates scored anomaly detection data.
</summary>
<param name="data">The scored data.</param>
<param name="label">The name of the label column in <paramref name="data"/>.</param>
<param name="score">The name of the score column in <paramref name="data"/>.</param>
<param name="predictedLabel">The name of the predicted label column in <paramref name="data"/>.</param>
<param name="k">The number of false positives to compute the <see cref="P:Microsoft.ML.Data.AnomalyDetectionMetrics.DrAtK"/> metric. </param>
<returns>Evaluation results.</returns>
</member>
<member name="T:Microsoft.ML.Trainers.TrainerEstimatorBase`2">
<summary>
This represents a basic class for 'simple trainer'.
A 'simple trainer' accepts one feature column and one label column, also optionally a weight column.
It produces a 'prediction transformer'.
</summary>
</member>
<member name="F:Microsoft.ML.Trainers.TrainerEstimatorBase`2.NoTrainingInstancesMessage">
<summary>
A standard string to use in errors or warnings by subclasses, to communicate the idea that no valid
instances were able to be found.
</summary>
</member>
<member name="F:Microsoft.ML.Trainers.TrainerEstimatorBase`2.FeatureColumn">
<summary>
The feature column that the trainer expects.
</summary>
</member>
<member name="F:Microsoft.ML.Trainers.TrainerEstimatorBase`2.LabelColumn">
<summary>
The label column that the trainer expects. Can be <c>null</c>, which indicates that label
is not used for training.
</summary>
</member>
<member name="F:Microsoft.ML.Trainers.TrainerEstimatorBase`2.WeightColumn">
<summary>
The weight column that the trainer expects. Can be <c>null</c>, which indicates that weight is
not used for training.
</summary>
</member>
<member name="P:Microsoft.ML.Trainers.TrainerEstimatorBase`2.Info">
<summary>
The information about the trainer: whether it benefits from normalization, caching etc.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerEstimatorBase`2.Fit(Microsoft.Data.DataView.IDataView)">
<summary> Trains and returns a <see cref="T:Microsoft.ML.ITransformer"/>.</summary>
<remarks>
Derived class can overload this function.
For example, it could take an additional dataset to train with a separate validation set.
</remarks>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerEstimatorBase`2.GetOutputColumnsCore(Microsoft.ML.SchemaShape)">
<summary>
The columns that will be created by the fitted transformer.
</summary>
</member>
<member name="T:Microsoft.ML.Trainers.TrainerEstimatorBaseWithGroupId`2">
<summary>
This represents a basic class for 'simple trainer'.
A 'simple trainer' accepts one feature column and one label column, also optionally a weight column.
It produces a 'prediction transformer'.
</summary>
</member>
<member name="F:Microsoft.ML.Trainers.TrainerEstimatorBaseWithGroupId`2.GroupIdColumn">
<summary>
The optional groupID column that the ranking trainers expects.
</summary>
</member>
<member name="T:Microsoft.ML.Trainers.CursOpt">
<summary>
Options for creating a <see cref="T:Microsoft.ML.Trainers.TrainingCursorBase"/> from a <see cref="T:Microsoft.ML.Data.RoleMappedData"/> with specified standard columns active.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.CheckFeatureFloatVector(Microsoft.ML.Data.RoleMappedData)">
<summary>
Check for a standard (known-length vector of float) feature column.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.CheckFeatureFloatVector(Microsoft.ML.Data.RoleMappedData,System.Int32@)">
<summary>
Check for a standard (known-length vector of float) feature column and determine its length.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.CheckBinaryLabel(Microsoft.ML.Data.RoleMappedData)">
<summary>
Check for a standard binary classification label.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.CheckRegressionLabel(Microsoft.ML.Data.RoleMappedData)">
<summary>
Check for a standard regression label.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.CheckMultiClassLabel(Microsoft.ML.Data.RoleMappedData,System.Int32@)">
<summary>
Check for a standard multi-class label and determine its cardinality. If the column is a
key type, it must have known cardinality. For other numeric types, this scans the data
to determine the cardinality.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.CheckMultiOutputRegressionLabel(Microsoft.ML.Data.RoleMappedData)">
<summary>
Check for a standard regression label.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.CreateRowCursor(Microsoft.ML.Data.RoleMappedData,Microsoft.ML.Trainers.CursOpt,System.Random,System.Collections.Generic.IEnumerable{System.Int32})">
<summary>
Create a row cursor for the RoleMappedData with the indicated standard columns active.
This does not verify that the columns exist, but merely activates the ones that do exist.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.CreateRowCursorSet(Microsoft.ML.Data.RoleMappedData,Microsoft.ML.Trainers.CursOpt,System.Int32,System.Random,System.Collections.Generic.IEnumerable{System.Int32})">
<summary>
Create a row cursor set for the <see cref="T:Microsoft.ML.Data.RoleMappedData"/> with the indicated standard columns active.
This does not verify that the columns exist, but merely activates the ones that do exist.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.GetFeatureFloatVectorGetter(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Get the getter for the feature column, assuming it is a vector of float.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.GetFeatureFloatVectorGetter(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Data.RoleMappedData)">
<summary>
Get the getter for the feature column, assuming it is a vector of float.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.GetLabelFloatGetter(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Get a getter for the label as a float. This assumes that the label column type
has already been validated as appropriate for the kind of training being done.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.GetLabelFloatGetter(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Data.RoleMappedData)">
<summary>
Get a getter for the label as a float. This assumes that the label column type
has already been validated as appropriate for the kind of training being done.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.GetOptWeightFloatGetter(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Get the getter for the weight column, or null if there is no weight column.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.GetOptGroupGetter(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Data.RoleMappedSchema)">
<summary>
Get the getter for the group column, or null if there is no group column.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.MakeBoolScalarLabel(System.String)">
<summary>
The <see cref="T:Microsoft.ML.SchemaShape.Column"/> for the label column for binary classification tasks.
</summary>
<param name="labelColumn">name of the label column</param>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.MakeR4ScalarColumn(System.String)">
<summary>
The <see cref="T:Microsoft.ML.SchemaShape.Column"/> for the float type columns.
</summary>
<param name="columnName">name of the column</param>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.MakeU4ScalarColumn(System.String)">
<summary>
The <see cref="T:Microsoft.ML.SchemaShape.Column"/> for the label column for regression tasks.
</summary>
<param name="columnName">name of the weight column</param>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.MakeR4VecFeature(System.String)">
<summary>
The <see cref="T:Microsoft.ML.SchemaShape.Column"/> for the feature column.
</summary>
<param name="featureColumn">name of the feature column</param>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.MakeR4ScalarWeightColumn(System.String)">
<summary>
The <see cref="T:Microsoft.ML.SchemaShape.Column"/> for the weight column.
</summary>
<param name="weightColumn">name of the weight column</param>
</member>
<member name="T:Microsoft.ML.Trainers.TrainerUtils.TrainerEstimatorToTrainerShim`2">
<summary>
This is a shim class to translate the more contemporaneous <see cref="T:Microsoft.ML.Trainers.ITrainerEstimator`2"/>
style transformers into the older now disfavored <see cref="T:Microsoft.ML.ITrainer`1"/> idiom, for components that still
need to operate via that older mechanism. (Mostly command line invocations, and so on.).
</summary>
<typeparam name="TModel">The type of the new model parameters.</typeparam>
<typeparam name="TPredictor">The type corresponding to the legacy predictor.</typeparam>
</member>
<member name="M:Microsoft.ML.Trainers.TrainerUtils.MapTrainerEstimatorToTrainer``3(Microsoft.ML.IHostEnvironment,``0)">
<summary>
This is a shim for legacy code that takes the more modern <see cref="T:Microsoft.ML.Trainers.ITrainerEstimator`2"/>
interface, and maps it to the legacy code that wants an <see cref="T:Microsoft.ML.ITrainer`1"/>. The goal should be to
remove reliance on that interface if possible, but this may not be practical in the immediate term, so for the benefit
of scenarios like this we have this convenience function.
</summary>
<typeparam name="T">The trainer estimator type.</typeparam>
<typeparam name="TModel">The type of the model produced by the estimator.</typeparam>
<typeparam name="TPredictor">The type of the predictor to be produced by the predictor.</typeparam>
<param name="env">The host environment.</param>
<param name="trainer">The trainer estimator.</param>
<returns>An implementation of the legacy trainer interface.</returns>
</member>
<member name="T:Microsoft.ML.Trainers.TrainingCursorBase">
<summary>
This is the base class for a data cursor. Data cursors are specially typed
"convenience" cursor-like objects, less general than a <see cref="T:Microsoft.Data.DataView.DataViewRowCursor"/> but
more convenient for common access patterns that occur in machine learning. For
example, the common idiom of iterating over features/labels/weights while skipping
"bad" features, labels, and weights. There will be two typical access patterns for
users of the cursor. The first is just creation of the cursor using a constructor;
this is best for one-off accesses of the data. The second access pattern, best for
repeated accesses, is to use a cursor factory (usually a nested class of the cursor
class). This keeps track of what filtering options were actually useful.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainingCursorBase.#ctor(Microsoft.Data.DataView.DataViewRowCursor,System.Action{Microsoft.ML.Trainers.CursOpt})">
<summary>
The base constructor class for the factory-based cursor creation.
</summary>
<param name="input"></param>
<param name="signal">This method is called </param>
</member>
<member name="M:Microsoft.ML.Trainers.TrainingCursorBase.CursoringCompleteFlags">
<summary>
This method is called by <see cref="M:Microsoft.ML.Trainers.TrainingCursorBase.MoveNext"/> in the event we have reached the end
of the cursoring. The intended usage is that it returns what flags will be passed to the signal
delegate of the cursor, indicating what additional options should be specified on subsequent
passes over the data. The base implementation checks if any rows were skipped, and if none were
skipped, it signals the context that it needn't bother with any filtering checks.
Because the result will be "or"-red, a perfectly acceptable implementation is that this
return the default <see cref="T:Microsoft.ML.Trainers.CursOpt"/>, in which case the flags will not ever change.
If the cursor was created with a signal delegate, the return value of this method will be sent
to that delegate.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainingCursorBase.MoveNext">
<summary>
Calls Cursor.MoveNext() and this.Accept() repeatedly until this.Accept() returns true.
Returns false if Cursor.MoveNext() returns false. If you call Cursor.MoveNext() directly,
also call this.Accept() to fetch the values of the current row. Note that if this.Accept()
returns false, it's possible that not all values were fetched.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainingCursorBase.Accept">
<summary>
This fetches and validates values for the standard active columns.
It is called automatically by MoveNext(). Client code should only need
to deal with this if it calls MoveNext() or MoveMany() on the underlying
IRowCursor directly. That is, this is only for very advanced scenarios.
</summary>
</member>
<member name="T:Microsoft.ML.Trainers.TrainingCursorBase.FactoryBase`1">
<summary>
This is the base class for a data cursor factory. The factory is a reusable object,
created with data and cursor options. From external non-implementing users it will
appear to be more or less stateless, but internally it is keeping track of what sorts
of filtering it needs to perform. For example, if we construct the factory with the
option that it needs to filter out rows with bad feature values, but on the first
iteration it is revealed there are no bad feature values, then it would be a complete
waste of time to check on subsequent iterations over the data whether there are bad
feature values again.
</summary>
</member>
<member name="M:Microsoft.ML.Trainers.TrainingCursorBase.FactoryBase`1.Create(System.Random,System.Int32[])">
<summary>
The typed analog to <see cref="M:Microsoft.Data.DataView.IDataView.GetRowCursor(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column},System.Random)"/>.
</summary>
<param name="rand">Non-null if we are requesting a shuffled cursor.</param>
<param name="extraCols">The extra columns to activate on the row cursor
in addition to those required by the factory's options.</param>
<returns>The wrapping typed cursor.</returns>
</member>
<member name="M:Microsoft.ML.Trainers.TrainingCursorBase.FactoryBase`1.CreateSet(System.Int32,System.Random,System.Int32[])">
<summary>
The typed analog to <see cref="M:Microsoft.Data.DataView.IDataView.GetRowCursorSet(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column},System.Int32,System.Random)"/>, this provides a
partitioned cursoring of the data set, appropriate to multithreaded algorithms
that want to consume parallel cursors without any consolidation.
</summary>
<param name="n">Suggested degree of parallelism.</param>
<param name="rand">Non-null if we are requesting a shuffled cursor.</param>
<param name="extraCols">The extra columns to activate on the row cursor
in addition to those required by the factory's options.</param>
<returns>The cursor set. Note that this needn't necessarily be of size
<paramref name="n"/>.</returns>
</member>
<member name="M:Microsoft.ML.Trainers.TrainingCursorBase.FactoryBase`1.CreateCursorCore(Microsoft.Data.DataView.DataViewRowCursor,Microsoft.ML.Data.RoleMappedData,Microsoft.ML.Trainers.CursOpt,System.Action{Microsoft.ML.Trainers.CursOpt})">
<summary>
Called by both the <see cref="M:Microsoft.ML.Trainers.TrainingCursorBase.FactoryBase`1.Create(System.Random,System.Int32[])"/> and <see cref="M:Microsoft.ML.Trainers.TrainingCursorBase.FactoryBase`1.CreateSet(System.Int32,System.Random,System.Int32[])"/> factory methods. Implementors
should instantiate the particular wrapping cursor.
</summary>
<param name="input">The row cursor we will wrap.</param>
<param name="data">The data from which the row cursor was instantiated.</param>
<param name="opt">The cursor options this row cursor was created with.</param>
<param name="signal">The action that our wrapping cursor will call. Implementors of the cursor
do not usually call it directly, but instead override
<see cref="M:Microsoft.ML.Trainers.TrainingCursorBase.CursoringCompleteFlags"/>, whose return value is used to call
this action.</param>
<returns></returns>
</member>
<member name="T:Microsoft.ML.Trainers.TrainingCursorBase.FactoryBase`1.AndAccumulator">
<summary>
Accumulates signals from cursors, anding them together. Once it has
all of the information it needs to signal the factory itself, it will
do so.
</summary>
</member>
<member name="T:Microsoft.ML.Trainers.StandardScalarCursor">
<summary>
This supports Weight (float), Group (ulong), and Id (RowId) columns.
</summary>
</member>
<member name="T:Microsoft.ML.Trainers.FeatureFloatVectorCursor">
<summary>
This derives from <see cref="T:Microsoft.ML.Trainers.StandardScalarCursor"/> and adds the feature column
as a <see cref="T:Microsoft.ML.Data.VBuffer`1"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Trainers.FloatLabelCursor">
<summary>
This derives from the FeatureFloatVectorCursor and adds the Label (float) column.
</summary>
</member>
<member name="T:Microsoft.ML.Trainers.MultiClassLabelCursor">
<summary>
This derives from the FeatureFloatVectorCursor and adds the Label (int) column,
enforcing multi-class semantics.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.BootstrapSamplingTransformer">
<summary>
This class approximates bootstrap sampling of a dataview.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.BootstrapSamplingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Boolean,System.Nullable{System.UInt32},System.Boolean,System.Int32)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.BootstrapSamplingTransformer"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>. This is the output from previous transform or loader.</param>
<param name="complement">Whether this is the out-of-bag sample, that is, all those rows that are not selected by the transform.</param>
<param name="seed">The random seed. If unspecified random state will be instead derived from the environment.</param>
<param name="shuffleInput">Whether we should attempt to shuffle the source data. By default on, but can be turned off for efficiency.</param>
<param name="poolSize">When shuffling the output, the number of output rows to keep in that pool. Note that shuffling of output is completely distinct from shuffling of input.</param>
</member>
<member name="T:Microsoft.ML.Transforms.BootstrapSample">
<summary>
Entry point methods for bootstrap sampling.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ColumnConcatenatingEstimator">
<summary>
Concatenates columns in an <see cref="T:Microsoft.Data.DataView.IDataView"/> into one single column. Estimator for the <see cref="T:Microsoft.ML.Data.ColumnConcatenatingTransformer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnConcatenatingEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String[])">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.ColumnConcatenatingEstimator"/>
</summary>
<param name="env">The local instance of <see cref="T:Microsoft.ML.IHostEnvironment"/>.</param>
<param name="outputColumnName">The name of the resulting column.</param>
<param name="inputColumnNames">The columns to concatenate into one single column.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnConcatenatingEstimator.Fit(Microsoft.Data.DataView.IDataView)">
<summary>
Trains and returns a <see cref="T:Microsoft.ML.Data.ColumnConcatenatingTransformer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnConcatenatingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ColumnCopyingEstimator">
<summary>
<see cref="T:Microsoft.ML.Transforms.ColumnCopyingEstimator"/> copies the input column to another column named as specified in the parameters of the transformation.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnCopyingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.ColumnCopyingTransformer.Columns">
<summary>
Names of output and input column pairs on which the transformation is applied.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ColumnSelectingEstimator">
<summary>
The ColumnSelectingEstimator supports selection of specified columns to keep from a given input.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String[])">
<summary>
Constructs the Select Columns Estimator.
</summary>
<param name="env">Instance of the host environment.</param>
<param name="keepColumns">The array of column names to keep.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String[],System.String[],System.Boolean,System.Boolean)">
<summary>
Constructs the Select Columns Estimator.
</summary>
<param name="env">Instance of the host environment.</param>
<param name="keepColumns">The array of column names to keep, cannot be set with <paramref name="dropColumns"/>.</param>
<param name="dropColumns">The array of column names to drop, cannot be set with <paramref name="keepColumns"/>.</param>
<param name="keepHidden">If true will keep hidden columns and false will remove hidden columns. The argument is
ignored if the Estimator is in "drop mode".</param>
<param name="ignoreMissing">If false will check for any columns given in <paramref name="keepColumns"/>
or <paramref name="dropColumns"/> that are missing from the input. If a missing colums exists a
SchemaMistmatch exception is thrown. If true, the check is not made.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingEstimator.KeepColumns(Microsoft.ML.IHostEnvironment,System.String[])">
<summary>
KeepColumns is used to select a list of columns that the user wants to keep on a given an input. Any column not specified
will be dropped from the output output schema.
</summary>
<param name="env">Instance of the host environment.</param>
<param name="columnsToKeep">The array of column names to keep.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingEstimator.DropColumns(Microsoft.ML.IHostEnvironment,System.String[])">
<summary>
DropColumns is used to select a list of columns that user wants to drop from a given input. Any column not specified will
be maintained in the output schema.
</summary>
<param name="env">Instance of the host environment.</param>
<param name="columnsToDrop">The array of column names to drop.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ColumnSelectingTransformer">
<summary>
The <see cref="T:Microsoft.ML.Transforms.ColumnSelectingTransformer"/> allows the user to specify columns to drop or keep from a given input.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingTransformer.CheckModelVersion(Microsoft.ML.ModelLoadContext,Microsoft.ML.VersionInfo)">
<summary>
Helper function to determine the model version that is being loaded.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingTransformer.LoadDropColumnsTransform(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView)">
<summary>
Back-compatibilty function that handles loading the DropColumns Transform.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ColumnSelectingTransformer.HiddenColumnOption">
<summary>
Back-compatibilty that is handling the HiddenColumnOption from ChooseColumns.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingTransformer.GetHiddenOption(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.ColumnSelectingTransformer.HiddenColumnOption)">
<summary>
Backwards compatibility helper function to convert the HiddenColumnOption to a boolean.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingTransformer.LoadChooseColumnsTransform(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView)">
<summary>
Backwards compatibility helper function that loads a Choose Column Transform.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingTransformer.GetOutputSchema(Microsoft.Data.DataView.DataViewSchema)">
<summary>
Schema propagation for transformers.
Returns the output schema of the data, if the input schema is like the one provided.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingTransformer.Microsoft#ML#ITransformer#GetRowToRowMapper(Microsoft.Data.DataView.DataViewSchema)">
<summary>
Constructs a row-to-row mapper based on an input schema. If <see cref="P:Microsoft.ML.ITransformer.IsRowToRowMapper"/>
is <c>false</c>, then an exception is thrown. If the input schema is in any way
unsuitable for constructing the mapper, an exception should likewise be thrown.
</summary>
<param name="inputSchema">The input schema for which we should get the mapper.</param>
<returns>The row to row mapper.</returns>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingTransformer.Transform(Microsoft.Data.DataView.IDataView)">
<summary>
Take the data in, make transformations, output the data.
Note that <see cref="T:Microsoft.Data.DataView.IDataView"/>'s are lazy, so no actual transformations happen here, just schema validation.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ColumnSelectingTransformer.SelectColumnsDataTransform.Microsoft#ML#Data#IRowToRowMapper#GetDependencies(System.Collections.Generic.IEnumerable{Microsoft.Data.DataView.DataViewSchema.Column})">
<summary>
Given a set of columns, return the input columns that are needed to generate those output columns.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.FeatureContributionCalculatingTransformer">
<summary>
The FeatureContributionCalculationTransformer computes model-specific per-feature contributions to the score of each example.
See the list of currently supported models below.
</summary>
<remarks>
<para>
Scoring a dataset with a trained model produces a score, or prediction, for each example. To understand and explain these predictions
it can be useful to inspect which features influenced them most significantly. FeatureContributionCalculationTransformer computes a model-specific
list of per-feature contributions to the score for each example. These contributions can be positive (they make the score higher) or negative
(they make the score lower).
</para>
<para>
Feature Contribution Calculation is currently supported for the following models:
Regression:
OrdinaryLeastSquares, StochasticDualCoordinateAscent (SDCA), OnlineGradientDescent, PoissonRegression,
GeneralizedAdditiveModels (GAM), LightGbm, FastTree, FastForest, FastTreeTweedie
Binary Classification:
AveragedPerceptron, LinearSupportVectorMachines, LogisticRegression, StochasticDualCoordinateAscent (SDCA),
StochasticGradientDescent (SGD), SymbolicStochasticGradientDescent, GeneralizedAdditiveModels (GAM),
FastForest, FastTree, LightGbm
Ranking:
FastTree, LightGbm
</para>
<para>
For linear models, the contribution of a given feature is equal to the product of feature value times the corresponding weight. Similarly,
for Generalized Additive Models (GAM), the contribution of a feature is equal to the shape function for the given feature evaluated at
the feature value.
</para>
<para>
For tree-based models, the calculation of feature contribution essentially consists in determining which splits in the tree have the most impact
on the final score and assigning the value of the impact to the features determining the split. More precisely, the contribution of a feature
is equal to the change in score produced by exploring the opposite sub-tree every time a decision node for the given feature is encountered.
Consider a simple case with a single decision tree that has a decision node for the binary feature F1. Given an example that has feature F1
equal to true, we can calculate the score it would have obtained if we chose the subtree corresponding to the feature F1 being equal to false
while keeping the other features constant. The contribution of feature F1 for the given example is the difference between the original score
and the score obtained by taking the opposite decision at the node corresponding to feature F1. This algorithm extends naturally to models with
many decision trees.
</para>
<para>
See the sample below for an example of how to compute feature importance using the FeatureContributionCalculatingTransformer.
</para>
</remarks>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.Transforms.FeatureContributionCalculatingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Model.ICalculateFeatureContribution,System.String,System.Int32,System.Int32,System.Boolean)">
<summary>
Feature Contribution Calculation computes model-specific contribution scores for each feature.
Note that this functionality is not supported by all the models. See <see cref="T:Microsoft.ML.Transforms.FeatureContributionCalculatingTransformer"/> for a list of the suported models.
</summary>
<param name="env">The environment to use.</param>
<param name="modelParameters">Trained model parameters that support Feature Contribution Calculation and which will be used for scoring.</param>
<param name="featureColumn">The name of the feature column that will be used as input.</param>
<param name="numPositiveContributions">The number of positive contributions to report, sorted from highest magnitude to lowest magnitude.
Note that if there are fewer features with positive contributions than <paramref name="numPositiveContributions"/>, the rest will be returned as zeros.</param>
<param name="numNegativeContributions">The number of negative contributions to report, sorted from highest magnitude to lowest magnitude.
Note that if there are fewer features with negative contributions than <paramref name="numNegativeContributions"/>, the rest will be returned as zeros.</param>
<param name="normalize">Whether the feature contributions should be normalized to the [-1, 1] interval.</param>
</member>
<member name="T:Microsoft.ML.Transforms.FeatureContributionCalculatingEstimator">
<summary>
Estimator producing a FeatureContributionCalculatingTransformer which scores the model on an input dataset and
computes model-specific contribution scores for each feature.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.FeatureContributionCalculatingEstimator.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Model.ICalculateFeatureContribution,System.String,System.Int32,System.Int32,System.Boolean)">
<summary>
Feature Contribution Calculation computes model-specific contribution scores for each feature.
Note that this functionality is not supported by all the models. See <see cref="T:Microsoft.ML.Transforms.FeatureContributionCalculatingTransformer"/> for a list of the suported models.
</summary>
<param name="env">The environment to use.</param>
<param name="modelParameters">Trained model parameters that support Feature Contribution Calculation and which will be used for scoring.</param>
<param name="featureColumn">The name of the feature column that will be used as input.</param>
<param name="numPositiveContributions">The number of positive contributions to report, sorted from highest magnitude to lowest magnitude.
Note that if there are fewer features with positive contributions than <paramref name="numPositiveContributions"/>, the rest will be returned as zeros.</param>
<param name="numNegativeContributions">The number of negative contributions to report, sorted from highest magnitude to lowest magnitude.
Note that if there are fewer features with negative contributions than <paramref name="numNegativeContributions"/>, the rest will be returned as zeros.</param>
<param name="normalize">Whether the feature contributions should be normalized to the [-1, 1] interval.</param>
</member>
<member name="M:Microsoft.ML.Transforms.FeatureContributionCalculatingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.GenerateNumberTransform">
<summary>
This transform adds columns containing either random numbers distributed
uniformly between 0 and 1 or an auto-incremented integer starting at zero.
It will be used in conjunction with a filter transform to create random
partitions of the data, used in cross validation.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.GenerateNumberTransform.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.String,System.Nullable{System.UInt32},System.Boolean)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.GenerateNumberTransform"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>. This is the output from previous transform or loader.</param>
<param name="name">Name of the output column.</param>
<param name="seed">Seed to start random number generator.</param>
<param name="useCounter">Use an auto-incremented integer starting at zero instead of a random number.</param>
</member>
<member name="M:Microsoft.ML.Transforms.GenerateNumberTransform.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.GenerateNumberTransform.Options,Microsoft.Data.DataView.IDataView)">
<summary>
Public constructor corresponding to SignatureDataTransform.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.HashingTransformer">
<summary>
This transformer can hash either single valued columns or vector columns. For vector columns,
it hashes each slot separately.
It can hash either text values or key values.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.HashingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.HashingEstimator.ColumnOptions[])">
<summary>
Constructor for case where you don't need to 'train' transform on data, for example, InvertHash for all columns set to zero.
</summary>
<param name="env">Host Environment.</param>
<param name="columns">Description of dataset columns and how to process them.</param>
</member>
<member name="T:Microsoft.ML.Transforms.HashingTransformer.IHasher`1">
<summary>
The usage of this interface may seem a bit strange, but it is deliberately structured in this way.
One will note all implementors of this interface are structs, and that where used, you never use
the interface itself, but instead an implementing type. This is due to how .NET and the JIT handles
generic types that are also value types. For value types, it will actually generate new assembly
code, which will allow effectively code generation in a way that would not happen if the hasher
implementor was a class, or if the hasher implementation was just passed in with a delegate, or
the hashing logic was encapsulated as the abstract method of some class.
In a prior time, there were methods for all possible combinations of types, scalarness, vector
sparsity/density, whether the hash was sparsity preserving or not, whether it was ordered or not.
This resulted in an explosion of methods that made the hash transform code somewhat hard to maintain.
On the other hand, the methods were fast, since they were effectively (by brute enumeration) completely
inlined, so introducing any levels of abstraction would slow things down. By doing things in this
fashion using generics over struct types, we are effectively (via the JIT) doing code generation so
things are inlined and just as fast as the explicit implementation, while making the code rather
easier to maintain.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.HashingTransformer.InvertHashHelper.Create(Microsoft.Data.DataView.DataViewRow,Microsoft.ML.Transforms.HashingEstimator.ColumnOptions,System.Int32,System.Delegate)">
<summary>
Constructs an <see cref="T:Microsoft.ML.Transforms.HashingTransformer.InvertHashHelper"/> instance to accumulate hash/value pairs
from a single column as parameterized by this transform, with values fetched from
the row.
</summary>
<param name="row">The input source row, from which the hashed values can be fetched</param>
<param name="ex">The extra column info</param>
<param name="invertHashMaxCount">The number of input hashed valuPres to accumulate per output hash value</param>
<param name="dstGetter">A hash getter, built on top of <paramref name="row"/>.</param>
</member>
<member name="M:Microsoft.ML.Transforms.HashingTransformer.InvertHashHelper.Process">
<summary>
This calculates the hash/value pair from the current value of the column, and does
appropriate processing of them to build the invert hash map.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.HashingEstimator">
<summary>
Estimator for <see cref="T:Microsoft.ML.Transforms.HashingTransformer"/> which can hash either single valued columns or vector columns. For vector columns,
it hashes each slot separately. It can hash either text values or key values.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions">
<summary>
Describes how the transformer handles one column pair.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Name">
<summary>
Name of the column resulting from the transformation of <see cref="F:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.InputColumnName"/>.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.InputColumnName">
<summary> Name of column to transform.</summary>
</member>
<member name="F:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.HashBits">
<summary> Number of bits to hash into. Must be between 1 and 31, inclusive.</summary>
</member>
<member name="F:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Seed">
<summary> Hashing seed.</summary>
</member>
<member name="F:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Ordered">
<summary> Whether the position of each term should be included in the hash.</summary>
</member>
<member name="F:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.InvertHash">
<summary>
During hashing we constuct mappings between original values and the produced hash values.
Text representation of original values are stored in the slot names of the metadata for the new column.Hashing, as such, can map many initial values to one.
<see cref="F:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.InvertHash"/> specifies the upper bound of the number of distinct input values mapping to a hash that should be retained.
<value>0</value> does not retain any input values. <value>-1</value> retains all input values mapping to each hash.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.#ctor(System.String,System.String,System.Int32,System.UInt32,System.Boolean,System.Int32)">
<summary>
Describes how the transformer handles one column pair.
</summary>
<param name="name">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="name"/> will be used as source.</param>
<param name="hashBits">Number of bits to hash into. Must be between 1 and 31, inclusive.</param>
<param name="seed">Hashing seed.</param>
<param name="ordered">Whether the position of each term should be included in the hash.</param>
<param name="invertHash">During hashing we constuct mappings between original values and the produced hash values.
Text representation of original values are stored in the slot names of the metadata for the new column.Hashing, as such, can map many initial values to one.
<paramref name="invertHash"/> specifies the upper bound of the number of distinct input values mapping to a hash that should be retained.
<value>0</value> does not retain any input values. <value>-1</value> retains all input values mapping to each hash.</param>
</member>
<member name="M:Microsoft.ML.Transforms.HashingEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String,System.Int32,System.Int32)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.HashingEstimator"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform.
If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="hashBits">Number of bits to hash into. Must be between 1 and 31, inclusive.</param>
<param name="invertHash">During hashing we constuct mappings between original values and the produced hash values.
Text representation of original values are stored in the slot names of the metadata for the new column.Hashing, as such, can map many initial values to one.
<paramref name="invertHash"/> specifies the upper bound of the number of distinct input values mapping to a hash that should be retained.
<value>0</value> does not retain any input values. <value>-1</value> retains all input values mapping to each hash.</param>
</member>
<member name="M:Microsoft.ML.Transforms.HashingEstimator.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.HashingEstimator.ColumnOptions[])">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.HashingEstimator"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="columns">Description of dataset columns and how to process them.</param>
</member>
<member name="M:Microsoft.ML.Transforms.HashingEstimator.Fit(Microsoft.Data.DataView.IDataView)">
<summary>
Trains and returns a <see cref="T:Microsoft.ML.Transforms.HashingTransformer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.HashingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.KeyToValueMappingTransformer">
<summary>
KeyToValueTransform utilizes KeyValues metadata to map key indices to the corresponding values in the KeyValues metadata.
Notes:
* Output columns utilize the KeyValues metadata.
* Maps zero values of the key type to the NA of the output type.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToValueMappingTransformer.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String)">
<summary>
Create a <see cref="T:Microsoft.ML.Transforms.KeyToValueMappingTransformer"/> that takes and transforms one column.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToValueMappingTransformer.#ctor(Microsoft.ML.IHostEnvironment,System.ValueTuple{System.String,System.String}[])">
<summary>
Create a <see cref="T:Microsoft.ML.Transforms.KeyToValueMappingTransformer"/> that takes multiple pairs of columns.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToValueMappingTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.KeyToValueMappingTransformer.Options,Microsoft.Data.DataView.IDataView)">
<summary>
Factory method for SignatureDataTransform.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToValueMappingTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext)">
<summary>
Factory method for SignatureLoadModel.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToValueMappingTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView)">
<summary>
Factory method for SignatureLoadDataTransform.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToValueMappingTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.DataViewSchema)">
<summary>
Factory method for SignatureLoadRowMapper.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.KeyToValueMappingTransformer.Mapper.KeyToValueMap">
<summary>
A map is an object capable of creating the association from an input type, to an output
type. This mapping is constructed from key metadata, with the input type being the key type
and the output type being the type specified by the key metadata.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.KeyToValueMappingTransformer.Mapper.KeyToValueMap.TypeOutput">
<summary>
The item type of the output type, that is, either the output type or,
if a vector, the item type of that type.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.KeyToValueMappingTransformer.Mapper.KeyToValueMap.InfoIndex">
<summary>
The column index in Infos.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.KeyToValueMappingTransformer.Mapper.KeyToValueMap.Parent">
<summary>
The parent transform.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToValueMappingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.KeyToVectorMappingTransformer">
<summary>
Converts the key types back to their original vectors.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToVectorMappingTransformer.Mapper.MakeGetterOne(Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
This is for the singleton case. This should be equivalent to both Bag and Ord over
a vector of size one.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToVectorMappingTransformer.Mapper.MakeGetterBag(Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
This is for the bagging case - vector input and outputs should be added.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToVectorMappingTransformer.Mapper.MakeGetterInd(Microsoft.Data.DataView.DataViewRow,System.Int32)">
<summary>
This is for the indicator (non-bagging) case - vector input and outputs should be concatenated.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.KeyToVectorMappingEstimator">
<summary>
Estimator for <see cref="T:Microsoft.ML.Transforms.KeyToVectorMappingTransformer"/>. Converts the key types back to their original vectors.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.KeyToVectorMappingEstimator.ColumnOptions">
<summary>
Describes how the transformer handles one column pair.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.KeyToVectorMappingEstimator.ColumnOptions.Name">
<summary> Name of the column resulting from the transformation of <cref see="InputColumnName"/>.</summary>
</member>
<member name="F:Microsoft.ML.Transforms.KeyToVectorMappingEstimator.ColumnOptions.InputColumnName">
<summary> Name of column to transform.</summary>
</member>
<member name="F:Microsoft.ML.Transforms.KeyToVectorMappingEstimator.ColumnOptions.Bag">
<summary>
Whether to combine multiple indicator vectors into a single bag vector instead of concatenating them.
This is only relevant when the input column is a vector.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToVectorMappingEstimator.ColumnOptions.#ctor(System.String,System.String,System.Boolean)">
<summary>
Describes how the transformer handles one column pair.
</summary>
<param name="name">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="name"/> will be used as source.</param>
<param name="bag">Whether to combine multiple indicator vectors into a single bag vector instead of concatenating them. This is only relevant when the input column is a vector.</param>
</member>
<member name="M:Microsoft.ML.Transforms.KeyToVectorMappingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.LabelConvertTransform.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.String,System.String)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.LabelConvertTransform"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>. This is the output from previous transform or loader.</param>
<param name="outputColumnName">Name of the output column.</param>
<param name="inputColumnName">Name of the input column. If this is null '<paramref name="outputColumnName"/>' will be used.</param>
</member>
<member name="M:Microsoft.ML.Transforms.LabelConvertTransform.PassThrough(System.String,System.Int32)">
<summary>
Returns whether metadata of the indicated kind should be passed through from the source column.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.LabelIndicatorTransform">
<summary>
Remaps multiclass labels to binary T,F labels, primarily for use with OVA.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.LabelIndicatorTransform.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Int32,System.String,System.String)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.LabelIndicatorTransform"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>. This is the output from previous transform or loader.</param>
<param name="classIndex">Label of the positive class.</param>
<param name="name">Name of the output column.</param>
<param name="source">Name of the input column. If this is null '<paramref name="name"/>' will be used.</param>
</member>
<member name="T:Microsoft.ML.Transforms.NAFilter">
<member name="NAFilter">
<summary>
Removes missing values from vector type columns.
</summary>
<remarks>
This transform removes the entire row if any of the input columns have a missing value in that row.
This preprocessing is required for many ML algorithms that cannot work with missing values.
Useful if any missing entry invalidates the entire row.
If the <see cref="P:Microsoft.ML.Transforms.MissingValuesRowDropper.Complement" /> is set to true, this transform would do the exact opposite,
it will keep only the rows that have missing values.
</remarks>
</member>
</member>
<member name="M:Microsoft.ML.Transforms.NAFilter.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Boolean,System.String[])">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.NAFilter"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>. This is the output from previous transform or loader.</param>
<param name="complement">If true, keep only rows that contain NA values, and filter the rest.</param>
<param name="columns">Name of the columns. Only these columns will be used to filter rows having 'NA' values.</param>
</member>
<member name="M:Microsoft.ML.Transforms.NAFilter.Cursor.TryGetColumnValueGetter``1(System.Int32,Microsoft.Data.DataView.ValueGetter{``0}@)">
<summary>
Gets the appropriate column value getter for a mapped column. If the column
is not mapped, this returns false with the out parameters getting default values.
If the column is mapped but the TValue is of the wrong type, an exception is
thrown.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.NormalizeTransform">
<summary>
The normalize transform for support of normalization via the <see cref="T:Microsoft.ML.Data.IDataTransform"/> mechanism.
More contemporaneous API usage of normalization ought to use <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator"/>
and <see cref="T:Microsoft.ML.Transforms.NormalizingTransformer"/> rather than this structure.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizeTransform.CreateMinMaxNormalizer(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.String,System.String)">
<summary>
A helper method to create a MinMax normalizer.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>. This is the output from previous transform or loader.</param>
<param name="outputColumnName">Name of the output column.</param>
<param name="inputColumnName">Name of the column to be transformed. If this is null '<paramref name="outputColumnName"/>' will be used.</param>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizeTransform.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.NormalizeTransform.MinMaxArguments,Microsoft.Data.DataView.IDataView)">
<summary>
Factory method corresponding to SignatureDataTransform.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizeTransform.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.NormalizeTransform.LogMeanVarArguments,Microsoft.Data.DataView.IDataView)">
<summary>
Factory method corresponding to SignatureDataTransform.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizeTransform.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.NormalizeTransform.BinArguments,Microsoft.Data.DataView.IDataView)">
<summary>
Factory method corresponding to SignatureDataTransform.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.MinMaxDblAggregator">
<summary>
Base class for tracking min and max values for a vector valued column.
It tracks min, max, number of non-sparse values (vCount) and number of ProcessValue() calls (trainCount).
NaNs are ignored when updating min and max.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.MeanVarDblAggregator">
<summary>
Class for computing the mean and variance for a vector valued column.
It tracks the current mean and the M2 (sum of squared diffs of the values from the mean),
the number of NaNs and the number of non-zero elements.
Uses the algorithm described here: https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Online_algorithm
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.MinMaxSngAggregator">
<summary>
Base class for tracking min and max values for a vector valued column.
It tracks min, max, number of non-sparse values (vCount) and number of ProcessValue() calls (trainCount).
NaNs are ignored when updating min and max.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.MeanVarSngAggregator">
<summary>
Class for computing the mean and variance for a vector valued column.
It tracks the current mean and the M2 (sum of squared diffs of the values from the mean),
the number of NaNs and the number of non-zero elements.
Uses the algorithm described here: https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Online_algorithm
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode.MinMax">
<summary>
Linear rescale such that minimum and maximum values are mapped between -1 and 1.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode.MeanVariance">
<summary>
Rescale to unit variance and, optionally, zero mean.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode.LogMeanVariance">
<summary>
Rescale to unit variance on the log scale.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode.Binning">
<summary>
Bucketize and then rescale to between -1 and 1.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode.SupervisedBinning">
<summary>
Bucketize and then rescale to between -1 and 1. Calculates bins based on correlation with the Label column.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizingEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String,Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform.
If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="mode">The <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode"/> indicating how to the old values are mapped to the new values.</param>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizingEstimator.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode,System.ValueTuple{System.String,System.String}[])">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator"/>.
</summary>
<param name="env">The private instance of <see cref="T:Microsoft.ML.IHostEnvironment"/>.</param>
<param name="mode">The <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode"/> indicating how to the old values are mapped to the new values.</param>
<param name="columns">An array of (outputColumnName, inputColumnName) tuples.</param>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizingEstimator.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.NormalizingEstimator.ColumnOptionsBase[])">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator"/>.
</summary>
<param name="env">The private instance of the <see cref="T:Microsoft.ML.IHostEnvironment"/>.</param>
<param name="columns">An array of <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator.ColumnOptionsBase"/> defining the inputs to the Normalizer, and their settings.</param>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizingEstimator.Fit(Microsoft.Data.DataView.IDataView)">
<summary>
Trains and returns a <see cref="T:Microsoft.ML.Transforms.NormalizingTransformer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.NormalizingTransformer.ColumnFunctions">
<summary>An accessor of the column functions within <see cref="F:Microsoft.ML.Transforms.NormalizingTransformer.Columns"/>.</summary>
</member>
<member name="T:Microsoft.ML.Transforms.NormalizingTransformer.NormalizerModelParametersBase">
<summary>
Base class for all the NormalizerData classes: <see cref="T:Microsoft.ML.Transforms.NormalizingTransformer.AffineNormalizerModelParameters`1"/>,
<see cref="T:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1"/>, <see cref="T:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1"/>.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.NormalizingTransformer.AffineNormalizerModelParameters`1">
<summary>
The model parameters generated by affine normalization transformations.
</summary>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="P:Microsoft.ML.Transforms.NormalizingTransformer.AffineNormalizerModelParameters`1.Scale">
<summary>
The scales. In the scalar case, this is a single value. In the vector case this is of length equal
to the number of slots. Function is <c>(input - offset) * scale</c>.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.NormalizingTransformer.AffineNormalizerModelParameters`1.Offset">
<summary>
The offsets. In the scalar case, this is a single value. In the vector case this is of length equal
to the number of slots, or of length zero if all the offsets are zero.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizingTransformer.AffineNormalizerModelParameters`1.#ctor(`0,`0)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.NormalizingTransformer.AffineNormalizerModelParameters`1"/>
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1">
<summary>
The model parameters generated by cumulative distribution normalization transformations.
The cumulative density function is parameterized by <see cref="P:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1.Mean"/> and
the <see cref="P:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1.Stddev"/> as observed during fitting.
</summary>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="P:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1.Mean">
<summary>
The mean(s). In the scalar case, this is a single value. In the vector case this is of length equal
to the number of slots.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1.Stddev">
<summary>
The standard deviation(s). In the scalar case, this is a single value. In the vector case this is of
length equal to the number of slots.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1.UseLog">
<summary>
Whether the we ought to apply a logarithm to the input first.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1.#ctor(`0,`0,System.Boolean)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.NormalizingTransformer.CdfNormalizerModelParameters`1"/>
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1">
<summary>
The model parameters generated by buckettizing the data into bins with monotonically
increasing <see cref="P:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1.UpperBounds"/>.
The <see cref="P:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1.Density"/> value is constant from bin to bin, for most cases.
/// </summary>
</member>
<member name="P:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1.UpperBounds">
<summary>
The standard deviation(s). In the scalar case, these are the bin upper bounds for that single value.
In the vector case it is a jagged array of the bin upper bounds for all slots.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1.Density">
<summary>
The frequency of the datapoints per each bin.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1.Offset">
<summary>
If normalization is performed with <see cref="F:Microsoft.ML.Transforms.NormalizeTransform.FixZeroArgumentsBase.FixZero"/> set to <value>true</value>,
the offset indicates the displacement of zero, if any.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1.#ctor(System.Collections.Immutable.ImmutableArray{`0},`0,`0)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.NormalizingTransformer.BinNormalizerModelParameters`1"/>
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.RangeFilter">
<summary>
Filters a dataview on a column of type Single, Double or Key (contiguous).
Keeps the values that are in the specified min/max range. NaNs are always filtered out.
If the input is a Key type, the min/max are considered percentages of the number of values.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.RangeFilter.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.String,System.Double,System.Double,System.Boolean)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.RangeFilter"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>. This is the output from previous transform or loader.</param>
<param name="column">Name of the input column.</param>
<param name="lowerBound">Minimum value (0 to 1 for key types).</param>
<param name="upperBound">Maximum value (0 to 1 for key types).</param>
<param name="includeUpperBound">Whether to include the upper bound.</param>
</member>
<member name="T:Microsoft.ML.Transforms.RowShufflingTransformer">
<summary>
This is a transformer that, given any input dataview (even an unshufflable one) will,
when we construct a randomized cursor attempt to perform a rude version of shuffling
using a pool. A pool of a given number of rows will be constructed from the first
rows in the input cursor, and then, successively, the output cursor will yield one
of these rows and replace it with another row from the input.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.RowShufflingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.Int32,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.RowShufflingTransformer"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>. This is the output from previous transform or loader.</param>
<param name="poolRows">The pool will have this many rows</param>
<param name="poolOnly">If true, the transform will not attempt to shuffle the input cursor but only shuffle based on the pool. This parameter has no effect if the input data was not itself shufflable.</param>
<param name="forceShuffle">If true, the transform will always provide a shuffled view.</param>
</member>
<member name="M:Microsoft.ML.Transforms.RowShufflingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.RowShufflingTransformer.Options,Microsoft.Data.DataView.IDataView)">
<summary>
Constructor corresponding to SignatureDataTransform.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.RowShufflingTransformer.SelectCachableColumns(Microsoft.Data.DataView.IDataView,Microsoft.ML.IHostEnvironment)">
<summary>
Since shuffling requires serving up items potentially out of order we need to know
how to save and then copy out values that we read. This transform knows how to save
and copy out only primitive and vector valued columns, but nothing else, so any
other columns are dropped.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.RowShufflingTransformer.CanShuffleAll(Microsoft.Data.DataView.DataViewSchema)">
<summary>
Utility to check whether all types in an input schema are shufflable.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.RowShufflingTransformer.GetShuffledCursor(Microsoft.ML.IChannelProvider,System.Int32,Microsoft.Data.DataView.DataViewRowCursor,System.Random)">
<summary>
Utility to take a cursor, and get a shuffled version of this cursor.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.RowShufflingTransformer.Cursor">
<summary>
This describes the row cursor. Let's imagine we instantiated our shuffle transform
over a pool of size P. Logically, externally, the cursor acts as if you have this pool
P and whenever you randomly sample and yield a row from it, that row is then discarded
and replaced with the next row from the input source cursor.
It would also be possible to implement in a way that cleaves closely to this logical
interpretation, but this would be inefficient. We instead have a buffer of larger size
P+B. A consumer (running presumably in the main thread) sampling and fetching items and a
producer (running in a task, which may be running in a different thread) filling the buffer
with items to sample, utilizing this extra space to enable an efficient possibly
multithreaded scheme.
The consumer, for its part, at any given time "owns" a contiguous portion of this buffer.
(A contiguous portion of this buffer we consider to be able to wrap around, from the end
to the beginning. The buffer is accessed in a "circular" fashion.) Consider that this portion
is broken into three distinct regions: there is a sort of middle "sampling" region
(usually of size P but possibly smaller when we've reached the end of the input and so are
running out of rows to sample), a region before this sampling region composed of already
sampled "dead" rows, and a "presampling" region after this sampling region composed of
rows ready to be sampled in future iterations, but that we are not sampling yet (in order
to behave equivalently to the simple logical model of at any given time sampling P items).
The producer owns the complement of the portion owned by the consumer.
As the cursor progresses, the producer fills in successive items in its portion of the
buffer it owns, and passes them off to the consumer (not one item at a time, but rather in
batches, to keep down the amount of intertask communication). The consumer in addition to
taking ownership of these items, will also periodically pass dead items back to the producer
(again, not one dead item at a time, but in batches when the number of dead items reaches
a certain threshold).
This communication is accomplished using a pair of BufferBlock instances, through which
the producer and consumer are notified how many additional items they can take ownership
of.
As the consumer "selects" a row from the pool of selectable rows each time it moves to
the next row, this randomly selected row is considered to be the "first" index, since this
makes its subsequent transition to being a dead row much simpler. It would be inefficient to
swap all the values in each column's buffer to accomplish this to make the selected row
first, of course, so one rather swaps an index, so that these nicely behavior contiguous
circular indices, get mapped in an index within the buffers, through a permutation maintained
in the pipeIndices array.
The result is something functionally equivalent to but but considerably faster than the
simple implementation described in the first paragraph.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.RowShufflingTransformer.Cursor.ExtraIndex">
<summary>
Pipes, in addition to column values, will also communicate extra information
enumerated within this. This enum serves the purpose of providing nice readable
indices to these "extra" information in pipes.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.RowShufflingTransformer.Cursor.ShufflePipe">
<summary>
There is one of these created per active column plus any extra info, and is a mechanism
through which the producer is able to ingest and store this data from the source cursor,
and the consumer able to fetch data stored at particular indices.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.RowShufflingTransformer.Cursor.ShufflePipe.Create(System.Int32,Microsoft.Data.DataView.DataViewType,System.Delegate)">
<summary>
Creates a shuffle pipe, given a value getter.
</summary>
<param name="bufferSize">The size of the internal array.</param>
<param name="type">The column type, which determines what type of pipe is created</param>
<param name="getter">A getter that should be a value getter corresponding to the
column type</param>
<returns>An appropriate <see cref="T:Microsoft.ML.Transforms.RowShufflingTransformer.Cursor.ShufflePipe`1"/></returns>
</member>
<member name="M:Microsoft.ML.Transforms.RowShufflingTransformer.Cursor.ShufflePipe.Fill(System.Int32)">
<summary>
Reads the cursor column's current value, and store it in the indicated index,
in the internal array.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.RowShufflingTransformer.Cursor.ShufflePipe`1.Fetch(System.Int32,`0@)">
<summary>
Copies the values stored at an index through a previous <see cref="M:Microsoft.ML.Transforms.RowShufflingTransformer.Cursor.ShufflePipe`1.Fill(System.Int32)"/> method,
call to a value.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.SkipTakeFilter">
<summary>
Allows limiting input to a subset of row at an optional offset. Can be used to implement data paging.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.SkipTakeFilter.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.SkipTakeFilter.SkipOptions,Microsoft.Data.DataView.IDataView)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.SkipTakeFilter"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="options">Options for the skip operation.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>.</param>
</member>
<member name="M:Microsoft.ML.Transforms.SkipTakeFilter.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.SkipTakeFilter.TakeOptions,Microsoft.Data.DataView.IDataView)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.SkipTakeFilter"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="options">Options for the take operation.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>.</param>
</member>
<member name="M:Microsoft.ML.Transforms.SkipTakeFilter.Create(Microsoft.ML.IHostEnvironment,Microsoft.ML.ModelLoadContext,Microsoft.Data.DataView.IDataView)">
<summary>Creates instance of class from context.</summary>
</member>
<member name="M:Microsoft.ML.Transforms.SkipTakeFilter.SaveModel(Microsoft.ML.ModelSaveContext)">
<summary>Saves class data to context</summary>
</member>
<member name="P:Microsoft.ML.Transforms.SkipTakeFilter.CanShuffle">
<summary>
This filter can not shuffle
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.SkipTakeFilter.GetRowCount">
<summary>
Returns the computed count of rows remaining after skip and take operation.
Returns null if count is unknown.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.SkipTakeFilter.Cursor.Batch">
<summary>
SkipTakeFilter does not support cursor sets, so this can always be zero.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.SlotsDroppingTransformer">
<summary>
Transform to drop slots from columns. If the column is scalar, the only slot that can be dropped is slot 0.
If all the slots are to be dropped, a vector valued column will be changed to a vector of length 1 (a scalar column will retain its type) and
the value will be the default value.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.SlotsDroppingTransformer.Range.IsValid">
<summary>
Returns true if the range is valid.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.SlotsDroppingTransformer.ColumnOptions">
<summary>
Describes how the transformer handles one input-output column pair.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.SlotsDroppingTransformer.ColumnOptions.#ctor(System.String,System.String,System.ValueTuple{System.Int32,System.Nullable{System.Int32}}[])">
<summary>
Describes how the transformer handles one input-output column pair.
</summary>
<param name="name">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform.
If set to <see langword="null"/>, the value of the <paramref name="name"/> will be used as source.</param>
<param name="slots">Ranges of indices in the input column to be dropped. Setting max in <paramref name="slots"/> to null sets max to int.MaxValue.</param>
</member>
<member name="M:Microsoft.ML.Transforms.SlotsDroppingTransformer.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String,System.Int32,System.Nullable{System.Int32})">
<summary>
Initializes a new <see cref="T:Microsoft.ML.Transforms.SlotsDroppingTransformer"/> object.
</summary>
<param name="env">The environment to use.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="min">Specifies the lower bound of the range of slots to be dropped. The lower bound is inclusive. </param>
<param name="max">Specifies the upper bound of the range of slots to be dropped. The upper bound is exclusive.</param>
</member>
<member name="M:Microsoft.ML.Transforms.SlotsDroppingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.SlotsDroppingTransformer.ColumnOptions[])">
<summary>
Initializes a new <see cref="T:Microsoft.ML.Transforms.SlotsDroppingTransformer"/> object.
</summary>
<param name="env">The environment to use.</param>
<param name="columns">Specifies the ranges of slots to drop for each column pair.</param>
</member>
<member name="M:Microsoft.ML.Transforms.SlotsDroppingTransformer.Mapper.IsValidColumnType(Microsoft.Data.DataView.DataViewType)">
<summary>
Both scalars and vectors are acceptable types, but the item type must have a default value which means it must be
a string, a key, a float or a double.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.SlotsDroppingTransformer.Mapper.ComputeType(Microsoft.Data.DataView.DataViewSchema,System.Int32,Microsoft.ML.Internal.Internallearn.SlotDropper,System.Boolean@,Microsoft.Data.DataView.DataViewType@,System.Int32[]@)">
<summary>
Computes the types (column and slotnames), the length reduction, categorical feature indices
and whether the column is suppressed.
The slotsMin and slotsMax arrays should be sorted and the intervals should not overlap.
</summary>
<param name="input">The input schema</param>
<param name="iinfo">The column index in Infos</param>
<param name="slotDropper">The slots to be dropped.</param>
<param name="suppressed">Whether the column is suppressed (all slots dropped)</param>
<param name="type">The column type</param>
<param name="categoricalRanges">Categorical feature indices.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ScoringTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.String,System.String,System.String)">
<summary>
Convenience method for creating <see cref="T:Microsoft.ML.Transforms.ScoringTransformer"/>.
The <see cref="T:Microsoft.ML.Transforms.ScoringTransformer"/> allows for model stacking (i.e. to combine information from multiple predictive models to generate a new model)
in the pipeline by using the scores from an already trained model.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>.</param>
<param name="inputModelFile">The model file.</param>
<param name="featureColumn">Role name for the features.</param>
<param name="groupColumn">Role name for the group column.</param>
</member>
<member name="M:Microsoft.ML.Transforms.TrainAndScoreTransformer.Create(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,Microsoft.ML.ITrainer,System.String,System.String,System.String)">
<summary>
Convenience method for creating <see cref="T:Microsoft.ML.Transforms.TrainAndScoreTransformer"/>.
The <see cref="T:Microsoft.ML.Transforms.TrainAndScoreTransformer"/> allows for model stacking (i.e. to combine information from multiple predictive models to generate a new model)
in the pipeline by training a model first and then using the scores from the trained model.
Unlike <see cref="T:Microsoft.ML.Transforms.ScoringTransformer"/>, the <see cref="T:Microsoft.ML.Transforms.TrainAndScoreTransformer"/> trains the model on the fly as name indicates.
</summary>
<param name="env">Host Environment.</param>
<param name="input">Input <see cref="T:Microsoft.Data.DataView.IDataView"/>.</param>
<param name="trainer">The <see cref="T:Microsoft.ML.ITrainer"/> object i.e. the learning algorithm that will be used for training the model.</param>
<param name="featureColumn">Role name for features.</param>
<param name="labelColumn">Role name for label.</param>
<param name="groupColumn">Role name for the group column.</param>
</member>
<member name="T:Microsoft.ML.Transforms.TypeConvertingTransformer">
<summary>
<see cref="T:Microsoft.ML.Transforms.TypeConvertingTransformer"/> converts underlying column types.
The source and destination column types need to be compatible.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.TypeConvertingTransformer.Columns">
<summary>
A collection of <see cref="T:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions"/> describing the settings of the transformation.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.TypeConvertingTransformer.#ctor(Microsoft.ML.IHostEnvironment,System.String,Microsoft.ML.Data.DataKind,System.String,Microsoft.ML.Data.KeyCount)">
<summary>
Convinence constructor for simple one column case.
</summary>
<param name="env">Host Environment.</param>
<param name="outputColumnName">Name of the output column.</param>
<param name="inputColumnName">Name of the column to be transformed. If this is null '<paramref name="outputColumnName"/>' will be used.</param>
<param name="outputKind">The expected type of the converted column.</param>
<param name="outputKeyCount">New key count if we work with key type.</param>
</member>
<member name="M:Microsoft.ML.Transforms.TypeConvertingTransformer.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions[])">
<summary>
Create a <see cref="T:Microsoft.ML.Transforms.TypeConvertingTransformer"/> that takes multiple pairs of columns.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.TypeConvertingEstimator">
<summary>
<see cref="T:Microsoft.ML.Transforms.TypeConvertingEstimator"/> converts underlying column types.
The source and destination column types need to be compatible.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions">
<summary>
Describes how the transformer handles one column pair.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions.Name">
<summary>
Name of the column resulting from the transformation of <see cref="F:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions.InputColumnName"/>.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions.InputColumnName">
<summary>
Name of column to transform. If set to <see langword="null"/>, the value of the <see cref="F:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions.Name"/> will be used as source.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions.OutputKind">
<summary>
The expected kind of the converted column.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions.OutputKeyCount">
<summary>
New key count, if we work with key type.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions.#ctor(System.String,Microsoft.ML.Data.DataKind,System.String,Microsoft.ML.Data.KeyCount)">
<summary>
Describes how the transformer handles one column pair.
</summary>
<param name="name">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="outputKind">The expected kind of the converted column.</param>
<param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="name"/> will be used as source.</param>
<param name="outputKeyCount">New key count, if we work with key type.</param>
</member>
<member name="M:Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions.#ctor(System.String,System.Type,System.String,Microsoft.ML.Data.KeyCount)">
<summary>
Describes how the transformer handles one column pair.
</summary>
<param name="name">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="type">The expected kind of the converted column.</param>
<param name="inputColumnName">Name of column to transform. If set to <see langword="null"/>, the value of the <paramref name="name"/> will be used as source.</param>
<param name="outputKeyCount">New key count, if we work with key type.</param>
</member>
<member name="M:Microsoft.ML.Transforms.TypeConvertingEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String,Microsoft.ML.Data.DataKind)">
<summary>
Convinence constructor for simple one column case.
</summary>
<param name="env">Host Environment.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="outputKind">The expected kind of the converted column.</param>
</member>
<member name="M:Microsoft.ML.Transforms.TypeConvertingEstimator.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions[])">
<summary>
Create a <see cref="T:Microsoft.ML.Transforms.TypeConvertingEstimator"/> that takes multiple pairs of columns.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.TypeConvertingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueMappingEstimator">
<summary>
The ValueMappingEstimator is a 1-1 mapping from a key to value.
</summary><remarks>
Given a set of keys and values, the ValueMappingEstimator builds up a dictionary so that when given a specific key it will return a
specific value. The ValueMappingEstimator supports keys and values of different <see cref="T:System.Type" /> to support different data types.
Examples for using a ValueMappingEstimator are:
<list type="bullet">
<item>
<description>Converting a string value to a string value, this can be useful for grouping (i.e. 'cat', 'dog', 'horse' maps to 'mammals')</description>
</item>
<item>
<description>Converting a string value to a integer value (i.e. converting the text description like quality to an numeric where 'good' maps to 1, 'poor' maps to 0</description>
</item>
<item>
<description>
Converting a integer value to a string value and have the string value represented as a <see cref="T:Microsoft.ML.Data.KeyType" />
(i.e. convert zip codes to a state string value, which will generate a unique integer value that can be used as a label.
</description>
</item>
</list>
Values can be repeated to allow for multiple keys to map to the same value, however keys can not be repeated. The mapping between keys and values
can be specified either through lists, where the key list and value list must be the same size or can be done through an <see cref="T:Microsoft.Data.DataView.IDataView" />.
</remarks>
</member>
<member name="M:Microsoft.ML.Transforms.ValueMappingEstimator.#ctor(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.IDataView,System.String,System.String,System.ValueTuple{System.String,System.String}[])">
<summary>
Constructs the ValueMappingEstimator, key type -> value type mapping
</summary>
<param name="env">The environment to use.</param>
<param name="lookupMap">An instance of <see cref="T:Microsoft.Data.DataView.IDataView"/> that contains the key and value columns.</param>
<param name="keyColumn">Name of the key column in <paramref name="lookupMap"/>.</param>
<param name="valueColumn">Name of the value column in <paramref name="lookupMap"/>.</param>
<param name="columns">The list of names of the input columns to apply the transformation, and the name of the resulting column.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueMappingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueMappingEstimator`2">
<summary>
The ValueMappingEstimator is a 1-1 mapping from a key to value.
</summary><remarks>
Given a set of keys and values, the ValueMappingEstimator builds up a dictionary so that when given a specific key it will return a
specific value. The ValueMappingEstimator supports keys and values of different <see cref="T:System.Type" /> to support different data types.
Examples for using a ValueMappingEstimator are:
<list type="bullet">
<item>
<description>Converting a string value to a string value, this can be useful for grouping (i.e. 'cat', 'dog', 'horse' maps to 'mammals')</description>
</item>
<item>
<description>Converting a string value to a integer value (i.e. converting the text description like quality to an numeric where 'good' maps to 1, 'poor' maps to 0</description>
</item>
<item>
<description>
Converting a integer value to a string value and have the string value represented as a <see cref="T:Microsoft.ML.Data.KeyType" />
(i.e. convert zip codes to a state string value, which will generate a unique integer value that can be used as a label.
</description>
</item>
</list>
Values can be repeated to allow for multiple keys to map to the same value, however keys can not be repeated. The mapping between keys and values
can be specified either through lists, where the key list and value list must be the same size or can be done through an <see cref="T:Microsoft.Data.DataView.IDataView" />.
</remarks>
<typeparam name="TKey">Specifies the key type.</typeparam>
<typeparam name="TValue">Specifies the value type.</typeparam>
</member>
<member name="M:Microsoft.ML.Transforms.ValueMappingEstimator`2.#ctor(Microsoft.ML.IHostEnvironment,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.ValueTuple{System.String,System.String}[])">
<summary>
Constructs the ValueMappingEstimator, key type -> value type mapping
</summary>
<param name="env">The environment to use.</param>
<param name="keys">The list of keys of TKey.</param>
<param name="values">The list of values of TValue.</param>
<param name="columns">The list of columns to apply.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueMappingEstimator`2.#ctor(Microsoft.ML.IHostEnvironment,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Boolean,System.ValueTuple{System.String,System.String}[])">
<summary>
Constructs the ValueMappingEstimator, key type -> value type mapping
</summary>
<param name="env">The environment to use.</param>
<param name="keys">The list of keys of TKey.</param>
<param name="values">The list of values of TValue.</param>
<param name="treatValuesAsKeyType">Specifies to treat the values as a <see cref="T:Microsoft.ML.Data.KeyType"/>.</param>
<param name="columns">The list of columns to apply.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueMappingEstimator`2.#ctor(Microsoft.ML.IHostEnvironment,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1[]},System.ValueTuple{System.String,System.String}[])">
<summary>
Constructs the ValueMappingEstimator, key type -> value array type mapping
</summary>
<param name="env">The environment to use.</param>
<param name="keys">The list of keys of TKey.</param>
<param name="values">The list of values of TValue[].</param>
<param name="columns">The list of columns to apply.</param>
</member>
<member name="T:Microsoft.ML.Transforms.DataViewHelper">
<summary>
The DataViewHelper provides a set of static functions to create a DataView given a list of keys and values.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.DataViewHelper.GetPrimitiveType(System.Type,System.Boolean@)">
<summary>
Helper function to retrieve the Primitie type given a Type
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.DataViewHelper.GetKeyValueGetter``1(``0[])">
<summary>
Helper function for a reverse lookup given value. This is used for generating the metadata of the value column.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.DataViewHelper.AddColumnWrapper``1(Microsoft.ML.Data.ArrayDataViewBuilder,System.String,Microsoft.Data.DataView.PrimitiveDataViewType,``0[])">
<summary>
Helper function to add a column to an ArrayDataViewBuilder. This handles the case if the type is a string.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.DataViewHelper.AddColumnWrapper``1(Microsoft.ML.Data.ArrayDataViewBuilder,System.String,Microsoft.Data.DataView.PrimitiveDataViewType,``0[][])">
<summary>
Helper function to add a column to an ArrayDataViewBuilder. This handles the case if the type is an array of strings.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.DataViewHelper.CreateDataView``2(Microsoft.ML.IHostEnvironment,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``1[]},System.String,System.String)">
<summary>
Helper function to create an IDataView given a list of key and vector-based values
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.DataViewHelper.CreateDataView``2(Microsoft.ML.IHostEnvironment,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``1},System.String,System.String,System.Boolean)">
<summary>
Helper function that builds the IDataView given a list of keys and non-vector values
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueMappingTransformer">
<summary>
The ValueMappingEstimator is a 1-1 mapping from a key to value.
</summary><remarks>
Given a set of keys and values, the ValueMappingEstimator builds up a dictionary so that when given a specific key it will return a
specific value. The ValueMappingEstimator supports keys and values of different <see cref="T:System.Type" /> to support different data types.
Examples for using a ValueMappingEstimator are:
<list type="bullet">
<item>
<description>Converting a string value to a string value, this can be useful for grouping (i.e. 'cat', 'dog', 'horse' maps to 'mammals')</description>
</item>
<item>
<description>Converting a string value to a integer value (i.e. converting the text description like quality to an numeric where 'good' maps to 1, 'poor' maps to 0</description>
</item>
<item>
<description>
Converting a integer value to a string value and have the string value represented as a <see cref="T:Microsoft.ML.Data.KeyType" />
(i.e. convert zip codes to a state string value, which will generate a unique integer value that can be used as a label.
</description>
</item>
</list>
Values can be repeated to allow for multiple keys to map to the same value, however keys can not be repeated. The mapping between keys and values
can be specified either through lists, where the key list and value list must be the same size or can be done through an <see cref="T:Microsoft.Data.DataView.IDataView" />.
</remarks>
</member>
<member name="M:Microsoft.ML.Transforms.ValueMappingTransformer.CheckModelVersion(Microsoft.ML.ModelLoadContext,Microsoft.ML.VersionInfo)">
<summary>
Helper function to determine the model version that is being loaded.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueMappingTransformer.ValueMap">
<summary>
Base class that contains the mapping of keys to values.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueMappingTransformer.ValueMap`2">
<summary>
Implementation mapping class that maps a key of TKey to a specified value of TValue.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueMappingTransformer.ValueMap`2.Train(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.DataViewRowCursor)">
<summary>
Generates the mapping based on the IDataView
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueMappingTransformer.GetBytesFromDataView(Microsoft.ML.IHost,Microsoft.Data.DataView.IDataView,System.String,System.String)">
<summary>
Retrieves the byte array given a dataview and columns
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingEstimator">
<summary>
Converts input values (words, numbers, etc.) to index in a dictionary.
</summary><remarks>
The ValueToKeyMappingEstimator builds up term vocabularies (dictionaries).
If multiple columns are used, each column builds/uses exactly one vocabulary.
The output columns are KeyType-valued.
The Key value is the one-based index of the item in the dictionary.
If the key is not found in the dictionary, it is assigned the missing value indicator.
This dictionary mapping values to keys is most commonly learnt from the unique values in input data,
but can be defined through other means: either with the mapping defined directly on the command line, or as loaded from an external file.
</remarks>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder">
<summary>
Controls how the order of the output keys.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.ColumnOptions">
<summary>
Describes how the transformer handles one column pair.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.ColumnOptions.#ctor(System.String,System.String,System.Int32,Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder,System.String[],System.Boolean)">
<summary>
Describes how the transformer handles one column pair.
</summary>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="maxNumKeys">Maximum number of keys to keep per column when auto-training.</param>
<param name="sort">How items should be ordered when vectorized. If <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder.Occurrence"/> choosen they will be in the order encountered.
If <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder.Value"/>, items are sorted according to their default comparison, for example, text sorting will be case sensitive (for example, 'A' then 'Z' then 'a').</param>
<param name="term">List of terms.</param>
<param name="textKeyValues">Whether key value metadata should be text, regardless of the actual input type.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.#ctor(Microsoft.ML.IHostEnvironment,System.String,System.String,System.Int32,Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingEstimator"/>.
</summary>
<param name="env">Host Environment.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="maxNumKeys">Maximum number of keys to keep per column when auto-training.</param>
<param name="sort">How items should be ordered when vectorized. If <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder.Occurrence"/> choosen they will be in the order encountered.
If <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder.Value"/>, items are sorted according to their default comparison, for example, text sorting will be case sensitive (for example, 'A' then 'Z' then 'a').</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.Fit(Microsoft.Data.DataView.IDataView)">
<summary>
Trains and returns a <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.GetOutputSchema(Microsoft.ML.SchemaShape)">
<summary>
Returns the <see cref="T:Microsoft.ML.SchemaShape"/> of the schema which will be produced by the transformer.
Used for schema propagation and verification in a pipeline.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.KeyValueOrder.Occurence">
<summary>
Terms will be assigned ID in the order in which they appear.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.KeyValueOrder.Value">
<summary>
Terms will be assigned ID according to their sort via an ordinal comparison for the type.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer">
<summary>
Converts input values (words, numbers, etc.) to index in a dictionary.
</summary><remarks>
The TextToKeyConverter transform builds up term vocabularies (dictionaries).
The TextToKeyConverter and the <see cref="T:Microsoft.ML.Transforms.HashConverter" /> are the two one primary mechanisms by which raw input is transformed into keys.
If multiple columns are used, each column builds/uses exactly one vocabulary.
The output columns are KeyType-valued.
The Key value is the one-based index of the item in the dictionary.
If the key is not found in the dictionary, it is assigned the missing value indicator.
This dictionary mapping values to keys is most commonly learnt from the unique values in input data,
but can be defined through other means: either with the mapping defined directly on the command line, or as loaded from an external file.
</remarks><seealso cref="T:Microsoft.ML.Transforms.HashConverter" /><seealso cref="T:Microsoft.ML.Transforms.KeyToTextConverter" />
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.GetKeyDataViewOrNull(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,System.String,System.String,Microsoft.ML.IComponentFactory{Microsoft.ML.Data.IMultiStreamSource,Microsoft.ML.Data.ILegacyDataLoader},System.Boolean@)">
<summary>
Returns a single-column <see cref="T:Microsoft.Data.DataView.IDataView"/>, based on values from <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Options"/>,
in the case where <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.ArgumentsBase.DataFile"/> is set. If that is not set, this will
return <see langword="null"/>.
</summary>
<param name="env">The host environment.</param>
<param name="ch">The host channel to use to mark exceptions and log messages.</param>
<param name="file">The name of the file. Must be specified if this method is called.</param>
<param name="termsColumn">The single column to select out of this transform. If not specified,
this method will attempt to guess.</param>
<param name="loaderFactory">The loader creator. If <see langword="null"/> we will attempt to determine
this </param>
<param name="autoConvert">Whether we should try to convert to the desired type by ourselves when doing
the term map. This will not be true in the case that the loader was adequately specified automatically.</param>
<returns>The single-column data containing the term data from the file.</returns>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.CreateTermMapFromData(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.Data.DataView.IDataView,System.Boolean,Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder)">
<summary>
Utility method to create the file-based <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap"/>.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Train(Microsoft.ML.IHostEnvironment,Microsoft.ML.IChannel,Microsoft.ML.Transforms.ValueToKeyMappingTransformer.ColInfo[],Microsoft.Data.DataView.IDataView,Microsoft.ML.Transforms.ValueToKeyMappingEstimator.ColumnOptions[],Microsoft.Data.DataView.IDataView,System.Boolean)">
<summary>
This builds the <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap"/> instances per column.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder">
<summary>
These are objects shared by both the scalar and vector implementations of <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Trainer"/>
to accumulate individual scalar objects, and facilitate the creation of a <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap"/>.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder.ItemType">
<summary>
The item type we are building into a term map.
</summary>
</member>
<member name="P:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder.Count">
<summary>
The number of items that would be in the map if created right now.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder.Finish">
<summary>
Called at the end of training, to get the final mapper object.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder.ParseAddTermArg(System.ReadOnlyMemory{System.Char}@,Microsoft.ML.IChannel)">
<summary>
Handling for the "terms" arg.
</summary>
<param name="terms">The input terms argument</param>
<param name="ch">The channel against which to report errors and warnings</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder.ParseAddTermArg(System.String[],Microsoft.ML.IChannel)">
<summary>
Handling for the "term" arg.
</summary>
<param name="terms">The input terms argument</param>
<param name="ch">The channel against which to report errors and warnings</param>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder.Impl`1">
<summary>
The sorted builder outputs things so that the keys are in sorted order.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder.Impl`1.#ctor(Microsoft.Data.DataView.PrimitiveDataViewType,Microsoft.ML.Data.InPredicate{`0},System.Boolean)">
<summary>
Instantiates.
</summary>
<param name="type">The type we are mapping</param>
<param name="mapsToMissing">This indicates whether a given value will map
to the missing value. If this returns true for a value then we do not attempt
to store it in the map.</param>
<param name="sort">Indicates whether to sort mapping IDs by input values.</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder`1.TryAdd(`0@)">
<summary>
Ensures that the item is in the set. Returns true iff it added the item.
</summary>
<param name="val">The value to consider</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder`1.ParseAddTermArg(System.ReadOnlyMemory{System.Char}@,Microsoft.ML.IChannel)">
<summary>
Handling for the "terms" arg.
</summary>
<param name="terms">The input terms argument</param>
<param name="ch">The channel against which to report errors and warnings</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder`1.ParseAddTermArg(System.String[],Microsoft.ML.IChannel)">
<summary>
Handling for the "term" arg.
</summary>
<param name="terms">The input terms argument</param>
<param name="ch">The channel against which to report errors and warnings</param>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Trainer">
<summary>
The trainer is an object that given an <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder"/> instance, maps a particular
input, whether it be scalar or vector, into this and allows us to continue training on it.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Trainer.Create(Microsoft.Data.DataView.DataViewRow,System.Int32,System.Boolean,System.Int32,Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder)">
<summary>
Creates an instance of <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Trainer"/> appropriate for the type at a given
row and column.
</summary>
<param name="row">The row to fetch from</param>
<param name="col">The column to get the getter from</param>
<param name="count">The maximum count of items to map</param>
<param name="autoConvert">Whether we attempt to automatically convert
the input type to the desired type</param>
<param name="bldr">The builder we add items to</param>
<returns>An associated training pipe</returns>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Trainer.ProcessRow">
<summary>
Indicates to the <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Trainer"/> that we have reached a new row and should consider
what to do with these values. Returns false if we have determined that it is no longer necessary
to call this train, because we've already accumulated the maximum number of values.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Trainer.Finish">
<summary>
Returns a <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap"/> over the items in this column. Note that even if this
was trained over a vector valued column, the particular implementation returned here
should be a mapper over the item type.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Bind(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.DataViewSchema,Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap,Microsoft.ML.Transforms.ValueToKeyMappingTransformer.ColInfo[],System.Boolean[],System.Int32)">
<summary>
Given this instance, bind it to a particular input column. This allows us to service
requests on the input dataset. This should throw an error if we attempt to bind this
to the wrong type of item.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap">
<summary>
A map is an object capable of creating the association from an input type, to an output
type. The input type, whatever it is, must have <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.ItemType"/> as its input item
type, and will produce either <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.OutputType"/>, or a vector type with that output
type if the input was a vector.
Note that instances of this class can be shared among multiple <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer"/>
instances. To associate this with a particular transform, use the <see cref="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Bind(Microsoft.ML.IHostEnvironment,Microsoft.Data.DataView.DataViewSchema,Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap,Microsoft.ML.Transforms.ValueToKeyMappingTransformer.ColInfo[],System.Boolean[],System.Int32)"/> method.
These are the immutable and serializable analogs to the <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.Builder"/> used in
training.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.ItemType">
<summary>
The item type of the input type, that is, either the input type or,
if a vector, the item type of that type.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.OutputType">
<summary>
The output item type. This will always be of known cardinality. Its count is always
equal to <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.Count"/>, unless <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.Count"/> is 0 in which case this has
key count of 1, since a count of 0 would indicate an unbound key. If we ever improve
key types so they are capable of distinguishing between the set they index being
empty vs. of unknown or unbound cardinality, this should change.
</summary>
</member>
<member name="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.Count">
<summary>
The number of items in the map.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.TextImpl.#ctor(Microsoft.ML.Internal.Utilities.NormStr.Pool)">
<summary>
A pool based text mapping implementation.
</summary>
<param name="pool">The string pool</param>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.BoundTermMap">
<summary>
A mapper bound to a particular transform, and a particular column. These wrap
a <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap"/>, and facilitate mapping that object to the inputs of
a particular column, providing both values and metadata.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.BoundTermMap.AddMetadata(Microsoft.Data.DataView.DataViewSchema.Annotations.Builder)">
<summary>
Allows us to optionally register metadata. It is also perfectly legal for
this to do nothing, which corresponds to there being no metadata.
</summary>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.BoundTermMap.WriteTextTerms(System.IO.TextWriter)">
<summary>
Writes out all terms we map to a text writer, with one line per mapped term.
The line should have the format mapped key value, then a tab, then the term
that is mapped. The writer should not be closed, as it will be used to write
all term maps. We should write <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.TermMap.Count"/> terms.
</summary>
<param name="writer">The writer to which we write terms</param>
</member>
<member name="M:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.BoundTermMap.Base`1.MapDefault(Microsoft.ML.Data.ValueMapper{`0,System.UInt32})">
<summary>
Returns what the default value maps to.
</summary>
</member>
<member name="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.BoundTermMap.KeyImpl`1">
<summary>
The key-typed version is the same as <see cref="T:Microsoft.ML.Transforms.ValueToKeyMappingTransformer.BoundTermMap.Impl`1"/>, except the metadata
is based off a subset of the key values metadata.
</summary>
</member>
<member name="T:Microsoft.ML.ConversionsExtensionsCatalog">
<summary>
Extensions for the HashEstimator.
</summary>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.Hash(Microsoft.ML.TransformsCatalog.ConversionTransforms,System.String,System.String,System.Int32,System.Int32)">
<summary>
Hashes the values in the input column.
</summary>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="hashBits">Number of bits to hash into. Must be between 1 and 31, inclusive.</param>
<param name="invertHash">During hashing we constuct mappings between original values and the produced hash values.
Text representation of original values are stored in the slot names of the metadata for the new column.Hashing, as such, can map many initial values to one.
<paramref name="invertHash"/> specifies the upper bound of the number of distinct input values mapping to a hash that should be retained.
<value>0</value> does not retain any input values. <value>-1</value> retains all input values mapping to each hash.</param>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.Hash(Microsoft.ML.TransformsCatalog.ConversionTransforms,Microsoft.ML.Transforms.HashingEstimator.ColumnOptions[])">
<summary>
Hashes the values in the input column.
</summary>
<param name="catalog">The transform's catalog.</param>
<param name="columns">Description of dataset columns and how to process them.</param>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.ConvertType(Microsoft.ML.TransformsCatalog.ConversionTransforms,System.String,System.String,Microsoft.ML.Data.DataKind)">
<summary>
Changes column type of the input column.
</summary>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="outputKind">The expected kind of the output column.</param>
<example>
<format type="text/markdown">
<]
]]></format>
</example>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.ConvertType(Microsoft.ML.TransformsCatalog.ConversionTransforms,Microsoft.ML.Transforms.TypeConvertingEstimator.ColumnOptions[])">
<summary>
Changes column type of the input column.
</summary>
<param name="catalog">The transform's catalog.</param>
<param name="columns">Description of dataset columns and how to process them.</param>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.MapKeyToValue(Microsoft.ML.TransformsCatalog.ConversionTransforms,System.String,System.String)">
<summary>
Convert the key types back to their original values.
</summary>
<param name="catalog">The categorical transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<example>
<format type="text/markdown">
<]
]]></format>
</example>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.MapKeyToValue(Microsoft.ML.TransformsCatalog.ConversionTransforms,Microsoft.ML.ColumnOptions[])">
<summary>
Convert the key types (name of the column specified in the first item of the tuple) back to their original values
(named as specified in the second item of the tuple).
</summary>
<param name="catalog">The categorical transform's catalog</param>
<param name="columns">The pairs of input and output columns.</param>
<example>
<format type="text/markdown">
<]
]]></format>
</example>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.MapKeyToVector(Microsoft.ML.TransformsCatalog.ConversionTransforms,Microsoft.ML.Transforms.KeyToVectorMappingEstimator.ColumnOptions[])">
<summary>
Convert the key types back to their original vectors.
</summary>
<param name="catalog">The categorical transform's catalog.</param>
<param name="columns">The input column to map back to vectors.</param>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.MapKeyToVector(Microsoft.ML.TransformsCatalog.ConversionTransforms,System.String,System.String,System.Boolean)">
<summary>
Convert the key types back to their original vectors.
</summary>
<param name="catalog">The categorical transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="bag">Whether bagging is used for the conversion. </param>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.MapValueToKey(Microsoft.ML.TransformsCatalog.ConversionTransforms,System.String,System.String,System.Int32,Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder)">
<summary>
Converts value types into <see cref="T:Microsoft.ML.Data.KeyType"/>.
</summary>
<param name="catalog">The categorical transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="maxNumKeys">Maximum number of keys to keep per column when auto-training.</param>
<param name="sort">How items should be ordered when vectorized. If <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder.Occurrence"/> choosen they will be in the order encountered.
If <see cref="F:Microsoft.ML.Transforms.ValueToKeyMappingEstimator.SortOrder.Value"/>, items are sorted according to their default comparison, for example, text sorting will be case sensitive (for example, 'A' then 'Z' then 'a').</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.MapValueToKey(Microsoft.ML.TransformsCatalog.ConversionTransforms,Microsoft.ML.Transforms.ValueToKeyMappingEstimator.ColumnOptions[],Microsoft.Data.DataView.IDataView)">
<summary>
Converts value types into <see cref="T:Microsoft.ML.Data.KeyType"/>, optionally loading the keys to use from <paramref name="keyData"/>.
</summary>
<param name="catalog">The categorical transform's catalog.</param>
<param name="columns">The data columns to map to keys.</param>
<param name="keyData">The data view containing the terms. If specified, this should be a single column data
view, and the key-values will be taken from that column. If unspecified, the key-values will be determined
from the input data upon fitting.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.ValueMap``2(Microsoft.ML.TransformsCatalog.ConversionTransforms,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``1},Microsoft.ML.ColumnOptions[])">
<summary>
<see cref="T:Microsoft.ML.Transforms.ValueMappingEstimator"/>
</summary>
<typeparam name="TInputType">The key type.</typeparam>
<typeparam name="TOutputType">The value type.</typeparam>
<param name="catalog">The categorical transform's catalog</param>
<param name="keys">The list of keys to use for the mapping. The mapping is 1-1 with <paramref name="values"/>. The length of this list must be the same length as <paramref name="values"/> and
cannot contain duplicate keys.</param>
<param name="values">The list of values to pair with the keys for the mapping. The length of this list must be equal to the same length as <paramref name="keys"/>.</param>
<param name="columns">The columns to apply this transform on.</param>
<returns>An instance of the <see cref="T:Microsoft.ML.Transforms.ValueMappingEstimator"/></returns>
<example>
<format type="text/markdown">
<]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingStringToKeyType.cs)]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingFloatToString.cs)]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingStringToArray.cs)]
]]></format>
</example>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.ValueMap``2(Microsoft.ML.TransformsCatalog.ConversionTransforms,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``1},System.Boolean,Microsoft.ML.ColumnOptions[])">
<summary>
<see cref="T:Microsoft.ML.Transforms.ValueMappingEstimator"/>
</summary>
<typeparam name="TInputType">The key type.</typeparam>
<typeparam name="TOutputType">The value type.</typeparam>
<param name="catalog">The categorical transform's catalog</param>
<param name="keys">The list of keys to use for the mapping. The mapping is 1-1 with <paramref name="values"/>. The length of this list must be the same length as <paramref name="values"/> and
cannot contain duplicate keys.</param>
<param name="values">The list of values to pair with the keys for the mapping. The length of this list must be equal to the same length as <paramref name="keys"/>.</param>
<param name="treatValuesAsKeyType">Whether to treat the values as a <see cref="T:Microsoft.ML.Data.KeyType"/>.</param>
<param name="columns">The columns to apply this transform on.</param>
<returns>An instance of the <see cref="T:Microsoft.ML.Transforms.ValueMappingEstimator"/></returns>
<example>
<format type="text/markdown">
<]
]]></format>
</example>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.ValueMap``2(Microsoft.ML.TransformsCatalog.ConversionTransforms,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``1[]},Microsoft.ML.ColumnOptions[])">
<summary>
<see cref="T:Microsoft.ML.Transforms.ValueMappingEstimator"/>
</summary>
<typeparam name="TInputType">The key type.</typeparam>
<typeparam name="TOutputType">The value type.</typeparam>
<param name="catalog">The categorical transform's catalog</param>
<param name="keys">The list of keys to use for the mapping. The mapping is 1-1 with <paramref name="values"/>. The length of this list must be the same length as <paramref name="values"/> and
cannot contain duplicate keys.</param>
<param name="values">The list of values to pair with the keys for the mapping of TOutputType[]. The length of this list must be equal to the same length as <paramref name="keys"/>.</param>
<param name="columns">The columns to apply this transform on.</param>
<returns>An instance of the <see cref="T:Microsoft.ML.Transforms.ValueMappingEstimator"/></returns>
<example>
<format type="text/markdown">
<]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingStringToKeyType.cs)]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingFloatToString.cs)]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingStringToArray.cs)]
]]></format>
</example>
</member>
<member name="M:Microsoft.ML.ConversionsExtensionsCatalog.ValueMap(Microsoft.ML.TransformsCatalog.ConversionTransforms,Microsoft.Data.DataView.IDataView,System.String,System.String,Microsoft.ML.ColumnOptions[])">
<summary>
<see cref="T:Microsoft.ML.Transforms.ValueMappingEstimator"/>
</summary>
<param name="catalog">The categorical transform's catalog</param>
<param name="lookupMap">An instance of <see cref="T:Microsoft.Data.DataView.IDataView"/> that contains the key and value columns.</param>
<param name="keyColumn">Name of the key column in <paramref name="lookupMap"/>.</param>
<param name="valueColumn">Name of the value column in <paramref name="lookupMap"/>.</param>
<param name="columns">The columns to apply this transform on.</param>
<returns>A instance of the ValueMappingEstimator</returns>
<example>
<format type="text/markdown">
<]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingStringToKeyType.cs)]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingFloatToString.cs)]
[!code-csharp[ValueMappingEstimator](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/ValueMappingStringToArray.cs)]
]]></format>
</example>
</member>
<member name="M:Microsoft.ML.ExplainabilityCatalog.FeatureContributionCalculation(Microsoft.ML.ModelOperationsCatalog.ExplainabilityTransforms,Microsoft.ML.Model.ICalculateFeatureContribution,System.String,System.Int32,System.Int32,System.Boolean)">
<summary>
Feature Contribution Calculation computes model-specific contribution scores for each feature.
Note that this functionality is not supported by all the models. See <see cref="T:Microsoft.ML.Transforms.FeatureContributionCalculatingTransformer"/> for a list of the suported models.
</summary>
<param name="catalog">The model explainability operations catalog.</param>
<param name="modelParameters">Trained model parameters that support Feature Contribution Calculation and which will be used for scoring.</param>
<param name="featureColumn">The name of the feature column that will be used as input.</param>
<param name="numPositiveContributions">The number of positive contributions to report, sorted from highest magnitude to lowest magnitude.
Note that if there are fewer features with positive contributions than <paramref name="numPositiveContributions"/>, the rest will be returned as zeros.</param>
<param name="numNegativeContributions">The number of negative contributions to report, sorted from highest magnitude to lowest magnitude.
Note that if there are fewer features with negative contributions than <paramref name="numNegativeContributions"/>, the rest will be returned as zeros.</param>
<param name="normalize">Whether the feature contributions should be normalized to the [-1, 1] interval.</param>
</member>
<member name="T:Microsoft.ML.TransformExtensionsCatalog">
<summary>
Extension methods for the <see cref="T:Microsoft.ML.TransformsCatalog"/>.
</summary>
</member>
<member name="M:Microsoft.ML.TransformExtensionsCatalog.CopyColumns(Microsoft.ML.TransformsCatalog,System.String,System.String)">
<summary>
Copies the input column to another column named as specified in <paramref name="outputColumnName"/>.
</summary>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the columns to transform.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.TransformExtensionsCatalog.CopyColumns(Microsoft.ML.TransformsCatalog,Microsoft.ML.ColumnOptions[])">
<summary>
Copies the input column, name specified in the first item of the tuple,
to another column, named as specified in the second item of the tuple.
</summary>
<param name="catalog">The transform's catalog</param>
<param name="columns">The pairs of input and output columns.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.TransformExtensionsCatalog.Concatenate(Microsoft.ML.TransformsCatalog,System.String,System.String[])">
<summary>
Concatenates columns together.
</summary>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnNames"/>.</param>
<param name="inputColumnNames">Name of the columns to transform.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.TransformExtensionsCatalog.DropColumns(Microsoft.ML.TransformsCatalog,System.String[])">
<summary>
DropColumns is used to select a list of columns that user wants to drop from a given input. Any column not specified will
be maintained in the output schema.
</summary>
<remarks>
<see cref="M:Microsoft.ML.TransformExtensionsCatalog.DropColumns(Microsoft.ML.TransformsCatalog,System.String[])"/> is commonly used to remove unwanted columns from the schema if the dataset is going to be serialized or
written out to a file. It is not actually necessary to drop unused columns before training or
performing transforms, as <see cref="T:Microsoft.Data.DataView.IDataView"/>'s lazy evaluation won't actually materialize those columns.
In the case of serialization, every column in the schema will be written out. If you have columns
that you don't want to save, you can use <see cref="M:Microsoft.ML.TransformExtensionsCatalog.DropColumns(Microsoft.ML.TransformsCatalog,System.String[])"/> to remove them from the schema.
</remarks>
<param name="catalog">The transform's catalog.</param>
<param name="columnsToDrop">The array of column names to drop.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.TransformExtensionsCatalog.SelectColumns(Microsoft.ML.TransformsCatalog,System.String[],System.Boolean)">
<summary>
Select a list of columns to keep in a given <see cref="T:Microsoft.Data.DataView.IDataView"/>.
</summary>
<remarks>
<format type="text/markdown">
<see cref="M:Microsoft.ML.TransformExtensionsCatalog.SelectColumns(Microsoft.ML.TransformsCatalog,System.String[],System.Boolean)"/> operates on the schema of an input <see cref="T:Microsoft.Data.DataView.IDataView"/>,
either dropping unselected columns from the schema or keeping them but marking them as hidden in the schema. Keeping columns hidden
is recommended when it is necessary to understand how the inputs of a pipeline map to outputs of the pipeline. This feature
is useful, for example, in debugging a pipeline of transforms by allowing you to print out results from the middle of the pipeline.
For more information on hidden columns, please refer to [IDataView Design Principles](~/../docs/samples/docs/code/IDataViewDesignPrinciples.md).
</format>
</remarks>
<param name="catalog">The transform's catalog.</param>
<param name="keepColumns">The array of column names to keep.</param>
<param name="keepHidden">If <see langword="true"/> will keep hidden columns and <see langword="false"/> will remove hidden columns.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.TransformExtensionsCatalog.SelectColumns(Microsoft.ML.TransformsCatalog,System.String[])">
<summary>
Select a list of columns to keep in a given <see cref="T:Microsoft.Data.DataView.IDataView"/>.
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
<xref:Microsoft.ML.SelectColumns(Microsoft.ML.TransformsCatalog, string[])> operates on the schema of an input <xref:Microsoft.Data.DataView.IDataView>,
dropping unselected columns from the schema.
]]></format>
</remarks>
<param name="catalog">The transform's catalog.</param>
<param name="keepColumns">The array of column names to keep.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="T:Microsoft.ML.NormalizerCatalog">
<summary>
Extensions for normalizer operations.
</summary>
</member>
<member name="M:Microsoft.ML.NormalizerCatalog.Normalize(Microsoft.ML.TransformsCatalog,System.String,System.String,Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode)">
<summary>
Normalize (rescale) the column according to the specified <paramref name="mode"/>.
</summary>
<param name="catalog">The transform catalog</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
<param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
<param name="mode">The <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode"/> used to map the old values in the new scale. </param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.NormalizerCatalog.Normalize(Microsoft.ML.TransformsCatalog,Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode,Microsoft.ML.ColumnOptions[])">
<summary>
Normalize (rescale) several columns according to the specified <paramref name="mode"/>.
</summary>
<param name="catalog">The transform catalog</param>
<param name="mode">The <see cref="T:Microsoft.ML.Transforms.NormalizingEstimator.NormalizerMode"/> used to map the old values to the new ones. </param>
<param name="columns">The pairs of input and output columns.</param>
<example>
<format type="text/markdown">
<]
]]>
</format>
</example>
</member>
<member name="M:Microsoft.ML.NormalizerCatalog.Normalize(Microsoft.ML.TransformsCatalog,Microsoft.ML.Transforms.NormalizingEstimator.ColumnOptionsBase[])">
<summary>
Normalize (rescale) columns according to specified custom parameters.
</summary>
<param name="catalog">The transform catalog</param>
<param name="columns">The normalization settings for all the columns</param>
</member>
<member name="T:Microsoft.ML.TransformsCatalog">
<summary>
Similar to training context, a transform context is an object serving as a 'catalog' of available transforms.
Individual transforms are exposed as extension methods of this class or its subclasses.
</summary>
</member>
<member name="P:Microsoft.ML.TransformsCatalog.Categorical">
<summary>
The list of operations over categorical data.
</summary>
</member>
<member name="P:Microsoft.ML.TransformsCatalog.Conversion">
<summary>
The list of operations for data type conversion.
</summary>
</member>
<member name="P:Microsoft.ML.TransformsCatalog.Text">
<summary>
The list of operations for processing text data.
</summary>
</member>
<member name="P:Microsoft.ML.TransformsCatalog.Projection">
<summary>
The list of operations for data projection.
</summary>
</member>
<member name="P:Microsoft.ML.TransformsCatalog.FeatureSelection">
<summary>
The list of operations for selecting features based on some criteria.
</summary>
</member>
<member name="T:Microsoft.ML.TransformsCatalog.CategoricalTransforms">
<summary>
The catalog of operations over categorical data.
</summary>
</member>
<member name="T:Microsoft.ML.TransformsCatalog.ConversionTransforms">
<summary>
The catalog of type conversion operations.
</summary>
</member>
<member name="T:Microsoft.ML.TransformsCatalog.TextTransforms">
<summary>
The catalog of text processing operations.
</summary>
</member>
<member name="T:Microsoft.ML.TransformsCatalog.ProjectionTransforms">
<summary>
The catalog of projection operations.
</summary>
</member>
<member name="T:Microsoft.ML.TransformsCatalog.FeatureSelectionTransforms">
<summary>
The catalog of feature selection operations.
</summary>
</member>
<member name="M:Microsoft.ML.ApiUtils.GeneratePeek``2(Microsoft.ML.Data.InternalSchemaDefinition.Column)">
<summary>
Each of the specialized 'peek' methods copies the appropriate field value of an instance of T
into the provided buffer. So, the call is 'peek(userObject, ref destination)' and the logic is
indentical to 'destination = userObject.##FIELD##', where ##FIELD## is defined per peek method.
</summary>
</member>
<member name="M:Microsoft.ML.ApiUtils.GeneratePoke``2(Microsoft.ML.Data.InternalSchemaDefinition.Column)">
<summary>
Each of the specialized 'poke' methods sets the appropriate field value of an instance of T
to the provided value. So, the call is 'peek(userObject, providedValue)' and the logic is
indentical to 'userObject.##FIELD## = providedValue', where ##FIELD## is defined per poke method.
</summary>
</member>
<member name="T:Microsoft.ML.ISupportSdcaLoss">
<summary>
The loss function may know the close-form solution to the optimal dual update
Ref: Sec(6.2) of http://jmlr.org/papers/volume14/shalev-shwartz13a/shalev-shwartz13a.pdf
</summary>
</member>
<member name="M:Microsoft.ML.ISupportSdcaLoss.DualUpdate(System.Single,System.Single,System.Single,System.Single,System.Int32)">
<summary>
Compute the dual update (\Delta\alpha_i) in SDCA
- alpha: dual variable at the specified instance
- lambdaN: L2 const x number of instances
- cached invariant, hinted by the method above
</summary>
</member>
<member name="M:Microsoft.ML.ISupportSdcaLoss.DualLoss(System.Single,System.Double)">
<summary>
The dual loss function for a training example.
If f(x) denotes the loss function on an individual training example,
then this function returns -f*(-x*), where f*(x*) is the Fenchel conjugate
of f(x).
</summary>
<param name="label">The label of the example.</param>
<param name="dual">The dual variable of the example.</param>
</member>
<member name="T:Microsoft.ML.HingeLoss">
<summary>
Hinge Loss
</summary>
</member>
<member name="M:Microsoft.ML.SmoothedHingeLoss.#ctor(System.Single)">
<summary>
Constructor for smoothed hinge losee.
</summary>
<param name="smoothingConstant">The smoothing constant.</param>
</member>
<member name="T:Microsoft.ML.ExpLoss">
<summary>
Exponential Loss
</summary>
</member>
<member name="T:Microsoft.ML.PoissonLoss">
<summary>
Poisson Loss.
</summary>
</member>
<member name="T:Microsoft.ML.TweedieLoss">
<summary>
Tweedie loss, based on the log-likelihood of the Tweedie distribution.
</summary>
</member>
<member name="M:Microsoft.ML.TweedieLoss.#ctor(System.Double)">
<summary>
Constructor for Tweedie loss.
</summary>
<param name="index">Index parameter for the Tweedie distribution, in the range [1, 2].
1 is Poisson loss, 2 is gamma loss, and intermediate values are compound Poisson loss.</param>
</member>
</members>
</doc>