diff --git a/src/Microsoft.ML.Transforms/CategoricalCatalog.cs b/src/Microsoft.ML.Transforms/CategoricalCatalog.cs index 7bbff58793..5d65724380 100644 --- a/src/Microsoft.ML.Transforms/CategoricalCatalog.cs +++ b/src/Microsoft.ML.Transforms/CategoricalCatalog.cs @@ -51,7 +51,7 @@ public static OneHotEncodingEstimator OneHotEncoding(this TransformsCatalog.Cate new[] { new OneHotEncodingEstimator.ColumnOptions(outputColumnName, inputColumnName, outputKind, maximumNumberOfKeys, keyOrdinality) }, keyData); /// - /// Create a , which converts one or more input text columns specified in + /// Creates a , which converts one or more input text columns specified in /// into as many columns of one-hot encoded vectors. /// /// If multiple columns are passed to the estimator, all of the columns will be processed in a single pass over the data. diff --git a/src/Microsoft.ML.Transforms/Text/TextFeaturizingEstimator.cs b/src/Microsoft.ML.Transforms/Text/TextFeaturizingEstimator.cs index a3a90b0673..74ec426e9a 100644 --- a/src/Microsoft.ML.Transforms/Text/TextFeaturizingEstimator.cs +++ b/src/Microsoft.ML.Transforms/Text/TextFeaturizingEstimator.cs @@ -32,8 +32,8 @@ namespace Microsoft.ML.Transforms.Text public interface IStopWordsRemoverOptions { } /// - /// An estimator that turns a collection of text documents into numerical feature vectors. - /// The feature vectors are normalized counts of word and/or character n-grams (based on the options supplied). + /// Represents an estimator that turns a collection of text documents into numerical feature vectors. + /// The feature vectors are normalized counts of word or character n-grams (based on the options supplied). /// /// /// , where the estimator can be further tuned. /// - /// Check the See Also section for links to usage examples. + /// For links to usage examples, see and . /// ]]> /// /// @@ -67,7 +67,7 @@ public interface IStopWordsRemoverOptions { } public sealed class TextFeaturizingEstimator : IEstimator { /// - /// Text language. This enumeration is serialized. + /// Specifies text languages. This enumeration is serialized. /// public enum Language { @@ -81,7 +81,7 @@ public enum Language } /// - /// Text vector normalizer kind. + /// Specifies the kinds of text vector normalizers. /// public enum NormFunction { @@ -121,7 +121,7 @@ internal bool TryUnparse(StringBuilder sb) } /// - /// Advanced options for the . + /// Provides advanced options for the . /// public sealed class Options : TransformInputBase { @@ -140,18 +140,20 @@ public sealed class Options : TransformInputBase private IStopWordsRemoverOptions _stopWordsRemoverOptions; /// - /// Option to set type of stop word remover to use. + /// Gets or sets the type of stop word remover to use. + /// + /// /// The following options are available /// /// - /// The removes the language specific list of stop words from the input. + /// The removes the language-specific list of stop words from the input. /// /// - /// The uses user provided list of stop words. + /// The uses a user-provided list of stop words. /// /// /// Setting this to 'null' does not remove stop words from the input. - /// + /// public IStopWordsRemoverOptions StopWordsRemoverOptions { get { return _stopWordsRemoverOptions; } @@ -208,15 +210,17 @@ public IStopWordsRemoverOptions StopWordsRemoverOptions private WordBagEstimator.Options _wordFeatureExtractor; /// - /// Norm of the output vector. It will be normalized to one. + /// Gets the norm of the output vector. It will be normalized to one. /// [Argument(ArgumentType.AtMostOnce, HelpText = "Normalize vectors (rows) individually by rescaling them to unit norm.", Name = "VectorNormalizer", ShortName = "norm", SortOrder = 13)] public NormFunction Norm = NormFunction.L2; /// - /// Ngram feature extractor to use for words (WordBag/WordHashBag). - /// Set to to turn off n-gram generation for words. + /// Gets or sets the n-gram feature extractor to use for words (WordBag/WordHashBag). /// + /// + /// Set to to turn off n-gram generation for words. + /// public WordBagEstimator.Options WordFeatureExtractor { get { return _wordFeatureExtractor; } @@ -247,9 +251,11 @@ public WordBagEstimator.Options WordFeatureExtractor private WordBagEstimator.Options _charFeatureExtractor; /// - /// Ngram feature extractor to use for characters (WordBag/WordHashBag). - /// Set to to turn off n-gram generation for characters. + /// Gets or sets the n-gram feature extractor to use for characters (WordBag/WordHashBag). /// + /// + /// Set to to turn off n-gram generation for characters. + /// public WordBagEstimator.Options CharFeatureExtractor { get { return _charFeatureExtractor; } @@ -625,9 +631,11 @@ private static string GenerateColumnName(DataViewSchema schema, string srcName, } /// - /// Returns the of the schema which will be produced by the transformer. - /// Used for schema propagation and verification in a pipeline. + /// Returns the of the schema that will be produced by the transformer. /// + /// + /// This method is used for schema propagation and verification in a pipeline. + /// public SchemaShape GetOutputSchema(SchemaShape inputSchema) { _host.CheckValue(inputSchema, nameof(inputSchema));