-
Notifications
You must be signed in to change notification settings - Fork 31
/
RootCauseItem.xml
178 lines (178 loc) · 10.7 KB
/
RootCauseItem.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
<Type Name="RootCauseItem" FullName="Microsoft.ML.TimeSeries.RootCauseItem">
<TypeSignature Language="C#" Value="public sealed class RootCauseItem : IEquatable<Microsoft.ML.TimeSeries.RootCauseItem>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RootCauseItem extends System.Object implements class System.IEquatable`1<class Microsoft.ML.TimeSeries.RootCauseItem>" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.TimeSeries.RootCauseItem" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class RootCauseItem
Implements IEquatable(Of RootCauseItem)" />
<TypeSignature Language="F#" Value="type RootCauseItem = class
 interface IEquatable<RootCauseItem>" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IEquatable<Microsoft.ML.TimeSeries.RootCauseItem></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RootCauseItem (System.Collections.Generic.Dictionary<string,object> rootCause);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.Dictionary`2<string, object> rootCause) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeries.RootCauseItem.#ctor(System.Collections.Generic.Dictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (rootCause As Dictionary(Of String, Object))" />
<MemberSignature Language="F#" Value="new Microsoft.ML.TimeSeries.RootCauseItem : System.Collections.Generic.Dictionary<string, obj> -> Microsoft.ML.TimeSeries.RootCauseItem" Usage="new Microsoft.ML.TimeSeries.RootCauseItem rootCause" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="rootCause" Type="System.Collections.Generic.Dictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="rootCause">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RootCauseItem (System.Collections.Generic.Dictionary<string,object> rootCause, System.Collections.Generic.List<string> path);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.Dictionary`2<string, object> rootCause, class System.Collections.Generic.List`1<string> path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeries.RootCauseItem.#ctor(System.Collections.Generic.Dictionary{System.String,System.Object},System.Collections.Generic.List{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (rootCause As Dictionary(Of String, Object), path As List(Of String))" />
<MemberSignature Language="F#" Value="new Microsoft.ML.TimeSeries.RootCauseItem : System.Collections.Generic.Dictionary<string, obj> * System.Collections.Generic.List<string> -> Microsoft.ML.TimeSeries.RootCauseItem" Usage="new Microsoft.ML.TimeSeries.RootCauseItem (rootCause, path)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="rootCause" Type="System.Collections.Generic.Dictionary<System.String,System.Object>" />
<Parameter Name="path" Type="System.Collections.Generic.List<System.String>" />
</Parameters>
<Docs>
<param name="rootCause">To be added.</param>
<param name="path">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dimension">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary<string,object> Dimension;" />
<MemberSignature Language="ILAsm" Value=".field public class System.Collections.Generic.Dictionary`2<string, object> Dimension" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.TimeSeries.RootCauseItem.Dimension" />
<MemberSignature Language="VB.NET" Value="Public Dimension As Dictionary(Of String, Object) " />
<MemberSignature Language="F#" Value="val mutable Dimension : System.Collections.Generic.Dictionary<string, obj>" Usage="Microsoft.ML.TimeSeries.RootCauseItem.Dimension" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>
The dimension for the detected root cause point.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Direction">
<MemberSignature Language="C#" Value="public Microsoft.ML.TimeSeries.AnomalyDirection Direction;" />
<MemberSignature Language="ILAsm" Value=".field public valuetype Microsoft.ML.TimeSeries.AnomalyDirection Direction" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.TimeSeries.RootCauseItem.Direction" />
<MemberSignature Language="VB.NET" Value="Public Direction As AnomalyDirection " />
<MemberSignature Language="F#" Value="val mutable Direction : Microsoft.ML.TimeSeries.AnomalyDirection" Usage="Microsoft.ML.TimeSeries.RootCauseItem.Direction" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.TimeSeries.AnomalyDirection</ReturnType>
</ReturnValue>
<Docs>
<summary>
The direction for the detected root cause point, should be <see cref="T:Microsoft.ML.TimeSeries.AnomalyDirection" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Microsoft.ML.TimeSeries.RootCauseItem other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Microsoft.ML.TimeSeries.RootCauseItem other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.TimeSeries.RootCauseItem.Equals(Microsoft.ML.TimeSeries.RootCauseItem)" />
<MemberSignature Language="VB.NET" Value="Public Function Equals (other As RootCauseItem) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : Microsoft.ML.TimeSeries.RootCauseItem -> bool" Usage="rootCauseItem.Equals other" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Microsoft.ML.TimeSeries.RootCauseItem" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public System.Collections.Generic.List<string> Path;" />
<MemberSignature Language="ILAsm" Value=".field public class System.Collections.Generic.List`1<string> Path" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.TimeSeries.RootCauseItem.Path" />
<MemberSignature Language="VB.NET" Value="Public Path As List(Of String) " />
<MemberSignature Language="F#" Value="val mutable Path : System.Collections.Generic.List<string>" Usage="Microsoft.ML.TimeSeries.RootCauseItem.Path" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.List<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Path is a list of the dimension key that the library selected for you. In this root cause localization library, for one time call for the library, the path will be obtained and the length of path list will always be 1. Different RootCauseItem obtained from one library call will have the same path as it is the best dimension selected for the input.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Score">
<MemberSignature Language="C#" Value="public double Score;" />
<MemberSignature Language="ILAsm" Value=".field public float64 Score" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.TimeSeries.RootCauseItem.Score" />
<MemberSignature Language="VB.NET" Value="Public Score As Double " />
<MemberSignature Language="F#" Value="val mutable Score : double" Usage="Microsoft.ML.TimeSeries.RootCauseItem.Score" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.TimeSeries</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
The score is a value to evaluate the contribution to the anomaly incident. The range is between [0,1]. The larger the score, the root cause contributes the most to the anomaly. The parameter beta has an influence on this score. For how the score is calculated, you can refer to the source code.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>