-
Notifications
You must be signed in to change notification settings - Fork 31
/
SymbolicSgdLogisticRegressionBinaryTrainer+Options.xml
232 lines (232 loc) · 12.6 KB
/
SymbolicSgdLogisticRegressionBinaryTrainer+Options.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
<Type Name="SymbolicSgdLogisticRegressionBinaryTrainer+Options" FullName="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer+Options">
<TypeSignature Language="C#" Value="public sealed class SymbolicSgdLogisticRegressionBinaryTrainer.Options : Microsoft.ML.Trainers.TrainerInputBaseWithLabel" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi sealed beforefieldinit SymbolicSgdLogisticRegressionBinaryTrainer/Options extends Microsoft.ML.Trainers.TrainerInputBaseWithLabel" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SymbolicSgdLogisticRegressionBinaryTrainer.Options
Inherits TrainerInputBaseWithLabel" />
<TypeSignature Language="F#" Value="type SymbolicSgdLogisticRegressionBinaryTrainer.Options = class
 inherit TrainerInputBaseWithLabel" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ML.Trainers.TrainerInputBaseWithLabel</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options for the <see cref="T:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer" /> as used in
<see cref="M:Microsoft.ML.MklComponentsCatalog.SymbolicSgdLogisticRegression(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options)" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Options ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="L2Regularization">
<MemberSignature Language="C#" Value="public float L2Regularization;" />
<MemberSignature Language="ILAsm" Value=".field public float32 L2Regularization" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.L2Regularization" />
<MemberSignature Language="VB.NET" Value="Public L2Regularization As Single " />
<MemberSignature Language="F#" Value="val mutable L2Regularization : single" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.L2Regularization" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
L2 regularization.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LearningRate">
<MemberSignature Language="C#" Value="public float? LearningRate;" />
<MemberSignature Language="ILAsm" Value=".field public valuetype System.Nullable`1<float32> LearningRate" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.LearningRate" />
<MemberSignature Language="VB.NET" Value="Public LearningRate As Nullable(Of Single) " />
<MemberSignature Language="F#" Value="val mutable LearningRate : Nullable<single>" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.LearningRate" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Single></ReturnType>
</ReturnValue>
<Docs>
<summary>
Learning rate. A larger value can potentially reduce the training time but incur numerical instability and over-fitting.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MemorySize">
<MemberSignature Language="C#" Value="public long MemorySize;" />
<MemberSignature Language="ILAsm" Value=".field public int64 MemorySize" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.MemorySize" />
<MemberSignature Language="VB.NET" Value="Public MemorySize As Long " />
<MemberSignature Language="F#" Value="val mutable MemorySize : int64" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.MemorySize" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
The acceleration memory budget in MB.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NumberOfIterations">
<MemberSignature Language="C#" Value="public int NumberOfIterations;" />
<MemberSignature Language="ILAsm" Value=".field public int32 NumberOfIterations" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.NumberOfIterations" />
<MemberSignature Language="VB.NET" Value="Public NumberOfIterations As Integer " />
<MemberSignature Language="F#" Value="val mutable NumberOfIterations : int" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.NumberOfIterations" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Number of passes over the data.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NumberOfThreads">
<MemberSignature Language="C#" Value="public int? NumberOfThreads;" />
<MemberSignature Language="ILAsm" Value=".field public valuetype System.Nullable`1<int32> NumberOfThreads" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.NumberOfThreads" />
<MemberSignature Language="VB.NET" Value="Public NumberOfThreads As Nullable(Of Integer) " />
<MemberSignature Language="F#" Value="val mutable NumberOfThreads : Nullable<int>" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.NumberOfThreads" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Degree of lock-free parallelism. Determinism not guaranteed if this is set to higher than 1.
The default value is the number of logical cores that are available on the system.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PositiveInstanceWeight">
<MemberSignature Language="C#" Value="public float PositiveInstanceWeight;" />
<MemberSignature Language="ILAsm" Value=".field public float32 PositiveInstanceWeight" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.PositiveInstanceWeight" />
<MemberSignature Language="VB.NET" Value="Public PositiveInstanceWeight As Single " />
<MemberSignature Language="F#" Value="val mutable PositiveInstanceWeight : single" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.PositiveInstanceWeight" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
Apply weight to the positive class, for imbalanced data.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Shuffle">
<MemberSignature Language="C#" Value="public bool Shuffle;" />
<MemberSignature Language="ILAsm" Value=".field public bool Shuffle" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.Shuffle" />
<MemberSignature Language="VB.NET" Value="Public Shuffle As Boolean " />
<MemberSignature Language="F#" Value="val mutable Shuffle : bool" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.Shuffle" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Set to <see langword="true" /> causes the data to shuffle.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Tolerance">
<MemberSignature Language="C#" Value="public float Tolerance;" />
<MemberSignature Language="ILAsm" Value=".field public float32 Tolerance" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.Tolerance" />
<MemberSignature Language="VB.NET" Value="Public Tolerance As Single " />
<MemberSignature Language="F#" Value="val mutable Tolerance : single" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.Tolerance" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
Tolerance for difference in average loss in consecutive passes.
If the reduction on loss is smaller than the specified tolerance in one iteration, the training process will be terminated.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateFrequency">
<MemberSignature Language="C#" Value="public int? UpdateFrequency;" />
<MemberSignature Language="ILAsm" Value=".field public valuetype System.Nullable`1<int32> UpdateFrequency" />
<MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.UpdateFrequency" />
<MemberSignature Language="VB.NET" Value="Public UpdateFrequency As Nullable(Of Integer) " />
<MemberSignature Language="F#" Value="val mutable UpdateFrequency : Nullable<int>" Usage="Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options.UpdateFrequency" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Mkl.Components</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
The number of iterations each thread learns a local model until combining it with the
global model. Low value means more updated global model and high value means less cache traffic.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>