BinaryPrecisionRecallDataPoint.xml

<Type Name="BinaryPrecisionRecallDataPoint" FullName="Microsoft.ML.Data.BinaryPrecisionRecallDataPoint">
  <TypeSignature Language="C#" Value="public sealed class BinaryPrecisionRecallDataPoint" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit BinaryPrecisionRecallDataPoint extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ML.Data.BinaryPrecisionRecallDataPoint" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class BinaryPrecisionRecallDataPoint" />
  <TypeSignature Language="F#" Value="type BinaryPrecisionRecallDataPoint = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ML.Data</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            This class represents one data point on Precision-Recall curve for binary classification.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="FalsePositiveRate">
      <MemberSignature Language="C#" Value="public double FalsePositiveRate { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 FalsePositiveRate" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.FalsePositiveRate" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property FalsePositiveRate As Double" />
      <MemberSignature Language="F#" Value="member this.FalsePositiveRate : double" Usage="Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.FalsePositiveRate" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Data</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the false positive rate for the given threshold.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Precision">
      <MemberSignature Language="C#" Value="public double Precision { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Precision" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.Precision" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Precision As Double" />
      <MemberSignature Language="F#" Value="member this.Precision : double" Usage="Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.Precision" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Data</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the precision for the current threshold.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Recall">
      <MemberSignature Language="C#" Value="public double Recall { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Recall" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.Recall" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Recall As Double" />
      <MemberSignature Language="F#" Value="member this.Recall : double" Usage="Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.Recall" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Data</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the recall for the current threshold.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Threshold">
      <MemberSignature Language="C#" Value="public double Threshold { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Threshold" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.Threshold" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Threshold As Double" />
      <MemberSignature Language="F#" Value="member this.Threshold : double" Usage="Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.Threshold" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Data</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the threshold for this data point.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TruePositiveRate">
      <MemberSignature Language="C#" Value="public double TruePositiveRate { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 TruePositiveRate" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.TruePositiveRate" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TruePositiveRate As Double" />
      <MemberSignature Language="F#" Value="member this.TruePositiveRate : double" Usage="Microsoft.ML.Data.BinaryPrecisionRecallDataPoint.TruePositiveRate" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Data</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the true positive rate for the current threshold.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>