-
Notifications
You must be signed in to change notification settings - Fork 31
/
TimeSeriesCatalog.xml
785 lines (785 loc) · 86.3 KB
/
TimeSeriesCatalog.xml
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
<Type Name="TimeSeriesCatalog" FullName="Microsoft.ML.TimeSeriesCatalog">
<TypeSignature Language="C#" Value="public static class TimeSeriesCatalog" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit TimeSeriesCatalog extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.TimeSeriesCatalog" />
<TypeSignature Language="VB.NET" Value="Public Module TimeSeriesCatalog" />
<TypeSignature Language="F#" Value="type TimeSeriesCatalog = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="DetectAnomalyBySrCnn">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.SrCnnAnomalyEstimator DetectAnomalyBySrCnn (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int windowSize = 64, int backAddWindowSize = 5, int lookaheadWindowSize = 5, int averagingWindowSize = 3, int judgementWindowSize = 21, double threshold = 0.3);" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.SrCnnAnomalyEstimator DetectAnomalyBySrCnn(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int32 windowSize, int32 backAddWindowSize, int32 lookaheadWindowSize, int32 averagingWindowSize, int32 judgementWindowSize, float64 threshold) cil managed" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectAnomalyBySrCnn(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Double)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectAnomalyBySrCnn (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, Optional windowSize As Integer = 64, Optional backAddWindowSize As Integer = 5, Optional lookaheadWindowSize As Integer = 5, Optional averagingWindowSize As Integer = 3, Optional judgementWindowSize As Integer = 21, Optional threshold As Double = 0.3) As SrCnnAnomalyEstimator" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<MemberSignature Language="F#" Value="static member DetectAnomalyBySrCnn : Microsoft.ML.TransformsCatalog * string * string * int * int * int * int * int * double -> Microsoft.ML.Transforms.TimeSeries.SrCnnAnomalyEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectAnomalyBySrCnn (catalog, outputColumnName, inputColumnName, windowSize, backAddWindowSize, lookaheadWindowSize, averagingWindowSize, judgementWindowSize, threshold)" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.SrCnnAnomalyEstimator DetectAnomalyBySrCnn (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int windowSize = 64, int backAddWindowSize = 5, int lookaheadWindowSize = 5, int averageingWindowSize = 3, int judgementWindowSize = 21, double threshold = 0.3);" FrameworkAlternate="ml-dotnet-1.2.0;ml-dotnet-1.3.1;ml-dotnet-1.4.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.SrCnnAnomalyEstimator DetectAnomalyBySrCnn(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int32 windowSize, int32 backAddWindowSize, int32 lookaheadWindowSize, int32 averageingWindowSize, int32 judgementWindowSize, float64 threshold) cil managed" FrameworkAlternate="ml-dotnet-1.2.0;ml-dotnet-1.3.1;ml-dotnet-1.4.0" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectAnomalyBySrCnn (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, Optional windowSize As Integer = 64, Optional backAddWindowSize As Integer = 5, Optional lookaheadWindowSize As Integer = 5, Optional averageingWindowSize As Integer = 3, Optional judgementWindowSize As Integer = 21, Optional threshold As Double = 0.3) As SrCnnAnomalyEstimator" FrameworkAlternate="ml-dotnet-1.2.0;ml-dotnet-1.3.1;ml-dotnet-1.4.0" />
<MemberSignature Language="F#" Value="static member DetectAnomalyBySrCnn : Microsoft.ML.TransformsCatalog * string * string * int * int * int * int * int * double -> Microsoft.ML.Transforms.TimeSeries.SrCnnAnomalyEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectAnomalyBySrCnn (catalog, outputColumnName, inputColumnName, windowSize, backAddWindowSize, lookaheadWindowSize, averageingWindowSize, judgementWindowSize, threshold)" FrameworkAlternate="ml-dotnet-1.2.0;ml-dotnet-1.3.1;ml-dotnet-1.4.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.SrCnnAnomalyEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" Index="0" />
<Parameter Name="outputColumnName" Type="System.String" Index="1" />
<Parameter Name="inputColumnName" Type="System.String" Index="2" />
<Parameter Name="windowSize" Type="System.Int32" Index="3" />
<Parameter Name="backAddWindowSize" Type="System.Int32" Index="4" />
<Parameter Name="lookaheadWindowSize" Type="System.Int32" Index="5" />
<Parameter Name="averagingWindowSize" Type="System.Int32" Index="6" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="averageingWindowSize" Type="System.Int32" Index="6" FrameworkAlternate="ml-dotnet-1.2.0;ml-dotnet-1.3.1;ml-dotnet-1.4.0" />
<Parameter Name="judgementWindowSize" Type="System.Int32" Index="7" />
<Parameter Name="threshold" Type="System.Double" Index="8" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 3 elements: alert (1 means anomaly while 0 means normal), raw score, and magnitude of spectual residual.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />.</param>
<param name="windowSize">The size of the sliding window for computing spectral residual.</param>
<param name="backAddWindowSize">The number of points to add back of training window. No more than <paramref name="windowSize" />, usually keep default value.</param>
<param name="lookaheadWindowSize">The number of pervious points used in prediction. No more than <paramref name="windowSize" />, usually keep default value.</param>
<param name="averagingWindowSize">The size of sliding window to generate a saliency map for the series. No more than <paramref name="windowSize" />, usually keep default value.</param>
<param name="averageingWindowSize">The size of sliding window to generate a saliency map for the series. No more than <paramref name="windowSize" />, usually keep default value.</param>
<param name="judgementWindowSize">The size of sliding window to calculate the anomaly score for each data point. No more than <paramref name="windowSize" />.</param>
<param name="threshold">The threshold to determine anomaly, score larger than the threshold is considered as anomaly. Should be in (0,1)</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.SrCnnAnomalyEstimator" />, which detects timeseries anomalies using SRCNN algorithm.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectAnomalyBySrCnn](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectAnomalyBySrCnn.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectChangePointBySsa">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator DetectChangePointBySsa (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, double confidence, int changeHistoryLength, int trainingWindowSize, int seasonalityWindowSize, Microsoft.ML.Transforms.TimeSeries.ErrorFunction errorFunction = Microsoft.ML.Transforms.TimeSeries.ErrorFunction.SignedDifference, Microsoft.ML.Transforms.TimeSeries.MartingaleType martingale = Microsoft.ML.Transforms.TimeSeries.MartingaleType.Power, double eps = 0.1);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator DetectChangePointBySsa(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, float64 confidence, int32 changeHistoryLength, int32 trainingWindowSize, int32 seasonalityWindowSize, valuetype Microsoft.ML.Transforms.TimeSeries.ErrorFunction errorFunction, valuetype Microsoft.ML.Transforms.TimeSeries.MartingaleType martingale, float64 eps) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectChangePointBySsa(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Double,System.Int32,System.Int32,System.Int32,Microsoft.ML.Transforms.TimeSeries.ErrorFunction,Microsoft.ML.Transforms.TimeSeries.MartingaleType,System.Double)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectChangePointBySsa (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, confidence As Double, changeHistoryLength As Integer, trainingWindowSize As Integer, seasonalityWindowSize As Integer, Optional errorFunction As ErrorFunction = Microsoft.ML.Transforms.TimeSeries.ErrorFunction.SignedDifference, Optional martingale As MartingaleType = Microsoft.ML.Transforms.TimeSeries.MartingaleType.Power, Optional eps As Double = 0.1) As SsaChangePointEstimator" />
<MemberSignature Language="F#" Value="static member DetectChangePointBySsa : Microsoft.ML.TransformsCatalog * string * string * double * int * int * int * Microsoft.ML.Transforms.TimeSeries.ErrorFunction * Microsoft.ML.Transforms.TimeSeries.MartingaleType * double -> Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectChangePointBySsa (catalog, outputColumnName, inputColumnName, confidence, changeHistoryLength, trainingWindowSize, seasonalityWindowSize, errorFunction, martingale, eps)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="outputColumnName" Type="System.String" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="inputColumnName" Type="System.String" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="confidence" Type="System.Double" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="changeHistoryLength" Type="System.Int32" Index="4" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="trainingWindowSize" Type="System.Int32" Index="5" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="seasonalityWindowSize" Type="System.Int32" Index="6" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="errorFunction" Type="Microsoft.ML.Transforms.TimeSeries.ErrorFunction" Index="7" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="martingale" Type="Microsoft.ML.Transforms.TimeSeries.MartingaleType" Index="8" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="eps" Type="System.Double" Index="9" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 4 elements: alert (non-zero value means a change point), raw score, p-Value and martingale score.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />.
If set to <see langword="null" />, the value of the <paramref name="outputColumnName" /> will be used as source.</param>
<param name="confidence">The confidence for change point detection in the range [0, 100].</param>
<param name="changeHistoryLength">The size of the sliding window for computing the p-value.</param>
<param name="trainingWindowSize">The number of points from the beginning of the sequence used for training.</param>
<param name="seasonalityWindowSize">An upper bound on the largest relevant seasonality in the input time-series.</param>
<param name="errorFunction">The function used to compute the error between the expected and the observed value.</param>
<param name="martingale">The martingale used for scoring.</param>
<param name="eps">The epsilon parameter for the Power martingale.</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator" />, which predicts change points in time series
using <a href="https://en.wikipedia.org/wiki/Singular_spectrum_analysis">Singular Spectrum Analysis (SSA)</a>.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectChangePointBySsa](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectChangePointBySsaBatchPrediction.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectChangePointBySsa">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator DetectChangePointBySsa (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int confidence, int changeHistoryLength, int trainingWindowSize, int seasonalityWindowSize, Microsoft.ML.Transforms.TimeSeries.ErrorFunction errorFunction = Microsoft.ML.Transforms.TimeSeries.ErrorFunction.SignedDifference, Microsoft.ML.Transforms.TimeSeries.MartingaleType martingale = Microsoft.ML.Transforms.TimeSeries.MartingaleType.Power, double eps = 0.1);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator DetectChangePointBySsa(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int32 confidence, int32 changeHistoryLength, int32 trainingWindowSize, int32 seasonalityWindowSize, valuetype Microsoft.ML.Transforms.TimeSeries.ErrorFunction errorFunction, valuetype Microsoft.ML.Transforms.TimeSeries.MartingaleType martingale, float64 eps) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectChangePointBySsa(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,Microsoft.ML.Transforms.TimeSeries.ErrorFunction,Microsoft.ML.Transforms.TimeSeries.MartingaleType,System.Double)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectChangePointBySsa (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, confidence As Integer, changeHistoryLength As Integer, trainingWindowSize As Integer, seasonalityWindowSize As Integer, Optional errorFunction As ErrorFunction = Microsoft.ML.Transforms.TimeSeries.ErrorFunction.SignedDifference, Optional martingale As MartingaleType = Microsoft.ML.Transforms.TimeSeries.MartingaleType.Power, Optional eps As Double = 0.1) As SsaChangePointEstimator" />
<MemberSignature Language="F#" Value="static member DetectChangePointBySsa : Microsoft.ML.TransformsCatalog * string * string * int * int * int * int * Microsoft.ML.Transforms.TimeSeries.ErrorFunction * Microsoft.ML.Transforms.TimeSeries.MartingaleType * double -> Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectChangePointBySsa (catalog, outputColumnName, inputColumnName, confidence, changeHistoryLength, trainingWindowSize, seasonalityWindowSize, errorFunction, martingale, eps)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0">
<AttributeName Language="C#">[System.Obsolete("This API method is deprecated, please use the overload with confidence parameter of type double.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This API method is deprecated, please use the overload with confidence parameter of type double.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" />
<Parameter Name="outputColumnName" Type="System.String" />
<Parameter Name="inputColumnName" Type="System.String" />
<Parameter Name="confidence" Type="System.Int32" />
<Parameter Name="changeHistoryLength" Type="System.Int32" />
<Parameter Name="trainingWindowSize" Type="System.Int32" />
<Parameter Name="seasonalityWindowSize" Type="System.Int32" />
<Parameter Name="errorFunction" Type="Microsoft.ML.Transforms.TimeSeries.ErrorFunction" />
<Parameter Name="martingale" Type="Microsoft.ML.Transforms.TimeSeries.MartingaleType" />
<Parameter Name="eps" Type="System.Double" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 4 elements: alert (non-zero value means a change point), raw score, p-Value and martingale score.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />.
If set to <see langword="null" />, the value of the <paramref name="outputColumnName" /> will be used as source.</param>
<param name="confidence">The confidence for change point detection in the range [0, 100].</param>
<param name="changeHistoryLength">The size of the sliding window for computing the p-value.</param>
<param name="trainingWindowSize">The number of points from the beginning of the sequence used for training.</param>
<param name="seasonalityWindowSize">An upper bound on the largest relevant seasonality in the input time-series.</param>
<param name="errorFunction">The function used to compute the error between the expected and the observed value.</param>
<param name="martingale">The martingale used for scoring.</param>
<param name="eps">The epsilon parameter for the Power martingale.</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.SsaChangePointEstimator" />, which predicts change points in time series
using <a href="https://en.wikipedia.org/wiki/Singular_spectrum_analysis">Singular Spectrum Analysis (SSA)</a>.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectChangePointBySsa](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectChangePointBySsaBatchPrediction.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectEntireAnomalyBySrCnn">
<MemberSignature Language="C#" Value="public static Microsoft.ML.IDataView DetectEntireAnomalyBySrCnn (this Microsoft.ML.AnomalyDetectionCatalog catalog, Microsoft.ML.IDataView input, string outputColumnName, string inputColumnName, Microsoft.ML.TimeSeries.SrCnnEntireAnomalyDetectorOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.IDataView DetectEntireAnomalyBySrCnn(class Microsoft.ML.AnomalyDetectionCatalog catalog, class Microsoft.ML.IDataView input, string outputColumnName, string inputColumnName, class Microsoft.ML.TimeSeries.SrCnnEntireAnomalyDetectorOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectEntireAnomalyBySrCnn(Microsoft.ML.AnomalyDetectionCatalog,Microsoft.ML.IDataView,System.String,System.String,Microsoft.ML.TimeSeries.SrCnnEntireAnomalyDetectorOptions)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectEntireAnomalyBySrCnn (catalog As AnomalyDetectionCatalog, input As IDataView, outputColumnName As String, inputColumnName As String, options As SrCnnEntireAnomalyDetectorOptions) As IDataView" />
<MemberSignature Language="F#" Value="static member DetectEntireAnomalyBySrCnn : Microsoft.ML.AnomalyDetectionCatalog * Microsoft.ML.IDataView * string * string * Microsoft.ML.TimeSeries.SrCnnEntireAnomalyDetectorOptions -> Microsoft.ML.IDataView" Usage="Microsoft.ML.TimeSeriesCatalog.DetectEntireAnomalyBySrCnn (catalog, input, outputColumnName, inputColumnName, options)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.IDataView</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.AnomalyDetectionCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="input" Type="Microsoft.ML.IDataView" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="outputColumnName" Type="System.String" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="inputColumnName" Type="System.String" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="options" Type="Microsoft.ML.TimeSeries.SrCnnEntireAnomalyDetectorOptions" Index="4" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The AnomalyDetectionCatalog.</param>
<param name="input">Input DataView.</param>
<param name="outputColumnName">Name of the column resulting from data processing of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The length of this vector varies depending on <paramref name="options.DetectMode.DetectMode" />.</param>
<param name="inputColumnName">Name of column to process. The column data must be <see cref="T:System.Double" />.</param>
<param name="options">Defines the settings of the load operation.</param>
<summary>
Create <see cref="T:Microsoft.ML.TimeSeries.SrCnnEntireAnomalyDetector" />, which detects timeseries anomalies for entire input using SRCNN algorithm.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectEntireAnomalyBySrCnn](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectEntireAnomalyBySrCnn.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectEntireAnomalyBySrCnn">
<MemberSignature Language="C#" Value="public static Microsoft.ML.IDataView DetectEntireAnomalyBySrCnn (this Microsoft.ML.AnomalyDetectionCatalog catalog, Microsoft.ML.IDataView input, string outputColumnName, string inputColumnName, double threshold = 0.3, int batchSize = 1024, double sensitivity = 99, Microsoft.ML.TimeSeries.SrCnnDetectMode detectMode = Microsoft.ML.TimeSeries.SrCnnDetectMode.AnomalyOnly);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.IDataView DetectEntireAnomalyBySrCnn(class Microsoft.ML.AnomalyDetectionCatalog catalog, class Microsoft.ML.IDataView input, string outputColumnName, string inputColumnName, float64 threshold, int32 batchSize, float64 sensitivity, valuetype Microsoft.ML.TimeSeries.SrCnnDetectMode detectMode) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectEntireAnomalyBySrCnn(Microsoft.ML.AnomalyDetectionCatalog,Microsoft.ML.IDataView,System.String,System.String,System.Double,System.Int32,System.Double,Microsoft.ML.TimeSeries.SrCnnDetectMode)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectEntireAnomalyBySrCnn (catalog As AnomalyDetectionCatalog, input As IDataView, outputColumnName As String, inputColumnName As String, Optional threshold As Double = 0.3, Optional batchSize As Integer = 1024, Optional sensitivity As Double = 99, Optional detectMode As SrCnnDetectMode = Microsoft.ML.TimeSeries.SrCnnDetectMode.AnomalyOnly) As IDataView" />
<MemberSignature Language="F#" Value="static member DetectEntireAnomalyBySrCnn : Microsoft.ML.AnomalyDetectionCatalog * Microsoft.ML.IDataView * string * string * double * int * double * Microsoft.ML.TimeSeries.SrCnnDetectMode -> Microsoft.ML.IDataView" Usage="Microsoft.ML.TimeSeriesCatalog.DetectEntireAnomalyBySrCnn (catalog, input, outputColumnName, inputColumnName, threshold, batchSize, sensitivity, detectMode)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.IDataView</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.AnomalyDetectionCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="input" Type="Microsoft.ML.IDataView" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="outputColumnName" Type="System.String" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="inputColumnName" Type="System.String" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="threshold" Type="System.Double" Index="4" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="batchSize" Type="System.Int32" Index="5" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="sensitivity" Type="System.Double" Index="6" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="detectMode" Type="Microsoft.ML.TimeSeries.SrCnnDetectMode" Index="7" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The AnomalyDetectionCatalog.</param>
<param name="input">Input DataView.</param>
<param name="outputColumnName">Name of the column resulting from data processing of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The length of this vector varies depending on <paramref name="detectMode" />.</param>
<param name="inputColumnName">Name of column to process. The column data must be <see cref="T:System.Double" />.</param>
<param name="threshold">The threshold to determine an anomaly. An anomaly is detected when the calculated SR raw score for a given point is more than the set threshold. This threshold must fall between [0,1], and its default value is 0.3.</param>
<param name="batchSize">Divide the input data into batches to fit srcnn model.
When set to -1, use the whole input to fit model instead of batch by batch, when set to a positive integer, use this number as batch size.
Must be -1 or a positive integer no less than 12. Default value is 1024.</param>
<param name="sensitivity">Sensitivity of boundaries, only useful when srCnnDetectMode is AnomalyAndMargin. Must be in [0,100]. Default value is 99.</param>
<param name="detectMode">An enum type of <see cref="T:Microsoft.ML.TimeSeries.SrCnnDetectMode" />.
When set to AnomalyOnly, the output vector would be a 3-element Double vector of (IsAnomaly, RawScore, Mag).
When set to AnomalyAndExpectedValue, the output vector would be a 4-element Double vector of (IsAnomaly, RawScore, Mag, ExpectedValue).
When set to AnomalyAndMargin, the output vector would be a 7-element Double vector of (IsAnomaly, AnomalyScore, Mag, ExpectedValue, BoundaryUnit, UpperBoundary, LowerBoundary).
The RawScore is output by SR to determine whether a point is an anomaly or not, under AnomalyAndMargin mode, when a point is an anomaly, an AnomalyScore will be calculated according to sensitivity setting.
Default value is AnomalyOnly.</param>
<summary>
Create <see cref="T:Microsoft.ML.TimeSeries.SrCnnEntireAnomalyDetector" />, which detects timeseries anomalies for entire input using SRCNN algorithm.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectEntireAnomalyBySrCnn](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectEntireAnomalyBySrCnn.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectIidChangePoint">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator DetectIidChangePoint (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, double confidence, int changeHistoryLength, Microsoft.ML.Transforms.TimeSeries.MartingaleType martingale = Microsoft.ML.Transforms.TimeSeries.MartingaleType.Power, double eps = 0.1);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator DetectIidChangePoint(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, float64 confidence, int32 changeHistoryLength, valuetype Microsoft.ML.Transforms.TimeSeries.MartingaleType martingale, float64 eps) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectIidChangePoint(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Double,System.Int32,Microsoft.ML.Transforms.TimeSeries.MartingaleType,System.Double)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectIidChangePoint (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, confidence As Double, changeHistoryLength As Integer, Optional martingale As MartingaleType = Microsoft.ML.Transforms.TimeSeries.MartingaleType.Power, Optional eps As Double = 0.1) As IidChangePointEstimator" />
<MemberSignature Language="F#" Value="static member DetectIidChangePoint : Microsoft.ML.TransformsCatalog * string * string * double * int * Microsoft.ML.Transforms.TimeSeries.MartingaleType * double -> Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectIidChangePoint (catalog, outputColumnName, inputColumnName, confidence, changeHistoryLength, martingale, eps)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="outputColumnName" Type="System.String" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="inputColumnName" Type="System.String" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="confidence" Type="System.Double" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="changeHistoryLength" Type="System.Int32" Index="4" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="martingale" Type="Microsoft.ML.Transforms.TimeSeries.MartingaleType" Index="5" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="eps" Type="System.Double" Index="6" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 4 elements: alert (non-zero value means a change point), raw score, p-Value and martingale score.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />. If set to <see langword="null" />, the value of the <paramref name="outputColumnName" /> will be used as source.</param>
<param name="confidence">The confidence for change point detection in the range [0, 100].</param>
<param name="changeHistoryLength">The length of the sliding window on p-values for computing the martingale score.</param>
<param name="martingale">The martingale used for scoring.</param>
<param name="eps">The epsilon parameter for the Power martingale.</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator" />, which predicts change points in an
<a href="https://en.wikipedia.org/wiki/Independent_and_identically_distributed_random_variables">independent identically distributed (i.i.d.)</a>
time series based on adaptive kernel density estimations and martingale scores.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectIidChangePoint](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectIidChangePointBatchPrediction.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectIidChangePoint">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator DetectIidChangePoint (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int confidence, int changeHistoryLength, Microsoft.ML.Transforms.TimeSeries.MartingaleType martingale = Microsoft.ML.Transforms.TimeSeries.MartingaleType.Power, double eps = 0.1);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator DetectIidChangePoint(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int32 confidence, int32 changeHistoryLength, valuetype Microsoft.ML.Transforms.TimeSeries.MartingaleType martingale, float64 eps) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectIidChangePoint(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Int32,System.Int32,Microsoft.ML.Transforms.TimeSeries.MartingaleType,System.Double)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectIidChangePoint (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, confidence As Integer, changeHistoryLength As Integer, Optional martingale As MartingaleType = Microsoft.ML.Transforms.TimeSeries.MartingaleType.Power, Optional eps As Double = 0.1) As IidChangePointEstimator" />
<MemberSignature Language="F#" Value="static member DetectIidChangePoint : Microsoft.ML.TransformsCatalog * string * string * int * int * Microsoft.ML.Transforms.TimeSeries.MartingaleType * double -> Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectIidChangePoint (catalog, outputColumnName, inputColumnName, confidence, changeHistoryLength, martingale, eps)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0">
<AttributeName Language="C#">[System.Obsolete("This API method is deprecated, please use the overload with confidence parameter of type double.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This API method is deprecated, please use the overload with confidence parameter of type double.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" />
<Parameter Name="outputColumnName" Type="System.String" />
<Parameter Name="inputColumnName" Type="System.String" />
<Parameter Name="confidence" Type="System.Int32" />
<Parameter Name="changeHistoryLength" Type="System.Int32" />
<Parameter Name="martingale" Type="Microsoft.ML.Transforms.TimeSeries.MartingaleType" />
<Parameter Name="eps" Type="System.Double" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 4 elements: alert (non-zero value means a change point), raw score, p-Value and martingale score.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />. If set to <see langword="null" />, the value of the <paramref name="outputColumnName" /> will be used as source.</param>
<param name="confidence">The confidence for change point detection in the range [0, 100].</param>
<param name="changeHistoryLength">The length of the sliding window on p-values for computing the martingale score.</param>
<param name="martingale">The martingale used for scoring.</param>
<param name="eps">The epsilon parameter for the Power martingale.</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.IidChangePointEstimator" />, which predicts change points in an
<a href="https://en.wikipedia.org/wiki/Independent_and_identically_distributed_random_variables">independent identically distributed (i.i.d.)</a>
time series based on adaptive kernel density estimations and martingale scores.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectIidChangePoint](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectIidChangePointBatchPrediction.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectIidSpike">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator DetectIidSpike (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, double confidence, int pvalueHistoryLength, Microsoft.ML.Transforms.TimeSeries.AnomalySide side = Microsoft.ML.Transforms.TimeSeries.AnomalySide.TwoSided);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator DetectIidSpike(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, float64 confidence, int32 pvalueHistoryLength, valuetype Microsoft.ML.Transforms.TimeSeries.AnomalySide side) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectIidSpike(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Double,System.Int32,Microsoft.ML.Transforms.TimeSeries.AnomalySide)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectIidSpike (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, confidence As Double, pvalueHistoryLength As Integer, Optional side As AnomalySide = Microsoft.ML.Transforms.TimeSeries.AnomalySide.TwoSided) As IidSpikeEstimator" />
<MemberSignature Language="F#" Value="static member DetectIidSpike : Microsoft.ML.TransformsCatalog * string * string * double * int * Microsoft.ML.Transforms.TimeSeries.AnomalySide -> Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectIidSpike (catalog, outputColumnName, inputColumnName, confidence, pvalueHistoryLength, side)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="outputColumnName" Type="System.String" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="inputColumnName" Type="System.String" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="confidence" Type="System.Double" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="pvalueHistoryLength" Type="System.Int32" Index="4" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="side" Type="Microsoft.ML.Transforms.TimeSeries.AnomalySide" Index="5" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 3 elements: alert (non-zero value means a spike), raw score, and p-value.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />.
If set to <see langword="null" />, the value of the <paramref name="outputColumnName" /> will be used as source.</param>
<param name="confidence">The confidence for spike detection in the range [0, 100].</param>
<param name="pvalueHistoryLength">The size of the sliding window for computing the p-value.</param>
<param name="side">The argument that determines whether to detect positive or negative anomalies, or both.</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator" />, which predicts spikes in
<a href="https://en.wikipedia.org/wiki/Independent_and_identically_distributed_random_variables"> independent identically distributed (i.i.d.)</a>
time series based on adaptive kernel density estimations and martingale scores.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectIidSpike](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectIidSpikeBatchPrediction.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectIidSpike">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator DetectIidSpike (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int confidence, int pvalueHistoryLength, Microsoft.ML.Transforms.TimeSeries.AnomalySide side = Microsoft.ML.Transforms.TimeSeries.AnomalySide.TwoSided);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator DetectIidSpike(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int32 confidence, int32 pvalueHistoryLength, valuetype Microsoft.ML.Transforms.TimeSeries.AnomalySide side) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectIidSpike(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Int32,System.Int32,Microsoft.ML.Transforms.TimeSeries.AnomalySide)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectIidSpike (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, confidence As Integer, pvalueHistoryLength As Integer, Optional side As AnomalySide = Microsoft.ML.Transforms.TimeSeries.AnomalySide.TwoSided) As IidSpikeEstimator" />
<MemberSignature Language="F#" Value="static member DetectIidSpike : Microsoft.ML.TransformsCatalog * string * string * int * int * Microsoft.ML.Transforms.TimeSeries.AnomalySide -> Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectIidSpike (catalog, outputColumnName, inputColumnName, confidence, pvalueHistoryLength, side)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0">
<AttributeName Language="C#">[System.Obsolete("This API method is deprecated, please use the overload with confidence parameter of type double.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This API method is deprecated, please use the overload with confidence parameter of type double.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" />
<Parameter Name="outputColumnName" Type="System.String" />
<Parameter Name="inputColumnName" Type="System.String" />
<Parameter Name="confidence" Type="System.Int32" />
<Parameter Name="pvalueHistoryLength" Type="System.Int32" />
<Parameter Name="side" Type="Microsoft.ML.Transforms.TimeSeries.AnomalySide" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 3 elements: alert (non-zero value means a spike), raw score, and p-value.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />.
If set to <see langword="null" />, the value of the <paramref name="outputColumnName" /> will be used as source.</param>
<param name="confidence">The confidence for spike detection in the range [0, 100].</param>
<param name="pvalueHistoryLength">The size of the sliding window for computing the p-value.</param>
<param name="side">The argument that determines whether to detect positive or negative anomalies, or both.</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.IidSpikeEstimator" />, which predicts spikes in
<a href="https://en.wikipedia.org/wiki/Independent_and_identically_distributed_random_variables"> independent identically distributed (i.i.d.)</a>
time series based on adaptive kernel density estimations and martingale scores.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectIidSpike](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectIidSpikeBatchPrediction.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectSeasonality">
<MemberSignature Language="C#" Value="public static int DetectSeasonality (this Microsoft.ML.AnomalyDetectionCatalog catalog, Microsoft.ML.IDataView input, string inputColumnName, int seasonalityWindowSize = -1, double randomnessThreshold = 0.95);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 DetectSeasonality(class Microsoft.ML.AnomalyDetectionCatalog catalog, class Microsoft.ML.IDataView input, string inputColumnName, int32 seasonalityWindowSize, float64 randomnessThreshold) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectSeasonality(Microsoft.ML.AnomalyDetectionCatalog,Microsoft.ML.IDataView,System.String,System.Int32,System.Double)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectSeasonality (catalog As AnomalyDetectionCatalog, input As IDataView, inputColumnName As String, Optional seasonalityWindowSize As Integer = -1, Optional randomnessThreshold As Double = 0.95) As Integer" />
<MemberSignature Language="F#" Value="static member DetectSeasonality : Microsoft.ML.AnomalyDetectionCatalog * Microsoft.ML.IDataView * string * int * double -> int" Usage="Microsoft.ML.TimeSeriesCatalog.DetectSeasonality (catalog, input, inputColumnName, seasonalityWindowSize, randomnessThreshold)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.AnomalyDetectionCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="input" Type="Microsoft.ML.IDataView" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="inputColumnName" Type="System.String" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="seasonalityWindowSize" Type="System.Int32" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="randomnessThreshold" Type="System.Double" Index="4" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The detect seasonality catalog.</param>
<param name="input">Input DataView.The data is an instance of <see cref="T:Microsoft.ML.IDataView" />.</param>
<param name="inputColumnName">Name of column to process. The column data must be <see cref="T:System.Double" />.</param>
<param name="seasonalityWindowSize">An upper bound on the number of values to be considered in the input values.
When set to -1, use the whole input to fit model; when set to a positive integer, only the first windowSize number
of values will be considered. Default value is -1.</param>
<param name="randomnessThreshold">
<a href="https://en.wikipedia.org/wiki/Correlogram">Randomness threshold</a>
that specifies how confidently the input values follow a predictable pattern recurring as seasonal data.
The range is between [0, 1]. By default, it is set as 0.95.
</param>
<summary>
<para>
In time series data, seasonality (or periodicity) is the presence of variations that occur at specific regular intervals,
such as weekly, monthly, or quarterly.
</para>
<para>
This method detects this predictable interval (or period) by adopting techniques of fourier analysis.
Assuming the input values have the same time interval (e.g., sensor data collected at every second ordered by timestamps),
this method takes a list of time-series data, and returns the regular period for the input seasonal data,
if a predictable fluctuation or pattern can be found that recurs or repeats over this period throughout the input values.
</para>
<para>
Returns -1 if no such pattern is found, that is, the input values do not follow a seasonal fluctuation.
</para>
</summary>
<returns>The regular interval for the input as seasonal data, otherwise return -1.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[LocalizeRootCause](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectSeasonality.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectSpikeBySsa">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator DetectSpikeBySsa (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, double confidence, int pvalueHistoryLength, int trainingWindowSize, int seasonalityWindowSize, Microsoft.ML.Transforms.TimeSeries.AnomalySide side = Microsoft.ML.Transforms.TimeSeries.AnomalySide.TwoSided, Microsoft.ML.Transforms.TimeSeries.ErrorFunction errorFunction = Microsoft.ML.Transforms.TimeSeries.ErrorFunction.SignedDifference);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator DetectSpikeBySsa(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, float64 confidence, int32 pvalueHistoryLength, int32 trainingWindowSize, int32 seasonalityWindowSize, valuetype Microsoft.ML.Transforms.TimeSeries.AnomalySide side, valuetype Microsoft.ML.Transforms.TimeSeries.ErrorFunction errorFunction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectSpikeBySsa(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Double,System.Int32,System.Int32,System.Int32,Microsoft.ML.Transforms.TimeSeries.AnomalySide,Microsoft.ML.Transforms.TimeSeries.ErrorFunction)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectSpikeBySsa (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, confidence As Double, pvalueHistoryLength As Integer, trainingWindowSize As Integer, seasonalityWindowSize As Integer, Optional side As AnomalySide = Microsoft.ML.Transforms.TimeSeries.AnomalySide.TwoSided, Optional errorFunction As ErrorFunction = Microsoft.ML.Transforms.TimeSeries.ErrorFunction.SignedDifference) As SsaSpikeEstimator" />
<MemberSignature Language="F#" Value="static member DetectSpikeBySsa : Microsoft.ML.TransformsCatalog * string * string * double * int * int * int * Microsoft.ML.Transforms.TimeSeries.AnomalySide * Microsoft.ML.Transforms.TimeSeries.ErrorFunction -> Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectSpikeBySsa (catalog, outputColumnName, inputColumnName, confidence, pvalueHistoryLength, trainingWindowSize, seasonalityWindowSize, side, errorFunction)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="outputColumnName" Type="System.String" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="inputColumnName" Type="System.String" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="confidence" Type="System.Double" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="pvalueHistoryLength" Type="System.Int32" Index="4" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="trainingWindowSize" Type="System.Int32" Index="5" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="seasonalityWindowSize" Type="System.Int32" Index="6" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="side" Type="Microsoft.ML.Transforms.TimeSeries.AnomalySide" Index="7" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="errorFunction" Type="Microsoft.ML.Transforms.TimeSeries.ErrorFunction" Index="8" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 3 elements: alert (non-zero value means a spike), raw score, and p-value.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />.
If set to <see langword="null" />, the value of the <paramref name="outputColumnName" /> will be used as source.</param>
<param name="confidence">The confidence for spike detection in the range [0, 100].</param>
<param name="pvalueHistoryLength">The size of the sliding window for computing the p-value.</param>
<param name="trainingWindowSize">The number of points from the beginning of the sequence used for training.</param>
<param name="seasonalityWindowSize">An upper bound on the largest relevant seasonality in the input time-series.</param>
<param name="side">The argument that determines whether to detect positive or negative anomalies, or both.</param>
<param name="errorFunction">The function used to compute the error between the expected and the observed value.</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator" />, which predicts spikes in time series
using <a href="https://en.wikipedia.org/wiki/Singular_spectrum_analysis">Singular Spectrum Analysis (SSA)</a>.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectSpikeBySsa](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectSpikeBySsaBatchPrediction.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="DetectSpikeBySsa">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator DetectSpikeBySsa (this Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int confidence, int pvalueHistoryLength, int trainingWindowSize, int seasonalityWindowSize, Microsoft.ML.Transforms.TimeSeries.AnomalySide side = Microsoft.ML.Transforms.TimeSeries.AnomalySide.TwoSided, Microsoft.ML.Transforms.TimeSeries.ErrorFunction errorFunction = Microsoft.ML.Transforms.TimeSeries.ErrorFunction.SignedDifference);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator DetectSpikeBySsa(class Microsoft.ML.TransformsCatalog catalog, string outputColumnName, string inputColumnName, int32 confidence, int32 pvalueHistoryLength, int32 trainingWindowSize, int32 seasonalityWindowSize, valuetype Microsoft.ML.Transforms.TimeSeries.AnomalySide side, valuetype Microsoft.ML.Transforms.TimeSeries.ErrorFunction errorFunction) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.DetectSpikeBySsa(Microsoft.ML.TransformsCatalog,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,Microsoft.ML.Transforms.TimeSeries.AnomalySide,Microsoft.ML.Transforms.TimeSeries.ErrorFunction)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetectSpikeBySsa (catalog As TransformsCatalog, outputColumnName As String, inputColumnName As String, confidence As Integer, pvalueHistoryLength As Integer, trainingWindowSize As Integer, seasonalityWindowSize As Integer, Optional side As AnomalySide = Microsoft.ML.Transforms.TimeSeries.AnomalySide.TwoSided, Optional errorFunction As ErrorFunction = Microsoft.ML.Transforms.TimeSeries.ErrorFunction.SignedDifference) As SsaSpikeEstimator" />
<MemberSignature Language="F#" Value="static member DetectSpikeBySsa : Microsoft.ML.TransformsCatalog * string * string * int * int * int * int * Microsoft.ML.Transforms.TimeSeries.AnomalySide * Microsoft.ML.Transforms.TimeSeries.ErrorFunction -> Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.DetectSpikeBySsa (catalog, outputColumnName, inputColumnName, confidence, pvalueHistoryLength, trainingWindowSize, seasonalityWindowSize, side, errorFunction)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0">
<AttributeName Language="C#">[System.Obsolete("This API method is deprecated, please use the overload with confidence parameter of type double.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This API method is deprecated, please use the overload with confidence parameter of type double.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.TransformsCatalog" RefType="this" />
<Parameter Name="outputColumnName" Type="System.String" />
<Parameter Name="inputColumnName" Type="System.String" />
<Parameter Name="confidence" Type="System.Int32" />
<Parameter Name="pvalueHistoryLength" Type="System.Int32" />
<Parameter Name="trainingWindowSize" Type="System.Int32" />
<Parameter Name="seasonalityWindowSize" Type="System.Int32" />
<Parameter Name="side" Type="Microsoft.ML.Transforms.TimeSeries.AnomalySide" />
<Parameter Name="errorFunction" Type="Microsoft.ML.Transforms.TimeSeries.ErrorFunction" />
</Parameters>
<Docs>
<param name="catalog">The transform's catalog.</param>
<param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.
The column data is a vector of <see cref="T:System.Double" />. The vector contains 3 elements: alert (non-zero value means a spike), raw score, and p-value.</param>
<param name="inputColumnName">Name of column to transform. The column data must be <see cref="T:System.Single" />.
If set to <see langword="null" />, the value of the <paramref name="outputColumnName" /> will be used as source.</param>
<param name="confidence">The confidence for spike detection in the range [0, 100].</param>
<param name="pvalueHistoryLength">The size of the sliding window for computing the p-value.</param>
<param name="trainingWindowSize">The number of points from the beginning of the sequence used for training.</param>
<param name="seasonalityWindowSize">An upper bound on the largest relevant seasonality in the input time-series.</param>
<param name="side">The argument that determines whether to detect positive or negative anomalies, or both.</param>
<param name="errorFunction">The function used to compute the error between the expected and the observed value.</param>
<summary>
Create <see cref="T:Microsoft.ML.Transforms.TimeSeries.SsaSpikeEstimator" />, which predicts spikes in time series
using <a href="https://en.wikipedia.org/wiki/Singular_spectrum_analysis">Singular Spectrum Analysis (SSA)</a>.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[DetectSpikeBySsa](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/DetectSpikeBySsaBatchPrediction.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="ForecastBySsa">
<MemberSignature Language="C#" Value="public static Microsoft.ML.Transforms.TimeSeries.SsaForecastingEstimator ForecastBySsa (this Microsoft.ML.ForecastingCatalog catalog, string outputColumnName, string inputColumnName, int windowSize, int seriesLength, int trainSize, int horizon, bool isAdaptive = false, float discountFactor = 1, Microsoft.ML.Transforms.TimeSeries.RankSelectionMethod rankSelectionMethod = Microsoft.ML.Transforms.TimeSeries.RankSelectionMethod.Exact, int? rank = default, int? maxRank = default, bool shouldStabilize = true, bool shouldMaintainInfo = false, Microsoft.ML.Transforms.TimeSeries.GrowthRatio? maxGrowth = default, string confidenceLowerBoundColumn = default, string confidenceUpperBoundColumn = default, float confidenceLevel = 0.95, bool variableHorizon = false);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Transforms.TimeSeries.SsaForecastingEstimator ForecastBySsa(class Microsoft.ML.ForecastingCatalog catalog, string outputColumnName, string inputColumnName, int32 windowSize, int32 seriesLength, int32 trainSize, int32 horizon, bool isAdaptive, float32 discountFactor, valuetype Microsoft.ML.Transforms.TimeSeries.RankSelectionMethod rankSelectionMethod, valuetype System.Nullable`1<int32> rank, valuetype System.Nullable`1<int32> maxRank, bool shouldStabilize, bool shouldMaintainInfo, valuetype System.Nullable`1<valuetype Microsoft.ML.Transforms.TimeSeries.GrowthRatio> maxGrowth, string confidenceLowerBoundColumn, string confidenceUpperBoundColumn, float32 confidenceLevel, bool variableHorizon) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.ForecastBySsa(Microsoft.ML.ForecastingCatalog,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Single,Microsoft.ML.Transforms.TimeSeries.RankSelectionMethod,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,System.Nullable{Microsoft.ML.Transforms.TimeSeries.GrowthRatio},System.String,System.String,System.Single,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ForecastBySsa (catalog As ForecastingCatalog, outputColumnName As String, inputColumnName As String, windowSize As Integer, seriesLength As Integer, trainSize As Integer, horizon As Integer, Optional isAdaptive As Boolean = false, Optional discountFactor As Single = 1, Optional rankSelectionMethod As RankSelectionMethod = Microsoft.ML.Transforms.TimeSeries.RankSelectionMethod.Exact, Optional rank As Nullable(Of Integer) = Nothing, Optional maxRank As Nullable(Of Integer) = Nothing, Optional shouldStabilize As Boolean = true, Optional shouldMaintainInfo As Boolean = false, Optional maxGrowth As Nullable(Of GrowthRatio) = Nothing, Optional confidenceLowerBoundColumn As String = Nothing, Optional confidenceUpperBoundColumn As String = Nothing, Optional confidenceLevel As Single = 0.95, Optional variableHorizon As Boolean = false) As SsaForecastingEstimator" />
<MemberSignature Language="F#" Value="static member ForecastBySsa : Microsoft.ML.ForecastingCatalog * string * string * int * int * int * int * bool * single * Microsoft.ML.Transforms.TimeSeries.RankSelectionMethod * Nullable<int> * Nullable<int> * bool * bool * Nullable<Microsoft.ML.Transforms.TimeSeries.GrowthRatio> * string * string * single * bool -> Microsoft.ML.Transforms.TimeSeries.SsaForecastingEstimator" Usage="Microsoft.ML.TimeSeriesCatalog.ForecastBySsa (catalog, outputColumnName, inputColumnName, windowSize, seriesLength, trainSize, horizon, isAdaptive, discountFactor, rankSelectionMethod, rank, maxRank, shouldStabilize, shouldMaintainInfo, maxGrowth, confidenceLowerBoundColumn, confidenceUpperBoundColumn, confidenceLevel, variableHorizon)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Transforms.TimeSeries.SsaForecastingEstimator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.ForecastingCatalog" RefType="this" />
<Parameter Name="outputColumnName" Type="System.String" />
<Parameter Name="inputColumnName" Type="System.String" />
<Parameter Name="windowSize" Type="System.Int32" />
<Parameter Name="seriesLength" Type="System.Int32" />
<Parameter Name="trainSize" Type="System.Int32" />
<Parameter Name="horizon" Type="System.Int32" />
<Parameter Name="isAdaptive" Type="System.Boolean" />
<Parameter Name="discountFactor" Type="System.Single" />
<Parameter Name="rankSelectionMethod" Type="Microsoft.ML.Transforms.TimeSeries.RankSelectionMethod" />
<Parameter Name="rank" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxRank" Type="System.Nullable<System.Int32>" />
<Parameter Name="shouldStabilize" Type="System.Boolean" />
<Parameter Name="shouldMaintainInfo" Type="System.Boolean" />
<Parameter Name="maxGrowth" Type="System.Nullable<Microsoft.ML.Transforms.TimeSeries.GrowthRatio>" />
<Parameter Name="confidenceLowerBoundColumn" Type="System.String" />
<Parameter Name="confidenceUpperBoundColumn" Type="System.String" />
<Parameter Name="confidenceLevel" Type="System.Single" />
<Parameter Name="variableHorizon" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="catalog">Catalog.</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.
The vector contains Alert, Raw Score, P-Value as first three values.</param>
<param name="windowSize">The length of the window on the series for building the trajectory matrix (parameter L).</param>
<param name="seriesLength">The length of series that is kept in buffer for modeling (parameter N).</param>
<param name="trainSize">The length of series from the beginning used for training.</param>
<param name="horizon">The number of values to forecast.</param>
<param name="isAdaptive">The flag determining whether the model is adaptive.</param>
<param name="discountFactor">The discount factor in [0,1] used for online updates.</param>
<param name="rankSelectionMethod">The rank selection method.</param>
<param name="rank">The desired rank of the subspace used for SSA projection (parameter r). This parameter should be in the range in [1, windowSize].
If set to null, the rank is automatically determined based on prediction error minimization.</param>
<param name="maxRank">The maximum rank considered during the rank selection process. If not provided (i.e. set to null), it is set to windowSize - 1.</param>
<param name="shouldStabilize">The flag determining whether the model should be stabilized.</param>
<param name="shouldMaintainInfo">The flag determining whether the meta information for the model needs to be maintained.</param>
<param name="maxGrowth">The maximum growth on the exponential trend.</param>
<param name="confidenceLowerBoundColumn">The name of the confidence interval lower bound column. If not specified then confidence intervals will not be calculated.</param>
<param name="confidenceUpperBoundColumn">The name of the confidence interval upper bound column. If not specified then confidence intervals will not be calculated.</param>
<param name="confidenceLevel">The confidence level for forecasting.</param>
<param name="variableHorizon">Set this to true if horizon will change after training(at prediction time).</param>
<summary>
Singular Spectrum Analysis (SSA) model for univariate time-series forecasting.
For the details of the model, refer to http://arxiv.org/pdf/1206.6910.pdf.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[Forecasting](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/Forecasting.cs)]
[!code-csharp[ForecastingWithConfidenceInterval](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/ForecastingWithConfidenceInterval.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="LocalizeRootCause">
<MemberSignature Language="C#" Value="public static Microsoft.ML.TimeSeries.RootCause LocalizeRootCause (this Microsoft.ML.AnomalyDetectionCatalog catalog, Microsoft.ML.TimeSeries.RootCauseLocalizationInput src, double beta = 0.3, double rootCauseThreshold = 0.95);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.TimeSeries.RootCause LocalizeRootCause(class Microsoft.ML.AnomalyDetectionCatalog catalog, class Microsoft.ML.TimeSeries.RootCauseLocalizationInput src, float64 beta, float64 rootCauseThreshold) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.LocalizeRootCause(Microsoft.ML.AnomalyDetectionCatalog,Microsoft.ML.TimeSeries.RootCauseLocalizationInput,System.Double,System.Double)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function LocalizeRootCause (catalog As AnomalyDetectionCatalog, src As RootCauseLocalizationInput, Optional beta As Double = 0.3, Optional rootCauseThreshold As Double = 0.95) As RootCause" />
<MemberSignature Language="F#" Value="static member LocalizeRootCause : Microsoft.ML.AnomalyDetectionCatalog * Microsoft.ML.TimeSeries.RootCauseLocalizationInput * double * double -> Microsoft.ML.TimeSeries.RootCause" Usage="Microsoft.ML.TimeSeriesCatalog.LocalizeRootCause (catalog, src, beta, rootCauseThreshold)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.TimeSeries.RootCause</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.AnomalyDetectionCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="src" Type="Microsoft.ML.TimeSeries.RootCauseLocalizationInput" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="beta" Type="System.Double" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="rootCauseThreshold" Type="System.Double" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The anomaly detection catalog.</param>
<param name="src">Root cause's input. The data is an instance of <see cref="T:Microsoft.ML.TimeSeries.RootCauseLocalizationInput" />.</param>
<param name="beta">Beta is a weight parameter for user to choose.
It is used when score is calculated for each root cause item. The range of beta should be in [0,1].
For a larger beta, root cause items which have a large difference between value and expected value will get a high score.
For a small beta, root cause items which have a high relative change will get a low score.</param>
<param name="rootCauseThreshold">A threshold to determine whether the point should be root cause. The range of this threshold should be in [0,1].
If the point's delta is equal to or larger than rootCauseThreshold multiplied by anomaly dimension point's delta, this point is treated as a root cause. Different threshold will turn out different results. Users can choose the delta according to their data and requirments.</param>
<summary>
Create <see cref="T:Microsoft.ML.TimeSeries.RootCause" />, which localizes root causes using decision tree algorithm.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[LocalizeRootCause](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/LocalizeRootCause.cs)]
]]></format>
</example>
</Docs>
</Member>
<Member MemberName="LocalizeRootCauses">
<MemberSignature Language="C#" Value="public static System.Collections.Generic.List<Microsoft.ML.TimeSeries.RootCause> LocalizeRootCauses (this Microsoft.ML.AnomalyDetectionCatalog catalog, Microsoft.ML.TimeSeries.RootCauseLocalizationInput src, double beta = 0.5, double rootCauseThreshold = 0.95);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.Generic.List`1<class Microsoft.ML.TimeSeries.RootCause> LocalizeRootCauses(class Microsoft.ML.AnomalyDetectionCatalog catalog, class Microsoft.ML.TimeSeries.RootCauseLocalizationInput src, float64 beta, float64 rootCauseThreshold) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeriesCatalog.LocalizeRootCauses(Microsoft.ML.AnomalyDetectionCatalog,Microsoft.ML.TimeSeries.RootCauseLocalizationInput,System.Double,System.Double)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function LocalizeRootCauses (catalog As AnomalyDetectionCatalog, src As RootCauseLocalizationInput, Optional beta As Double = 0.5, Optional rootCauseThreshold As Double = 0.95) As List(Of RootCause)" />
<MemberSignature Language="F#" Value="static member LocalizeRootCauses : Microsoft.ML.AnomalyDetectionCatalog * Microsoft.ML.TimeSeries.RootCauseLocalizationInput * double * double -> System.Collections.Generic.List<Microsoft.ML.TimeSeries.RootCause>" Usage="Microsoft.ML.TimeSeriesCatalog.LocalizeRootCauses (catalog, src, beta, rootCauseThreshold)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.List<Microsoft.ML.TimeSeries.RootCause></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="catalog" Type="Microsoft.ML.AnomalyDetectionCatalog" RefType="this" Index="0" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="src" Type="Microsoft.ML.TimeSeries.RootCauseLocalizationInput" Index="1" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="beta" Type="System.Double" Index="2" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
<Parameter Name="rootCauseThreshold" Type="System.Double" Index="3" FrameworkAlternate="ml-dotnet;ml-dotnet-1.5.0;ml-dotnet-1.6.0;ml-dotnet-1.7.0;ml-dotnet-2.0.0" />
</Parameters>
<Docs>
<param name="catalog">The anomaly detection catalog.</param>
<param name="src">Root cause's input. The data is an instance of <see cref="T:Microsoft.ML.TimeSeries.RootCauseLocalizationInput" />.</param>
<param name="beta">Beta is a weight parameter for user to choose. It is used when score is calculated for each root cause item. The range of beta should be in [0,1]. For a larger beta, root cause point which has a large difference between value and expected value will get a high score. On the contrary, for a small beta, root cause items which has a high relative change will get a high score.</param>
<param name="rootCauseThreshold">A threshold to determine whether the point should be root cause. The range of this threshold should be in [0,1].
If the point's delta is equal to or larger than rootCauseThreshold multiplied by anomaly dimension point's delta, this point is treated as a root cause. Different threshold will turn out different results. Users can choose the delta according to their data and requirments.</param>
<summary>
Outputs an ordered list of <see cref="T:Microsoft.ML.TimeSeries.RootCause" />s. The order corresponds to which prepared cause is most likely to be the root cause.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
<format type="text/markdown"><![CDATA[
[!code-csharp[LocalizeRootCauseMultipleDimensions](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Transforms/TimeSeries/LocalizeRootCauseMultipleDimensions.cs)]
]]></format>
</example>
</Docs>
</Member>
</Members>
</Type>