-
Notifications
You must be signed in to change notification settings - Fork 31
/
ImageClassificationTrainer+TrainMetrics.xml
195 lines (195 loc) · 10.1 KB
/
ImageClassificationTrainer+TrainMetrics.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
<Type Name="ImageClassificationTrainer+TrainMetrics" FullName="Microsoft.ML.Vision.ImageClassificationTrainer+TrainMetrics">
<TypeSignature Language="C#" Value="public sealed class ImageClassificationTrainer.TrainMetrics" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi sealed beforefieldinit ImageClassificationTrainer/TrainMetrics extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ImageClassificationTrainer.TrainMetrics" />
<TypeSignature Language="F#" Value="type ImageClassificationTrainer.TrainMetrics = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
DNN training metrics.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TrainMetrics ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Accuracy">
<MemberSignature Language="C#" Value="public float Accuracy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float32 Accuracy" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.Accuracy" />
<MemberSignature Language="VB.NET" Value="Public Property Accuracy As Single" />
<MemberSignature Language="F#" Value="member this.Accuracy : single with get, set" Usage="Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.Accuracy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
Accuracy of the batch on this <see cref="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.Epoch" />. Higher the better.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BatchProcessedCount">
<MemberSignature Language="C#" Value="public int BatchProcessedCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 BatchProcessedCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.BatchProcessedCount" />
<MemberSignature Language="VB.NET" Value="Public Property BatchProcessedCount As Integer" />
<MemberSignature Language="F#" Value="member this.BatchProcessedCount : int with get, set" Usage="Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.BatchProcessedCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The number of batches processed in an epoch.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CrossEntropy">
<MemberSignature Language="C#" Value="public float CrossEntropy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float32 CrossEntropy" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.CrossEntropy" />
<MemberSignature Language="VB.NET" Value="Public Property CrossEntropy As Single" />
<MemberSignature Language="F#" Value="member this.CrossEntropy : single with get, set" Usage="Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.CrossEntropy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
Cross-Entropy (loss) of the batch on this <see cref="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.Epoch" />. Lower
the better.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DatasetUsed">
<MemberSignature Language="C#" Value="public Microsoft.ML.Vision.ImageClassificationTrainer.ImageClassificationMetrics.Dataset DatasetUsed { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.ML.Vision.ImageClassificationTrainer/ImageClassificationMetrics/Dataset DatasetUsed" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.DatasetUsed" />
<MemberSignature Language="VB.NET" Value="Public Property DatasetUsed As ImageClassificationTrainer.ImageClassificationMetrics.Dataset" />
<MemberSignature Language="F#" Value="member this.DatasetUsed : Microsoft.ML.Vision.ImageClassificationTrainer.ImageClassificationMetrics.Dataset with get, set" Usage="Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.DatasetUsed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Vision.ImageClassificationTrainer+ImageClassificationMetrics+Dataset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates the dataset on which metrics are being reported.
<see cref="T:Microsoft.ML.Vision.ImageClassificationTrainer.ImageClassificationMetrics.Dataset" /></summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Epoch">
<MemberSignature Language="C#" Value="public int Epoch { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Epoch" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.Epoch" />
<MemberSignature Language="VB.NET" Value="Public Property Epoch As Integer" />
<MemberSignature Language="F#" Value="member this.Epoch : int with get, set" Usage="Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.Epoch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The training epoch index for which this metric is reported.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LearningRate">
<MemberSignature Language="C#" Value="public float LearningRate { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float32 LearningRate" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.LearningRate" />
<MemberSignature Language="VB.NET" Value="Public Property LearningRate As Single" />
<MemberSignature Language="F#" Value="member this.LearningRate : single with get, set" Usage="Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.LearningRate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
Learning Rate used for this <see cref="P:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.Epoch" />. Changes for learning rate scheduling.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Vision.ImageClassificationTrainer.TrainMetrics.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="trainMetrics.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Vision</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
String representation of the metrics.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>