Add comments to public API methods

Author: yaeldMS

src/Microsoft.ML.Transforms/SvmLight/SvmLightLoader.cs

@@ -8,7 +8,6 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using System.Threading;
 using Microsoft.ML;
 using Microsoft.ML.CommandLine;
 using Microsoft.ML.Data;
@@ -97,6 +96,7 @@ public enum FeatureIndices
             OneBased,
             Names
         }
+
         public sealed class Options
         {
             [Argument(ArgumentType.AtMostOnce, HelpText = "The size of the feature vectors.", ShortName = "size")]

src/Microsoft.ML.Transforms/SvmLight/SvmLightLoaderSaverCatalog.cs

@@ -12,14 +12,15 @@ namespace Microsoft.ML.Transforms
     public static class SvmLightLoaderSaverCatalog
     {
         /// <summary>
-        ///
+        /// Creates a loader that loads SVM-light format files. <see cref="SvmLightLoader"/>.
         /// </summary>
-        /// <param name="catalog"></param>
-        /// <param name="inputSize"></param>
-        /// <param name="numberOfRows"></param>
-        /// <param name="zeroBased"></param>
-        /// <param name="dataSample"></param>
-        /// <returns></returns>
+        /// <param name="catalog">The <see cref="DataOperationsCatalog"/> catalog.</param>
+        /// <param name="inputSize">The number of features in the Features column. If 0 is specified, the
+        /// loader will determine it by looking at the file sample given in <paramref name="dataSample"/>.</param>
+        /// <param name="numberOfRows">The number of rows from the sample to be used for determining the number of features.</param>
+        /// <param name="zeroBased">If the file contains zero-based indices, this parameter should be set to true. If they are one-based
+        /// it should be set to false.</param>
+        /// <param name="dataSample">A data sample to be used for determining the number of features in the Features column.</param>
         public static SvmLightLoader CreateSvmLightLoader(this DataOperationsCatalog catalog,
             int inputSize = 0,
             long? numberOfRows = null,
@@ -30,27 +31,27 @@ public static SvmLightLoader CreateSvmLightLoader(this DataOperationsCatalog cat
                 SvmLightLoader.FeatureIndices.ZeroBased : SvmLightLoader.FeatureIndices.OneBased }, dataSample);
 
         /// <summary>
-        ///
+        /// Creates a loader that loads SVM-light like files, where features are specified by their names.
         /// </summary>
-        /// <param name="catalog"></param>
-        /// <param name="numberOfRows"></param>
-        /// <param name="dataSample"></param>
-        /// <returns></returns>
+        /// <param name="catalog">The <see cref="DataOperationsCatalog"/> catalog.</param>
+        /// <param name="numberOfRows">The number of rows from the sample to be used for determining the set of feature names.</param>
+        /// <param name="dataSample">A data sample to be used for determining the set of features names.</param>
         public static SvmLightLoader CreateSvmLightLoaderWithFeatureNames(this DataOperationsCatalog catalog,
             long? numberOfRows = null,
             IMultiStreamSource dataSample = null)
             => new SvmLightLoader(CatalogUtils.GetEnvironment(catalog), new SvmLightLoader.Options()
             { NumberOfRows = numberOfRows, FeatureIndices = SvmLightLoader.FeatureIndices.Names }, dataSample);
 
         /// <summary>
-        ///
+        /// Load a <see cref="IDataView"/> from a text file using <see cref="SvmLightLoader"/>.
         /// </summary>
-        /// <param name="catalog"></param>
-        /// <param name="path"></param>
-        /// <param name="inputSize"></param>
-        /// <param name="zeroBased"></param>
-        /// <param name="numberOfRows"></param>
-        /// <returns></returns>
+        /// <param name="catalog">The <see cref="DataOperationsCatalog"/> catalog.</param>
+        /// <param name="path">The path to the file.</param>
+        /// <param name="inputSize">The number of features in the Features column. If 0 is specified, the
+        /// loader will determine it by looking at the file given in <paramref name="path"/>.</param>
+        /// <param name="zeroBased">If the file contains zero-based indices, this parameter should be set to true. If they are one-based
+        /// it should be set to false.</param>
+        /// <param name="numberOfRows">The number of rows from the sample to be used for determining the number of features.</param>
         public static IDataView LoadFromSvmLightFile(this DataOperationsCatalog catalog,
             string path,
             int inputSize = 0,
@@ -65,12 +66,12 @@ public static IDataView LoadFromSvmLightFile(this DataOperationsCatalog catalog,
         }
 
         /// <summary>
-        ///
+        /// Load a <see cref="IDataView"/> from a text file containing features specified by feature names,
+        /// using <see cref="SvmLightLoader"/>.
         /// </summary>
-        /// <param name="catalog"></param>
-        /// <param name="path"></param>
-        /// <param name="numberOfRows"></param>
-        /// <returns></returns>
+        /// <param name="catalog">The <see cref="DataOperationsCatalog"/> catalog.</param>
+        /// <param name="path">The path to the file.</param>
+        /// <param name="numberOfRows">The number of rows from the sample to be used for determining the set of feature names.</param>
         public static IDataView LoadFromSvmLightFileWithFeatureNames(this DataOperationsCatalog catalog,
             string path,
             long? numberOfRows = null)
@@ -82,6 +83,22 @@ public static IDataView LoadFromSvmLightFileWithFeatureNames(this DataOperations
             return loader.Load(file);
         }
 
+        /// <summary>
+        /// Save the <see cref="IDataView"/> in SVM-light format. Four columns can be saved: a label and a features column,
+        /// and optionally a group ID column and an example weight column.
+        /// </summary>
+        /// <param name="catalog">The <see cref="DataOperationsCatalog"/> catalog.</param>
+        /// <param name="data">The data view to save.</param>
+        /// <param name="stream">The stream to write to.</param>
+        /// <param name="zeroBasedIndexing">Whether to index the features starting at 0 or at 1.</param>
+        /// <param name="binaryLabel">If set to true, saves 1 for positive labels, -1 for non-positive labels and 0 for NaN.
+        /// Otherwise, saves the value of the label in the data view.</param>
+        /// <param name="labelColumnName">The name of the column to be saved as the label column.</param>
+        /// <param name="featureColumnName">The name of the column to be saved as the features column.</param>
+        /// <param name="rowGroupColumnName">The name of the column to be saved as the group ID column. If null, a group ID column
+        /// will not be saved.</param>
+        /// <param name="exampleWeightColumnName">The name of the column to be saved as the weight column. If null, a weight column
+        /// will not be saved.</param>
         public static void SaveInSvmLightFormat(this DataOperationsCatalog catalog,
             IDataView data,
             Stream stream,