LinearModelParameterStatistics.xml

<Type Name="LinearModelParameterStatistics" FullName="Microsoft.ML.Trainers.LinearModelParameterStatistics">
  <TypeSignature Language="C#" Value="public sealed class LinearModelParameterStatistics : Microsoft.ML.Trainers.ModelStatisticsBase" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit LinearModelParameterStatistics extends Microsoft.ML.Trainers.ModelStatisticsBase" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ML.Trainers.LinearModelParameterStatistics" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class LinearModelParameterStatistics&#xA;Inherits ModelStatisticsBase" />
  <TypeSignature Language="F#" Value="type LinearModelParameterStatistics = class&#xA;    inherit ModelStatisticsBase" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.ML.Trainers.ModelStatisticsBase</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Statistics for linear model parameters.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="GetBiasStatistics">
      <MemberSignature Language="C#" Value="public Microsoft.ML.Trainers.CoefficientStatistics GetBiasStatistics ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ML.Trainers.CoefficientStatistics GetBiasStatistics() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.LinearModelParameterStatistics.GetBiasStatistics" />
      <MemberSignature Language="VB.NET" Value="Public Function GetBiasStatistics () As CoefficientStatistics" />
      <MemberSignature Language="F#" Value="member this.GetBiasStatistics : unit -&gt; Microsoft.ML.Trainers.CoefficientStatistics" Usage="linearModelParameterStatistics.GetBiasStatistics " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.Trainers.CoefficientStatistics</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Computes the standart deviation, Z-Score and p-Value for the calculated bias.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetBiasStatisticsForValue">
      <MemberSignature Language="C#" Value="public Microsoft.ML.Trainers.CoefficientStatistics GetBiasStatisticsForValue (float bias);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ML.Trainers.CoefficientStatistics GetBiasStatisticsForValue(float32 bias) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.LinearModelParameterStatistics.GetBiasStatisticsForValue(System.Single)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetBiasStatisticsForValue (bias As Single) As CoefficientStatistics" />
      <MemberSignature Language="F#" Value="member this.GetBiasStatisticsForValue : single -&gt; Microsoft.ML.Trainers.CoefficientStatistics" Usage="linearModelParameterStatistics.GetBiasStatisticsForValue bias" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.Trainers.CoefficientStatistics</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="bias" Type="System.Single" />
      </Parameters>
      <Docs>
        <param name="bias">To be added.</param>
        <summary>
            Computes the standart deviation, Z-Score and p-Value for the value being passed as the bias.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetWeightsCoefficientStatistics">
      <MemberSignature Language="C#" Value="public Microsoft.ML.Trainers.CoefficientStatistics[] GetWeightsCoefficientStatistics (int paramCountCap);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ML.Trainers.CoefficientStatistics[] GetWeightsCoefficientStatistics(int32 paramCountCap) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.LinearModelParameterStatistics.GetWeightsCoefficientStatistics(System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetWeightsCoefficientStatistics (paramCountCap As Integer) As CoefficientStatistics()" />
      <MemberSignature Language="F#" Value="member this.GetWeightsCoefficientStatistics : int -&gt; Microsoft.ML.Trainers.CoefficientStatistics[]" Usage="linearModelParameterStatistics.GetWeightsCoefficientStatistics paramCountCap" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.Trainers.CoefficientStatistics[]</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="paramCountCap" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="paramCountCap">To be added.</param>
        <summary>
            Gets the coefficient statistics as an object.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>