-
Notifications
You must be signed in to change notification settings - Fork 260
/
UnivariateEntireDetectionResult.xml
217 lines (217 loc) · 12.6 KB
/
UnivariateEntireDetectionResult.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
<Type Name="UnivariateEntireDetectionResult" FullName="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult">
<TypeSignature Language="C#" Value="public class UnivariateEntireDetectionResult" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UnivariateEntireDetectionResult extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult" />
<TypeSignature Language="VB.NET" Value="Public Class UnivariateEntireDetectionResult" />
<TypeSignature Language="F#" Value="type UnivariateEntireDetectionResult = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> Response of the entire anomaly detection. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ExpectedValues">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<float> ExpectedValues { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<float32> ExpectedValues" />
<MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.ExpectedValues" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExpectedValues As IReadOnlyList(Of Single)" />
<MemberSignature Language="F#" Value="member this.ExpectedValues : System.Collections.Generic.IReadOnlyList<single>" Usage="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.ExpectedValues" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Single></ReturnType>
</ReturnValue>
<Docs>
<summary>
Expected value for each input point. The index of the
array is consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAnomaly">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<bool> IsAnomaly { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<bool> IsAnomaly" />
<MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.IsAnomaly" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsAnomaly As IReadOnlyList(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsAnomaly : System.Collections.Generic.IReadOnlyList<bool>" Usage="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.IsAnomaly" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Anomaly properties for each input point. True means an
anomaly (either negative or positive) has been detected. The index of the array
is consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsNegativeAnomaly">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<bool> IsNegativeAnomaly { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<bool> IsNegativeAnomaly" />
<MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.IsNegativeAnomaly" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsNegativeAnomaly As IReadOnlyList(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsNegativeAnomaly : System.Collections.Generic.IReadOnlyList<bool>" Usage="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.IsNegativeAnomaly" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Anomaly status in a negative direction for each input
point. True means a negative anomaly has been detected. A negative anomaly
means the point is detected as an anomaly and its real value is smaller than
the expected one. The index of the array is consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsPositiveAnomaly">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<bool> IsPositiveAnomaly { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<bool> IsPositiveAnomaly" />
<MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.IsPositiveAnomaly" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsPositiveAnomaly As IReadOnlyList(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsPositiveAnomaly : System.Collections.Generic.IReadOnlyList<bool>" Usage="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.IsPositiveAnomaly" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Anomaly status in a positive direction for each input
point. True means a positive anomaly has been detected. A positive anomaly
means the point is detected as an anomaly and its real value is larger than the
expected one. The index of the array is consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LowerMargins">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<float> LowerMargins { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<float32> LowerMargins" />
<MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.LowerMargins" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LowerMargins As IReadOnlyList(Of Single)" />
<MemberSignature Language="F#" Value="member this.LowerMargins : System.Collections.Generic.IReadOnlyList<single>" Usage="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.LowerMargins" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Single></ReturnType>
</ReturnValue>
<Docs>
<summary>
Lower margin of each input point. LowerMargin is used to
calculate lowerBoundary, which is equal to expectedValue - (100 -
marginScale)*lowerMargin. Points between the boundary can be marked as normal
ones on the client side. The index of the array is consistent with the input
series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Period">
<MemberSignature Language="C#" Value="public int Period { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Period" />
<MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.Period" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Period As Integer" />
<MemberSignature Language="F#" Value="member this.Period : int" Usage="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.Period" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Frequency extracted from the series. Zero means no recurrent pattern has been
found.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Severity">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<float> Severity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<float32> Severity" />
<MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.Severity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Severity As IReadOnlyList(Of Single)" />
<MemberSignature Language="F#" Value="member this.Severity : System.Collections.Generic.IReadOnlyList<single>" Usage="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.Severity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Single></ReturnType>
</ReturnValue>
<Docs>
<summary>
Severity score for each input point. The larger the value is, the more
severe the anomaly is. For normal points, the severity is always 0.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpperMargins">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<float> UpperMargins { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<float32> UpperMargins" />
<MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.UpperMargins" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UpperMargins As IReadOnlyList(Of Single)" />
<MemberSignature Language="F#" Value="member this.UpperMargins : System.Collections.Generic.IReadOnlyList<single>" Usage="Azure.AI.AnomalyDetector.UnivariateEntireDetectionResult.UpperMargins" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Single></ReturnType>
</ReturnValue>
<Docs>
<summary>
Upper margin of each input point. UpperMargin is used to
calculate upperBoundary, which is equal to expectedValue + (100 -
marginScale)*upperMargin. Anomalies in the response can be filtered by
upperBoundary and lowerBoundary. Adjusting the marginScale value can help filter less
significant anomalies on the client side. The index of the array is
consistent with the input series.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>