-
Notifications
You must be signed in to change notification settings - Fork 31
/
GeneralityLossRule.xml
100 lines (100 loc) · 5.66 KB
/
GeneralityLossRule.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
<Type Name="GeneralityLossRule" FullName="Microsoft.ML.Trainers.FastTree.GeneralityLossRule">
<TypeSignature Language="C#" Value="public sealed class GeneralityLossRule : Microsoft.ML.Trainers.FastTree.EarlyStoppingRule" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit GeneralityLossRule extends Microsoft.ML.Trainers.FastTree.EarlyStoppingRule" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Trainers.FastTree.GeneralityLossRule" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class GeneralityLossRule
Inherits EarlyStoppingRule" />
<TypeSignature Language="F#" Value="type GeneralityLossRule = class
 inherit EarlyStoppingRule" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.FastTree</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ML.Trainers.FastTree.EarlyStoppingRule</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Loss of Generality (GL).
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GeneralityLossRule (float threshold = 0.01);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float32 threshold) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.FastTree.GeneralityLossRule.#ctor(System.Single)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional threshold As Single = 0.01)" />
<MemberSignature Language="F#" Value="new Microsoft.ML.Trainers.FastTree.GeneralityLossRule : single -> Microsoft.ML.Trainers.FastTree.GeneralityLossRule" Usage="new Microsoft.ML.Trainers.FastTree.GeneralityLossRule threshold" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.FastTree</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="threshold" Type="System.Single" />
</Parameters>
<Docs>
<param name="threshold">The maximum gap (in percentage such as 0.01 for 1% and 0.5 for 50%) between the (current) validation
score and its best historical value.</param>
<summary>
Create a rule which may terminate the training process in case of loss of generality. The loss of generality means
the specified score on validation start increasing.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CheckScore">
<MemberSignature Language="C#" Value="public override bool CheckScore (float validationScore, float trainingScore, out bool isBestCandidate);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CheckScore(float32 validationScore, float32 trainingScore, [out] bool& isBestCandidate) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.FastTree.GeneralityLossRule.CheckScore(System.Single,System.Single,System.Boolean@)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CheckScore (validationScore As Single, trainingScore As Single, ByRef isBestCandidate As Boolean) As Boolean" />
<MemberSignature Language="F#" Value="override this.CheckScore : single * single * bool -> bool" Usage="generalityLossRule.CheckScore (validationScore, trainingScore, isBestCandidate)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.FastTree</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="validationScore" Type="System.Single" />
<Parameter Name="trainingScore" Type="System.Single" />
<Parameter Name="isBestCandidate" Type="System.Boolean" RefType="out" />
</Parameters>
<Docs>
<param name="validationScore">To be added.</param>
<param name="trainingScore">To be added.</param>
<param name="isBestCandidate">To be added.</param>
<summary>
See <see cref="M:Microsoft.ML.Trainers.FastTree.EarlyStoppingRuleBase.CheckScore(System.Single,System.Single,System.Boolean@)" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Threshold">
<MemberSignature Language="C#" Value="public float Threshold { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float32 Threshold" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Trainers.FastTree.GeneralityLossRule.Threshold" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Threshold As Single" />
<MemberSignature Language="F#" Value="member this.Threshold : single" Usage="Microsoft.ML.Trainers.FastTree.GeneralityLossRule.Threshold" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.FastTree</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum gap (in percentage such as 0.01 for 1% and 0.5 for 50%) between the (current) validation
score and its best historical value.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>