FieldAwareFactorizationMachineTrainer+Options.xml

<Type Name="FieldAwareFactorizationMachineTrainer+Options" FullName="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer+Options">
  <TypeSignature Language="C#" Value="public sealed class FieldAwareFactorizationMachineTrainer.Options : Microsoft.ML.Trainers.TrainerInputBaseWithWeight" />
  <TypeSignature Language="ILAsm" Value=".class nested public auto ansi sealed beforefieldinit FieldAwareFactorizationMachineTrainer/Options extends Microsoft.ML.Trainers.TrainerInputBaseWithWeight" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class FieldAwareFactorizationMachineTrainer.Options&#xA;Inherits TrainerInputBaseWithWeight" />
  <TypeSignature Language="F#" Value="type FieldAwareFactorizationMachineTrainer.Options = class&#xA;    inherit TrainerInputBaseWithWeight" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.ML.Trainers.TrainerInputBaseWithWeight</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
      <see cref="T:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options" /> for <see cref="T:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer" /> as used in
            <see cref="M:Microsoft.ML.FactorizationMachineExtensions.FieldAwareFactorizationMachine(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options)" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Options ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ExtraFeatureColumns">
      <MemberSignature Language="C#" Value="public string[] ExtraFeatureColumns;" />
      <MemberSignature Language="ILAsm" Value=".field public string[] ExtraFeatureColumns" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.ExtraFeatureColumns" />
      <MemberSignature Language="VB.NET" Value="Public ExtraFeatureColumns As String() " />
      <MemberSignature Language="F#" Value="val mutable ExtraFeatureColumns : string[]" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.ExtraFeatureColumns" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String[]</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Extra feature column names. The column named <see cref="F:Microsoft.ML.Trainers.TrainerInputBase.FeatureColumnName" /> stores features from the first field.
            The i-th string in <see cref="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.ExtraFeatureColumns" /> stores the name of the (i+1)-th field's feature column.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LambdaLatent">
      <MemberSignature Language="C#" Value="public float LambdaLatent;" />
      <MemberSignature Language="ILAsm" Value=".field public float32 LambdaLatent" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.LambdaLatent" />
      <MemberSignature Language="VB.NET" Value="Public LambdaLatent As Single " />
      <MemberSignature Language="F#" Value="val mutable LambdaLatent : single" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.LambdaLatent" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Regularization coefficient of latent weights.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LambdaLinear">
      <MemberSignature Language="C#" Value="public float LambdaLinear;" />
      <MemberSignature Language="ILAsm" Value=".field public float32 LambdaLinear" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.LambdaLinear" />
      <MemberSignature Language="VB.NET" Value="Public LambdaLinear As Single " />
      <MemberSignature Language="F#" Value="val mutable LambdaLinear : single" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.LambdaLinear" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Regularization coefficient of linear weights.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LatentDimension">
      <MemberSignature Language="C#" Value="public int LatentDimension;" />
      <MemberSignature Language="ILAsm" Value=".field public int32 LatentDimension" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.LatentDimension" />
      <MemberSignature Language="VB.NET" Value="Public LatentDimension As Integer " />
      <MemberSignature Language="F#" Value="val mutable LatentDimension : int" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.LatentDimension" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Latent space dimension.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LearningRate">
      <MemberSignature Language="C#" Value="public float LearningRate;" />
      <MemberSignature Language="ILAsm" Value=".field public float32 LearningRate" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.LearningRate" />
      <MemberSignature Language="VB.NET" Value="Public LearningRate As Single " />
      <MemberSignature Language="F#" Value="val mutable LearningRate : single" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.LearningRate" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Initial learning rate.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NormalizeFeatures">
      <MemberSignature Language="C#" Value="public bool NormalizeFeatures;" />
      <MemberSignature Language="ILAsm" Value=".field public bool NormalizeFeatures" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.NormalizeFeatures" />
      <MemberSignature Language="VB.NET" Value="Public NormalizeFeatures As Boolean " />
      <MemberSignature Language="F#" Value="val mutable NormalizeFeatures : bool" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.NormalizeFeatures" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Whether to normalize the input vectors so that the concatenation of all fields' feature vectors is unit-length.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NumberOfIterations">
      <MemberSignature Language="C#" Value="public int NumberOfIterations;" />
      <MemberSignature Language="ILAsm" Value=".field public int32 NumberOfIterations" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.NumberOfIterations" />
      <MemberSignature Language="VB.NET" Value="Public NumberOfIterations As Integer " />
      <MemberSignature Language="F#" Value="val mutable NumberOfIterations : int" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.NumberOfIterations" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Number of training iterations.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Radius">
      <MemberSignature Language="C#" Value="public float Radius;" />
      <MemberSignature Language="ILAsm" Value=".field public float32 Radius" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.Radius" />
      <MemberSignature Language="VB.NET" Value="Public Radius As Single " />
      <MemberSignature Language="F#" Value="val mutable Radius : single" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.Radius" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Single</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Radius of initial latent factors.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Shuffle">
      <MemberSignature Language="C#" Value="public bool Shuffle;" />
      <MemberSignature Language="ILAsm" Value=".field public bool Shuffle" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.Shuffle" />
      <MemberSignature Language="VB.NET" Value="Public Shuffle As Boolean " />
      <MemberSignature Language="F#" Value="val mutable Shuffle : bool" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.Shuffle" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Whether to shuffle for each training iteration.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Verbose">
      <MemberSignature Language="C#" Value="public bool Verbose;" />
      <MemberSignature Language="ILAsm" Value=".field public bool Verbose" />
      <MemberSignature Language="DocId" Value="F:Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.Verbose" />
      <MemberSignature Language="VB.NET" Value="Public Verbose As Boolean " />
      <MemberSignature Language="F#" Value="val mutable Verbose : bool" Usage="Microsoft.ML.Trainers.FieldAwareFactorizationMachineTrainer.Options.Verbose" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.StandardTrainers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Report traning progress or not.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>