EarlyStoppingRuleBase.xml

<Type Name="EarlyStoppingRuleBase" FullName="Microsoft.ML.Trainers.FastTree.EarlyStoppingRuleBase">
  <TypeSignature Language="C#" Value="public abstract class EarlyStoppingRuleBase" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit EarlyStoppingRuleBase extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ML.Trainers.FastTree.EarlyStoppingRuleBase" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class EarlyStoppingRuleBase" />
  <TypeSignature Language="F#" Value="type EarlyStoppingRuleBase = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ML.FastTree</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Early stopping rule used to terminate training process once meeting a specified criterion.
            Used for setting <see cref="T:Microsoft.ML.Trainers.FastTree.EarlyStoppingRule" /><see cref="P:Microsoft.ML.Trainers.FastTree.BoostedTreeOptions.EarlyStoppingRule" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="CheckScore">
      <MemberSignature Language="C#" Value="public abstract bool CheckScore (float validationScore, float trainingScore, out bool isBestCandidate);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool CheckScore(float32 validationScore, float32 trainingScore, [out] bool&amp; isBestCandidate) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.FastTree.EarlyStoppingRuleBase.CheckScore(System.Single,System.Single,System.Boolean@)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function CheckScore (validationScore As Single, trainingScore As Single, ByRef isBestCandidate As Boolean) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member CheckScore : single * single * bool -&gt; bool" Usage="earlyStoppingRuleBase.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">A non negative number. Higher score means better result unless "_lowerIsBetter" is true.</param>
        <param name="trainingScore">A non negative number. Higher score means better result unless "_lowerIsBetter" is true.</param>
        <param name="isBestCandidate">True if the current result is the best ever.</param>
        <summary>
            Check if the learning should stop or not.
            </summary>
        <returns>If true, the learning should stop.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>