VisionCatalog.xml

<Type Name="VisionCatalog" FullName="Microsoft.ML.VisionCatalog">
  <TypeSignature Language="C#" Value="public static class VisionCatalog" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit VisionCatalog extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ML.VisionCatalog" />
  <TypeSignature Language="VB.NET" Value="Public Module VisionCatalog" />
  <TypeSignature Language="F#" Value="type VisionCatalog = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ML.Vision</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Collection of extension methods for <see cref="T:Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers" /> to create instances of ImageClassification trainer components.
            </summary>
    <remarks>
            This requires additional nuget dependencies to link against Tensorflow native dlls. See <see cref="T:Microsoft.ML.Vision.ImageClassificationTrainer" /> for more information.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName="ImageClassification">
      <MemberSignature Language="C#" Value="public static Microsoft.ML.Vision.ImageClassificationTrainer ImageClassification (this Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers catalog, Microsoft.ML.Vision.ImageClassificationTrainer.Options options);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Vision.ImageClassificationTrainer ImageClassification(class Microsoft.ML.MulticlassClassificationCatalog/MulticlassClassificationTrainers catalog, class Microsoft.ML.Vision.ImageClassificationTrainer/Options options) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.VisionCatalog.ImageClassification(Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers,Microsoft.ML.Vision.ImageClassificationTrainer.Options)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function ImageClassification (catalog As MulticlassClassificationCatalog.MulticlassClassificationTrainers, options As ImageClassificationTrainer.Options) As ImageClassificationTrainer" />
      <MemberSignature Language="F#" Value="static member ImageClassification : Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers * Microsoft.ML.Vision.ImageClassificationTrainer.Options -&gt; Microsoft.ML.Vision.ImageClassificationTrainer" Usage="Microsoft.ML.VisionCatalog.ImageClassification (catalog, options)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Vision</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.Vision.ImageClassificationTrainer</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="catalog" Type="Microsoft.ML.MulticlassClassificationCatalog+MulticlassClassificationTrainers" RefType="this" />
        <Parameter Name="options" Type="Microsoft.ML.Vision.ImageClassificationTrainer+Options" />
      </Parameters>
      <Docs>
        <param name="catalog">Catalog</param>
        <param name="options">An <see cref="T:Microsoft.ML.Vision.ImageClassificationTrainer.Options" /> object specifying advanced
            options for <see cref="T:Microsoft.ML.Vision.ImageClassificationTrainer" />.</param>
        <summary>
            Create <see cref="T:Microsoft.ML.Vision.ImageClassificationTrainer" /> using advanced options, which trains a Deep Neural Network(DNN) to classify images.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <example>
          <format type="text/markdown"><![CDATA[
             [!code-csharp[ImageClassification](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Trainers/MulticlassClassification/ImageClassification/ResnetV2101TransferLearningTrainTestSplit.cs)]
            ]]></format>
        </example>
      </Docs>
    </Member>
    <Member MemberName="ImageClassification">
      <MemberSignature Language="C#" Value="public static Microsoft.ML.Vision.ImageClassificationTrainer ImageClassification (this Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers catalog, string labelColumnName = &quot;Label&quot;, string featureColumnName = &quot;Features&quot;, string scoreColumnName = &quot;Score&quot;, string predictedLabelColumnName = &quot;PredictedLabel&quot;, Microsoft.ML.IDataView validationSet = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Vision.ImageClassificationTrainer ImageClassification(class Microsoft.ML.MulticlassClassificationCatalog/MulticlassClassificationTrainers catalog, string labelColumnName, string featureColumnName, string scoreColumnName, string predictedLabelColumnName, class Microsoft.ML.IDataView validationSet) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ML.VisionCatalog.ImageClassification(Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers,System.String,System.String,System.String,System.String,Microsoft.ML.IDataView)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function ImageClassification (catalog As MulticlassClassificationCatalog.MulticlassClassificationTrainers, Optional labelColumnName As String = &quot;Label&quot;, Optional featureColumnName As String = &quot;Features&quot;, Optional scoreColumnName As String = &quot;Score&quot;, Optional predictedLabelColumnName As String = &quot;PredictedLabel&quot;, Optional validationSet As IDataView = Nothing) As ImageClassificationTrainer" />
      <MemberSignature Language="F#" Value="static member ImageClassification : Microsoft.ML.MulticlassClassificationCatalog.MulticlassClassificationTrainers * string * string * string * string * Microsoft.ML.IDataView -&gt; Microsoft.ML.Vision.ImageClassificationTrainer" Usage="Microsoft.ML.VisionCatalog.ImageClassification (catalog, labelColumnName, featureColumnName, scoreColumnName, predictedLabelColumnName, validationSet)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ML.Vision</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.ML.Vision.ImageClassificationTrainer</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="catalog" Type="Microsoft.ML.MulticlassClassificationCatalog+MulticlassClassificationTrainers" RefType="this" />
        <Parameter Name="labelColumnName" Type="System.String" />
        <Parameter Name="featureColumnName" Type="System.String" />
        <Parameter Name="scoreColumnName" Type="System.String" />
        <Parameter Name="predictedLabelColumnName" Type="System.String" />
        <Parameter Name="validationSet" Type="Microsoft.ML.IDataView" />
      </Parameters>
      <Docs>
        <param name="catalog">Catalog</param>
        <param name="labelColumnName">The name of the labels column. The default for this parameter is "label".</param>
        <param name="featureColumnName">The name of the input features column. The default for this parameter is "Features".</param>
        <param name="scoreColumnName">The name of the output score column. The default for this parameter is "Score"</param>
        <param name="predictedLabelColumnName">The name of the output predicted label columns. The default for this parameter is "PredictedLabel"</param>
        <param name="validationSet">The validation set used while training to improve model quality. The default for this parameter is null.</param>
        <summary>
            Create <see cref="T:Microsoft.ML.Vision.ImageClassificationTrainer" />, which trains a Deep Neural Network(DNN) to classify images.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <example>
          <format type="text/markdown"><![CDATA[
             [!code-csharp[ImageClassification](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Trainers/MulticlassClassification/ImageClassification/ImageClassificationDefault.cs)]
             ]]></format>
        </example>
      </Docs>
    </Member>
  </Members>
</Type>