RegressionCatalog.xml

<Type Name="RegressionCatalog" FullName="Microsoft.ML.RegressionCatalog">
  <TypeSignature Language="C#" Value="public sealed class RegressionCatalog : Microsoft.ML.TrainCatalogBase" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RegressionCatalog extends Microsoft.ML.TrainCatalogBase" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ML.RegressionCatalog" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class RegressionCatalog&#xA;Inherits TrainCatalogBase" />
  <TypeSignature Language="F#" Value="type RegressionCatalog = class&#xA;    inherit TrainCatalogBase" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ML.Data</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.ML.TrainCatalogBase</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Class used by <see cref="T:Microsoft.ML.MLContext" /> to create instances of regression components,
            such as trainers and evaluators.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="CrossValidate">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList&lt;Microsoft.ML.TrainCatalogBase.CrossValidationResult&lt;Microsoft.ML.Data.RegressionMetrics&gt;&gt; CrossValidate (Microsoft.ML.IDataView data, Microsoft.ML.IEstimator&lt;Microsoft.ML.ITransformer&gt; estimator, int numberOfFolds = 5, string labelColumnName = &quot;Label&quot;, string samplingKeyColumnName = default, int? seed = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IReadOnlyList`1&lt;class Microsoft.ML.TrainCatalogBase/CrossValidationResult`1&lt;class Microsoft.ML.Data.RegressionMetrics&gt;&gt; CrossValidate(class Microsoft.ML.IDataView data, class Microsoft.ML.IEstimator`1&lt;class Microsoft.ML.ITransformer&gt; estimator, int32 numberOfFolds, string labelColumnName, string samplingKeyColumnName, valuetype System.Nullable`1&lt;int32&gt; seed) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.RegressionCatalog.CrossValidate(Microsoft.ML.IDataView,Microsoft.ML.IEstimator{Microsoft.ML.ITransformer},System.Int32,System.String,System.String,System.Nullable{System.Int32})" />
      <MemberSignature Language="VB.NET" Value="Public Function CrossValidate (data As IDataView, estimator As IEstimator(Of ITransformer), Optional numberOfFolds As Integer = 5, Optional labelColumnName As String = &quot;Label&quot;, Optional samplingKeyColumnName As String = Nothing, Optional seed As Nullable(Of Integer) = Nothing) As IReadOnlyList(Of TrainCatalogBase.CrossValidationResult(Of RegressionMetrics))" />
      <MemberSignature Language="F#" Value="member this.CrossValidate : Microsoft.ML.IDataView * Microsoft.ML.IEstimator&lt;Microsoft.ML.ITransformer&gt; * int * string * string * Nullable&lt;int&gt; -&gt; System.Collections.Generic.IReadOnlyList&lt;Microsoft.ML.TrainCatalogBase.CrossValidationResult&lt;Microsoft.ML.Data.RegressionMetrics&gt;&gt;" Usage="regressionCatalog.CrossValidate (data, estimator, numberOfFolds, labelColumnName, samplingKeyColumnName, seed)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Data</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IReadOnlyList&lt;Microsoft.ML.TrainCatalogBase+CrossValidationResult&lt;Microsoft.ML.Data.RegressionMetrics&gt;&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="data" Type="Microsoft.ML.IDataView" />
        <Parameter Name="estimator" Type="Microsoft.ML.IEstimator&lt;Microsoft.ML.ITransformer&gt;" />
        <Parameter Name="numberOfFolds" Type="System.Int32" />
        <Parameter Name="labelColumnName" Type="System.String" />
        <Parameter Name="samplingKeyColumnName" Type="System.String" />
        <Parameter Name="seed" Type="System.Nullable&lt;System.Int32&gt;" />
      </Parameters>
      <Docs>
        <param name="data">The data to run cross-validation on.</param>
        <param name="estimator">The estimator to fit.</param>
        <param name="numberOfFolds">Number of cross-validation folds.</param>
        <param name="labelColumnName">The label column (for evaluation).</param>
        <param name="samplingKeyColumnName">Name of a column to use for grouping rows. If two examples share the same value of the <paramref name="samplingKeyColumnName" />,
            they are guaranteed to appear in the same subset (train or test). This can be used to ensure no label leakage from the train to the test set.
            If <see langword="null" /> no row grouping will be performed.</param>
        <param name="seed">Seed for the random number generator used to select rows for cross-validation folds.</param>
        <summary>
            Run cross-validation over <paramref name="numberOfFolds" /> folds of <paramref name="data" />, by fitting <paramref name="estimator" />,
            and respecting <paramref name="samplingKeyColumnName" /> if provided.
            Then evaluate each sub-model against <paramref name="labelColumnName" /> and return metrics.
            </summary>
        <returns>Per-fold results: metrics, models, scored datasets.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Evaluate">
      <MemberSignature Language="C#" Value="public Microsoft.ML.Data.RegressionMetrics Evaluate (Microsoft.ML.IDataView data, string labelColumnName = &quot;Label&quot;, string scoreColumnName = &quot;Score&quot;);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ML.Data.RegressionMetrics Evaluate(class Microsoft.ML.IDataView data, string labelColumnName, string scoreColumnName) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.RegressionCatalog.Evaluate(Microsoft.ML.IDataView,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function Evaluate (data As IDataView, Optional labelColumnName As String = &quot;Label&quot;, Optional scoreColumnName As String = &quot;Score&quot;) As RegressionMetrics" />
      <MemberSignature Language="F#" Value="member this.Evaluate : Microsoft.ML.IDataView * string * string -&gt; Microsoft.ML.Data.RegressionMetrics" Usage="regressionCatalog.Evaluate (data, labelColumnName, scoreColumnName)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Data</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.Data.RegressionMetrics</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="data" Type="Microsoft.ML.IDataView" />
        <Parameter Name="labelColumnName" Type="System.String" />
        <Parameter Name="scoreColumnName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="data">The scored data.</param>
        <param name="labelColumnName">The name of the label column in <paramref name="data" />.</param>
        <param name="scoreColumnName">The name of the score column in <paramref name="data" />.</param>
        <summary>
            Evaluates scored regression data.
            </summary>
        <returns>The evaluation results for these calibrated outputs.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Trainers">
      <MemberSignature Language="C#" Value="public Microsoft.ML.RegressionCatalog.RegressionTrainers Trainers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ML.RegressionCatalog/RegressionTrainers Trainers" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ML.RegressionCatalog.Trainers" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Trainers As RegressionCatalog.RegressionTrainers" />
      <MemberSignature Language="F#" Value="member this.Trainers : Microsoft.ML.RegressionCatalog.RegressionTrainers" Usage="Microsoft.ML.RegressionCatalog.Trainers" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Data</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.RegressionCatalog+RegressionTrainers</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The list of trainers for performing regression.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>