/
LightGbmRankingTrainer.xml
79 lines (76 loc) · 6.75 KB
/
LightGbmRankingTrainer.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
<Type Name="LightGbmRankingTrainer" FullName="Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer">
<TypeSignature Language="C#" Value="public sealed class LightGbmRankingTrainer : Microsoft.ML.Trainers.LightGbm.LightGbmTrainerBase<Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer.Options,float,Microsoft.ML.Data.RankingPredictionTransformer<Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters>,Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit LightGbmRankingTrainer extends Microsoft.ML.Trainers.LightGbm.LightGbmTrainerBase`4<class Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer/Options, float32, class Microsoft.ML.Data.RankingPredictionTransformer`1<class Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters>, class Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters>" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class LightGbmRankingTrainer
Inherits LightGbmTrainerBase(Of LightGbmRankingTrainer.Options, Single, RankingPredictionTransformer(Of LightGbmRankingModelParameters), LightGbmRankingModelParameters)" />
<TypeSignature Language="F#" Value="type LightGbmRankingTrainer = class
 inherit LightGbmTrainerBase<LightGbmRankingTrainer.Options, single, RankingPredictionTransformer<LightGbmRankingModelParameters>, LightGbmRankingModelParameters>" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.LightGbm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ML.Trainers.LightGbm.LightGbmTrainerBase<Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer+Options,System.Single,Microsoft.ML.Data.RankingPredictionTransformer<Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters>,Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="TOptions">Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer+Options</BaseTypeArgument>
<BaseTypeArgument TypeParamName="TOutput">System.Single</BaseTypeArgument>
<BaseTypeArgument TypeParamName="TTransformer">Microsoft.ML.Data.RankingPredictionTransformer<Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters></BaseTypeArgument>
<BaseTypeArgument TypeParamName="TModel">Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>
The <see cref="T:Microsoft.ML.IEstimator`1" /> for training a boosted decision tree ranking model using LightGBM.
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
To create this trainer, use [LightGbm](xref:Microsoft.ML.LightGbmExtensions.LightGbm(Microsoft.ML.RankingCatalog.RankingTrainers,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Int32))
or [LightGbm(Options)](xref:Microsoft.ML.LightGbmExtensions.LightGbm(Microsoft.ML.RankingCatalog.RankingTrainers,Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer.Options)).
[!include[io](~/../docs/samples/docs/api-reference/io-columns-ranking.md)]
### Trainer Characteristics
| | |
| -- | -- |
| Machine learning task | Ranking |
| Is normalization required? | No |
| Is caching required? | No |
| Required NuGet in addition to Microsoft.ML | Microsoft.ML.LightGbm |
| Exportable to ONNX | No |
[!include[algorithm](~/../docs/samples/docs/api-reference/algo-details-lightgbm.md)]
]]></format>
</remarks>
<altmember cref="M:Microsoft.ML.LightGbmExtensions.LightGbm(Microsoft.ML.RankingCatalog.RankingTrainers,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Int32)" />
<altmember cref="M:Microsoft.ML.LightGbmExtensions.LightGbm(Microsoft.ML.RankingCatalog.RankingTrainers,Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer.Options)" />
<altmember cref="T:Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer.Options" />
</Docs>
<Members>
<Member MemberName="Fit">
<MemberSignature Language="C#" Value="public Microsoft.ML.Data.RankingPredictionTransformer<Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters> Fit (Microsoft.ML.IDataView trainData, Microsoft.ML.IDataView validationData);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ML.Data.RankingPredictionTransformer`1<class Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters> Fit(class Microsoft.ML.IDataView trainData, class Microsoft.ML.IDataView validationData) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer.Fit(Microsoft.ML.IDataView,Microsoft.ML.IDataView)" />
<MemberSignature Language="VB.NET" Value="Public Function Fit (trainData As IDataView, validationData As IDataView) As RankingPredictionTransformer(Of LightGbmRankingModelParameters)" />
<MemberSignature Language="F#" Value="override this.Fit : Microsoft.ML.IDataView * Microsoft.ML.IDataView -> Microsoft.ML.Data.RankingPredictionTransformer<Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters>" Usage="lightGbmRankingTrainer.Fit (trainData, validationData)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.LightGbm</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Data.RankingPredictionTransformer<Microsoft.ML.Trainers.LightGbm.LightGbmRankingModelParameters></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="trainData" Type="Microsoft.ML.IDataView" />
<Parameter Name="validationData" Type="Microsoft.ML.IDataView" />
</Parameters>
<Docs>
<param name="trainData">To be added.</param>
<param name="validationData">To be added.</param>
<summary>
Trains a <see cref="T:Microsoft.ML.Trainers.LightGbm.LightGbmRankingTrainer" /> using both training and validation data, returns
a <see cref="T:Microsoft.ML.Data.RankingPredictionTransformer`1" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>