Update fast tree argument help text (dotnet#372)

* Update fast tree argument help text * Update wording * Update API to fix test * Update core manifest JSON to update help text
eerhardt · Jul 27, 2018 · ed2be8c · ed2be8c
1 parent c4a03af
commit ed2be8c
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/src/Microsoft.ML.FastTree/FastTreeArguments.cs b/src/Microsoft.ML.FastTree/FastTreeArguments.cs
@@ -238,7 +238,7 @@ public abstract class TreeArgs : LearnerInputBaseWithGroupId
         public int MinDocumentsInLeafs = 10;
 
         // REVIEW: Different shortname than FastRank module. Same as the TLC FRWrapper.
-        [Argument(ArgumentType.LastOccurenceWins, HelpText = "Number of weak hypotheses in the ensemble", ShortName = "iter", SortOrder = 1)]
+        [Argument(ArgumentType.LastOccurenceWins, HelpText = "Total number of decision trees to create in the ensemble", ShortName = "iter", SortOrder = 1)]
         [TGUI(Description = "Total number of trees constructed", SuggestedSweeps = "20,100,500")]
         [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[] { 20, 100, 500 })]
         public int NumTrees = 100;

diff --git a/src/Microsoft.ML/CSharpApi.cs b/src/Microsoft.ML/CSharpApi.cs
@@ -3966,7 +3966,7 @@ public sealed partial class FastForestBinaryClassifier : Microsoft.ML.Runtime.En
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -4248,7 +4248,7 @@ public sealed partial class FastForestRegressor : Microsoft.ML.Runtime.EntryPoin
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -4646,7 +4646,7 @@ public sealed partial class FastTreeBinaryClassifier : Microsoft.ML.Runtime.Entr
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -5072,7 +5072,7 @@ public sealed partial class FastTreeRanker : Microsoft.ML.Runtime.EntryPoints.Co
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -5458,7 +5458,7 @@ public sealed partial class FastTreeRegressor : Microsoft.ML.Runtime.EntryPoints
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -5849,7 +5849,7 @@ public sealed partial class FastTreeTweedieRegressor : Microsoft.ML.Runtime.Entr
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -14162,7 +14162,7 @@ public sealed class FastTreeBinaryClassificationFastTreeTrainer : FastTreeTraine
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -14550,7 +14550,7 @@ public sealed class FastTreeRankingFastTreeTrainer : FastTreeTrainer
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -14898,7 +14898,7 @@ public sealed class FastTreeRegressionFastTreeTrainer : FastTreeTrainer
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;
@@ -15251,7 +15251,7 @@ public sealed class FastTreeTweedieRegressionFastTreeTrainer : FastTreeTrainer
             public int MinDocumentsInLeafs { get; set; } = 10;
 
             /// <summary>
-            /// Number of weak hypotheses in the ensemble
+            /// Total number of decision trees to create in the ensemble
             /// </summary>
             [TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
             public int NumTrees { get; set; } = 100;

diff --git a/test/BaselineOutput/Common/EntryPoints/core_manifest.json b/test/BaselineOutput/Common/EntryPoints/core_manifest.json
@@ -3703,7 +3703,7 @@
         {
           "Name": "NumTrees",
           "Type": "Int",
-          "Desc": "Number of weak hypotheses in the ensemble",
+          "Desc": "Total number of decision trees to create in the ensemble",
           "Aliases": [
             "iter"
           ],
@@ -4354,7 +4354,7 @@
         {
           "Name": "NumTrees",
           "Type": "Int",
-          "Desc": "Number of weak hypotheses in the ensemble",
+          "Desc": "Total number of decision trees to create in the ensemble",
           "Aliases": [
             "iter"
           ],
@@ -4979,7 +4979,7 @@
         {
           "Name": "NumTrees",
           "Type": "Int",
-          "Desc": "Number of weak hypotheses in the ensemble",
+          "Desc": "Total number of decision trees to create in the ensemble",
           "Aliases": [
             "iter"
           ],
@@ -5891,7 +5891,7 @@
         {
           "Name": "NumTrees",
           "Type": "Int",
-          "Desc": "Number of weak hypotheses in the ensemble",
+          "Desc": "Total number of decision trees to create in the ensemble",
           "Aliases": [
             "iter"
           ],
@@ -6884,7 +6884,7 @@
         {
           "Name": "NumTrees",
           "Type": "Int",
-          "Desc": "Number of weak hypotheses in the ensemble",
+          "Desc": "Total number of decision trees to create in the ensemble",
           "Aliases": [
             "iter"
           ],
@@ -7784,7 +7784,7 @@
         {
           "Name": "NumTrees",
           "Type": "Int",
-          "Desc": "Number of weak hypotheses in the ensemble",
+          "Desc": "Total number of decision trees to create in the ensemble",
           "Aliases": [
             "iter"
           ],
@@ -18394,7 +18394,7 @@
             {
               "Name": "NumTrees",
               "Type": "Int",
-              "Desc": "Number of weak hypotheses in the ensemble",
+              "Desc": "Total number of decision trees to create in the ensemble",
               "Aliases": [
                 "iter"
               ],
@@ -19288,7 +19288,7 @@
             {
               "Name": "NumTrees",
               "Type": "Int",
-              "Desc": "Number of weak hypotheses in the ensemble",
+              "Desc": "Total number of decision trees to create in the ensemble",
               "Aliases": [
                 "iter"
               ],
@@ -20263,7 +20263,7 @@
             {
               "Name": "NumTrees",
               "Type": "Int",
-              "Desc": "Number of weak hypotheses in the ensemble",
+              "Desc": "Total number of decision trees to create in the ensemble",
               "Aliases": [
                 "iter"
               ],
@@ -21145,7 +21145,7 @@
             {
               "Name": "NumTrees",
               "Type": "Int",
-              "Desc": "Number of weak hypotheses in the ensemble",
+              "Desc": "Total number of decision trees to create in the ensemble",
               "Aliases": [
                 "iter"
               ],