FeaturizeText: Add instructions to turn off char- or word-gram generation to the tooltip. (#2947)

rogancarr · web-flow · commit 687ca537ad7b · 2019-03-13T16:00:01.000-07:00
* Adding a note on how to turn off char-grams and word-grams in FeaturizeText.
diff --git a/src/Microsoft.ML.Transforms/Text/TextFeaturizingEstimator.cs b/src/Microsoft.ML.Transforms/Text/TextFeaturizingEstimator.cs
@@ -128,6 +128,7 @@ public sealed class Options : TransformInputBase
 
             /// <summary>
             /// Ngram feature extractor to use for words (WordBag/WordHashBag).
+            /// Set to <see langword="null" /> to turn off n-gram generation for words.
             /// </summary>
             public WordBagEstimator.Options WordFeatureExtractor
             {
@@ -160,6 +161,7 @@ public WordBagEstimator.Options WordFeatureExtractor
 
             /// <summary>
             /// Ngram feature extractor to use for characters (WordBag/WordHashBag).
+            /// Set to <see langword="null" /> to turn off n-gram generation for characters.
             /// </summary>
             public WordBagEstimator.Options CharFeatureExtractor
             {

Original file line number	Diff line number	Diff line change
`@@ -128,6 +128,7 @@ public sealed class Options : TransformInputBase`
`128`	`128`
`129`	`129`	`/// <summary>`
`130`	`130`	`/// Ngram feature extractor to use for words (WordBag/WordHashBag).`
	`131`	`+ /// Set to <see langword="null" /> to turn off n-gram generation for words.`
`131`	`132`	`/// </summary>`
`132`	`133`	`public WordBagEstimator.Options WordFeatureExtractor`
`133`	`134`	`{`
`@@ -160,6 +161,7 @@ public WordBagEstimator.Options WordFeatureExtractor`
`160`	`161`
`161`	`162`	`/// <summary>`
`162`	`163`	`/// Ngram feature extractor to use for characters (WordBag/WordHashBag).`
	`164`	`+ /// Set to <see langword="null" /> to turn off n-gram generation for characters.`
`163`	`165`	`/// </summary>`
`164`	`166`	`public WordBagEstimator.Options CharFeatureExtractor`
`165`	`167`	`{`