TrialResult.xml

<Type Name="TrialResult" FullName="Microsoft.ML.AutoML.TrialResult">
  <TypeSignature Language="C#" Value="public class TrialResult : System.Collections.Generic.IEqualityComparer&lt;Microsoft.ML.AutoML.TrialResult&gt;" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TrialResult extends System.Object implements class System.Collections.Generic.IEqualityComparer`1&lt;class Microsoft.ML.AutoML.TrialResult&gt;" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ML.AutoML.TrialResult" />
  <TypeSignature Language="VB.NET" Value="Public Class TrialResult&#xA;Implements IEqualityComparer(Of TrialResult)" />
  <TypeSignature Language="F#" Value="type TrialResult = class&#xA;    interface IEqualityComparer&lt;TrialResult&gt;" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.Collections.Generic.IEqualityComparer&lt;Microsoft.ML.AutoML.TrialResult&gt;</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>To be added.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public TrialResult ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.AutoML.TrialResult.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DurationInMilliseconds">
      <MemberSignature Language="C#" Value="public double DurationInMilliseconds { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 DurationInMilliseconds" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.AutoML.TrialResult.DurationInMilliseconds" />
      <MemberSignature Language="VB.NET" Value="Public Property DurationInMilliseconds As Double" />
      <MemberSignature Language="F#" Value="member this.DurationInMilliseconds : double with get, set" Usage="Microsoft.ML.AutoML.TrialResult.DurationInMilliseconds" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public bool Equals (Microsoft.ML.AutoML.TrialResult x, Microsoft.ML.AutoML.TrialResult y);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Microsoft.ML.AutoML.TrialResult x, class Microsoft.ML.AutoML.TrialResult y) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.AutoML.TrialResult.Equals(Microsoft.ML.AutoML.TrialResult,Microsoft.ML.AutoML.TrialResult)" />
      <MemberSignature Language="VB.NET" Value="Public Function Equals (x As TrialResult, y As TrialResult) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : Microsoft.ML.AutoML.TrialResult * Microsoft.ML.AutoML.TrialResult -&gt; bool" Usage="trialResult.Equals (x, y)" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.Collections.Generic.IEqualityComparer`1.Equals(`0,`0)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="x" Type="Microsoft.ML.AutoML.TrialResult" />
        <Parameter Name="y" Type="Microsoft.ML.AutoML.TrialResult" />
      </Parameters>
      <Docs>
        <param name="x">To be added.</param>
        <param name="y">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public int GetHashCode (Microsoft.ML.AutoML.TrialResult obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetHashCode(class Microsoft.ML.AutoML.TrialResult obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.AutoML.TrialResult.GetHashCode(Microsoft.ML.AutoML.TrialResult)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetHashCode (obj As TrialResult) As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : Microsoft.ML.AutoML.TrialResult -&gt; int" Usage="trialResult.GetHashCode obj" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.Collections.Generic.IEqualityComparer`1.GetHashCode(`0)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="Microsoft.ML.AutoML.TrialResult" />
      </Parameters>
      <Docs>
        <param name="obj">To be added.</param>
        <summary>
            compute hash code based on trial ID only.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Loss">
      <MemberSignature Language="C#" Value="public double Loss { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Loss" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.AutoML.TrialResult.Loss" />
      <MemberSignature Language="VB.NET" Value="Public Property Loss As Double" />
      <MemberSignature Language="F#" Value="member this.Loss : double with get, set" Usage="Microsoft.ML.AutoML.TrialResult.Loss" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            the loss for current trial, which is smaller the better. This value will be used to fit smart tuners in <see cref="T:Microsoft.ML.AutoML.AutoMLExperiment" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Metric">
      <MemberSignature Language="C#" Value="public double Metric { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Metric" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.AutoML.TrialResult.Metric" />
      <MemberSignature Language="VB.NET" Value="Public Property Metric As Double" />
      <MemberSignature Language="F#" Value="member this.Metric : double with get, set" Usage="Microsoft.ML.AutoML.TrialResult.Metric" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Evaluation result.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Model">
      <MemberSignature Language="C#" Value="public Microsoft.ML.ITransformer Model { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ML.ITransformer Model" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.AutoML.TrialResult.Model" />
      <MemberSignature Language="VB.NET" Value="Public Property Model As ITransformer" />
      <MemberSignature Language="F#" Value="member this.Model : Microsoft.ML.ITransformer with get, set" Usage="Microsoft.ML.AutoML.TrialResult.Model" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.ITransformer</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PeakCpu">
      <MemberSignature Language="C#" Value="public double? PeakCpu { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;float64&gt; PeakCpu" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.AutoML.TrialResult.PeakCpu" />
      <MemberSignature Language="VB.NET" Value="Public Property PeakCpu As Nullable(Of Double)" />
      <MemberSignature Language="F#" Value="member this.PeakCpu : Nullable&lt;double&gt; with get, set" Usage="Microsoft.ML.AutoML.TrialResult.PeakCpu" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Double&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PeakMemoryInMegaByte">
      <MemberSignature Language="C#" Value="public double? PeakMemoryInMegaByte { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;float64&gt; PeakMemoryInMegaByte" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.AutoML.TrialResult.PeakMemoryInMegaByte" />
      <MemberSignature Language="VB.NET" Value="Public Property PeakMemoryInMegaByte As Nullable(Of Double)" />
      <MemberSignature Language="F#" Value="member this.PeakMemoryInMegaByte : Nullable&lt;double&gt; with get, set" Usage="Microsoft.ML.AutoML.TrialResult.PeakMemoryInMegaByte" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Double&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TrialSettings">
      <MemberSignature Language="C#" Value="public Microsoft.ML.AutoML.TrialSettings TrialSettings { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ML.AutoML.TrialSettings TrialSettings" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.AutoML.TrialResult.TrialSettings" />
      <MemberSignature Language="VB.NET" Value="Public Property TrialSettings As TrialSettings" />
      <MemberSignature Language="F#" Value="member this.TrialSettings : Microsoft.ML.AutoML.TrialSettings with get, set" Usage="Microsoft.ML.AutoML.TrialResult.TrialSettings" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.AutoML</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.AutoML.TrialSettings</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>