-
Notifications
You must be signed in to change notification settings - Fork 31
/
SdcaNonCalibratedMulticlassTrainer.xml
57 lines (52 loc) · 4.46 KB
/
SdcaNonCalibratedMulticlassTrainer.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
<Type Name="SdcaNonCalibratedMulticlassTrainer" FullName="Microsoft.ML.Trainers.SdcaNonCalibratedMulticlassTrainer">
<TypeSignature Language="C#" Value="public sealed class SdcaNonCalibratedMulticlassTrainer : Microsoft.ML.Trainers.SdcaMulticlassTrainerBase<Microsoft.ML.Trainers.LinearMulticlassModelParameters>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SdcaNonCalibratedMulticlassTrainer extends Microsoft.ML.Trainers.SdcaMulticlassTrainerBase`1<class Microsoft.ML.Trainers.LinearMulticlassModelParameters>" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Trainers.SdcaNonCalibratedMulticlassTrainer" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SdcaNonCalibratedMulticlassTrainer
Inherits SdcaMulticlassTrainerBase(Of LinearMulticlassModelParameters)" />
<TypeSignature Language="F#" Value="type SdcaNonCalibratedMulticlassTrainer = class
 inherit SdcaMulticlassTrainerBase<LinearMulticlassModelParameters>" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ML.Trainers.SdcaMulticlassTrainerBase<Microsoft.ML.Trainers.LinearMulticlassModelParameters></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="TModel">Microsoft.ML.Trainers.LinearMulticlassModelParameters</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>
The<see cref="T:Microsoft.ML.IEstimator`1" /> to predict a target using a linear multiclass classifier.
The trained model <see cref="T:Microsoft.ML.Trainers.LinearMulticlassModelParameters" /> produces probabilities of classes.
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
To create this trainer, use [SdcaMaximumEntropy](xref:Microsoft.ML.StandardTrainersCatalog.SdcaMaximumEntropy(Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers,System.String,System.String,System.String,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Int32})) or
[SdcaMaximumEntropy(Options)](xref:Microsoft.ML.StandardTrainersCatalog.SdcaMaximumEntropy(Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers,Microsoft.ML.Trainers.SdcaMaximumEntropyMulticlassTrainer.Options)).
[!include[io](~/../docs/samples/docs/api-reference/io-columns-multiclass-classification.md)]
### Trainer Characteristics
| | |
| -- | -- |
| Machine learning task | Multiclass classification |
| Is normalization required? | Yes |
| Is caching required? | No |
| Required NuGet in addition to Microsoft.ML | None |
| Exportable to ONNX | Yes |
### Scoring Function
This trains a linear model to solve multiclass classification problems.
Assume that the number of classes is $m$ and number of features is $n$.
It assigns the $c$-th class a coefficient vector $\textbf{w}_c \in {\mathbb R}^n$ and a bias $b_c \in {\mathbb R}$, for $c=1,\dots,m$.
Given a feature vector $\textbf{x} \in {\mathbb R}^n$, the $c$-th class's score would be $\hat{y}^c = \textbf{w}_c^T \textbf{x} + b_c$.
Note that the $c$-th value in the output score column is just $\hat{y}^c$.
### Training Algorithm Details
See the documentation of [SdcaMulticlassTrainerBase](xref:Microsoft.ML.Trainers.SdcaMulticlassTrainerBase).
Check the See Also section for links to usage examples.
]]></format>
</remarks>
<altmember cref="M:Microsoft.ML.StandardTrainersCatalog.SdcaNonCalibrated(Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers,Microsoft.ML.Trainers.SdcaNonCalibratedMulticlassTrainer.Options)" />
<altmember cref="M:Microsoft.ML.StandardTrainersCatalog.SdcaNonCalibrated(Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers,System.String,System.String,System.String,Microsoft.ML.Trainers.ISupportSdcaClassificationLoss,System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Int32})" />
<altmember cref="T:Microsoft.ML.Trainers.SdcaNonCalibratedMulticlassTrainer.Options" />
</Docs>
<Members />
</Type>