Skip to content

Commit ed2be8c

Browse files
jwood803eerhardt
jwood803
authored and
eerhardt
committed
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
1 parent c4a03af commit ed2be8c

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

‎src/Microsoft.ML.FastTree/FastTreeArguments.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ public abstract class TreeArgs : LearnerInputBaseWithGroupId
238238
public int MinDocumentsInLeafs = 10;
239239

240240
// REVIEW: Different shortname than FastRank module. Same as the TLC FRWrapper.
241-
[Argument(ArgumentType.LastOccurenceWins, HelpText = "Number of weak hypotheses in the ensemble", ShortName = "iter", SortOrder = 1)]
241+
[Argument(ArgumentType.LastOccurenceWins, HelpText = "Total number of decision trees to create in the ensemble", ShortName = "iter", SortOrder = 1)]
242242
[TGUI(Description = "Total number of trees constructed", SuggestedSweeps = "20,100,500")]
243243
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[] { 20, 100, 500 })]
244244
public int NumTrees = 100;

‎src/Microsoft.ML/CSharpApi.cs

+10-10
Original file line numberDiff line numberDiff line change
@@ -3966,7 +3966,7 @@ public sealed partial class FastForestBinaryClassifier : Microsoft.ML.Runtime.En
39663966
public int MinDocumentsInLeafs { get; set; } = 10;
39673967

39683968
/// <summary>
3969-
/// Number of weak hypotheses in the ensemble
3969+
/// Total number of decision trees to create in the ensemble
39703970
/// </summary>
39713971
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
39723972
public int NumTrees { get; set; } = 100;
@@ -4248,7 +4248,7 @@ public sealed partial class FastForestRegressor : Microsoft.ML.Runtime.EntryPoin
42484248
public int MinDocumentsInLeafs { get; set; } = 10;
42494249

42504250
/// <summary>
4251-
/// Number of weak hypotheses in the ensemble
4251+
/// Total number of decision trees to create in the ensemble
42524252
/// </summary>
42534253
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
42544254
public int NumTrees { get; set; } = 100;
@@ -4646,7 +4646,7 @@ public sealed partial class FastTreeBinaryClassifier : Microsoft.ML.Runtime.Entr
46464646
public int MinDocumentsInLeafs { get; set; } = 10;
46474647

46484648
/// <summary>
4649-
/// Number of weak hypotheses in the ensemble
4649+
/// Total number of decision trees to create in the ensemble
46504650
/// </summary>
46514651
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
46524652
public int NumTrees { get; set; } = 100;
@@ -5072,7 +5072,7 @@ public sealed partial class FastTreeRanker : Microsoft.ML.Runtime.EntryPoints.Co
50725072
public int MinDocumentsInLeafs { get; set; } = 10;
50735073

50745074
/// <summary>
5075-
/// Number of weak hypotheses in the ensemble
5075+
/// Total number of decision trees to create in the ensemble
50765076
/// </summary>
50775077
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
50785078
public int NumTrees { get; set; } = 100;
@@ -5458,7 +5458,7 @@ public sealed partial class FastTreeRegressor : Microsoft.ML.Runtime.EntryPoints
54585458
public int MinDocumentsInLeafs { get; set; } = 10;
54595459

54605460
/// <summary>
5461-
/// Number of weak hypotheses in the ensemble
5461+
/// Total number of decision trees to create in the ensemble
54625462
/// </summary>
54635463
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
54645464
public int NumTrees { get; set; } = 100;
@@ -5849,7 +5849,7 @@ public sealed partial class FastTreeTweedieRegressor : Microsoft.ML.Runtime.Entr
58495849
public int MinDocumentsInLeafs { get; set; } = 10;
58505850

58515851
/// <summary>
5852-
/// Number of weak hypotheses in the ensemble
5852+
/// Total number of decision trees to create in the ensemble
58535853
/// </summary>
58545854
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
58555855
public int NumTrees { get; set; } = 100;
@@ -14162,7 +14162,7 @@ public sealed class FastTreeBinaryClassificationFastTreeTrainer : FastTreeTraine
1416214162
public int MinDocumentsInLeafs { get; set; } = 10;
1416314163

1416414164
/// <summary>
14165-
/// Number of weak hypotheses in the ensemble
14165+
/// Total number of decision trees to create in the ensemble
1416614166
/// </summary>
1416714167
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
1416814168
public int NumTrees { get; set; } = 100;
@@ -14550,7 +14550,7 @@ public sealed class FastTreeRankingFastTreeTrainer : FastTreeTrainer
1455014550
public int MinDocumentsInLeafs { get; set; } = 10;
1455114551

1455214552
/// <summary>
14553-
/// Number of weak hypotheses in the ensemble
14553+
/// Total number of decision trees to create in the ensemble
1455414554
/// </summary>
1455514555
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
1455614556
public int NumTrees { get; set; } = 100;
@@ -14898,7 +14898,7 @@ public sealed class FastTreeRegressionFastTreeTrainer : FastTreeTrainer
1489814898
public int MinDocumentsInLeafs { get; set; } = 10;
1489914899

1490014900
/// <summary>
14901-
/// Number of weak hypotheses in the ensemble
14901+
/// Total number of decision trees to create in the ensemble
1490214902
/// </summary>
1490314903
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
1490414904
public int NumTrees { get; set; } = 100;
@@ -15251,7 +15251,7 @@ public sealed class FastTreeTweedieRegressionFastTreeTrainer : FastTreeTrainer
1525115251
public int MinDocumentsInLeafs { get; set; } = 10;
1525215252

1525315253
/// <summary>
15254-
/// Number of weak hypotheses in the ensemble
15254+
/// Total number of decision trees to create in the ensemble
1525515255
/// </summary>
1525615256
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
1525715257
public int NumTrees { get; set; } = 100;

‎test/BaselineOutput/Common/EntryPoints/core_manifest.json

+10-10
Original file line numberDiff line numberDiff line change
@@ -3703,7 +3703,7 @@
37033703
{
37043704
"Name": "NumTrees",
37053705
"Type": "Int",
3706-
"Desc": "Number of weak hypotheses in the ensemble",
3706+
"Desc": "Total number of decision trees to create in the ensemble",
37073707
"Aliases": [
37083708
"iter"
37093709
],
@@ -4354,7 +4354,7 @@
43544354
{
43554355
"Name": "NumTrees",
43564356
"Type": "Int",
4357-
"Desc": "Number of weak hypotheses in the ensemble",
4357+
"Desc": "Total number of decision trees to create in the ensemble",
43584358
"Aliases": [
43594359
"iter"
43604360
],
@@ -4979,7 +4979,7 @@
49794979
{
49804980
"Name": "NumTrees",
49814981
"Type": "Int",
4982-
"Desc": "Number of weak hypotheses in the ensemble",
4982+
"Desc": "Total number of decision trees to create in the ensemble",
49834983
"Aliases": [
49844984
"iter"
49854985
],
@@ -5891,7 +5891,7 @@
58915891
{
58925892
"Name": "NumTrees",
58935893
"Type": "Int",
5894-
"Desc": "Number of weak hypotheses in the ensemble",
5894+
"Desc": "Total number of decision trees to create in the ensemble",
58955895
"Aliases": [
58965896
"iter"
58975897
],
@@ -6884,7 +6884,7 @@
68846884
{
68856885
"Name": "NumTrees",
68866886
"Type": "Int",
6887-
"Desc": "Number of weak hypotheses in the ensemble",
6887+
"Desc": "Total number of decision trees to create in the ensemble",
68886888
"Aliases": [
68896889
"iter"
68906890
],
@@ -7784,7 +7784,7 @@
77847784
{
77857785
"Name": "NumTrees",
77867786
"Type": "Int",
7787-
"Desc": "Number of weak hypotheses in the ensemble",
7787+
"Desc": "Total number of decision trees to create in the ensemble",
77887788
"Aliases": [
77897789
"iter"
77907790
],
@@ -18394,7 +18394,7 @@
1839418394
{
1839518395
"Name": "NumTrees",
1839618396
"Type": "Int",
18397-
"Desc": "Number of weak hypotheses in the ensemble",
18397+
"Desc": "Total number of decision trees to create in the ensemble",
1839818398
"Aliases": [
1839918399
"iter"
1840018400
],
@@ -19288,7 +19288,7 @@
1928819288
{
1928919289
"Name": "NumTrees",
1929019290
"Type": "Int",
19291-
"Desc": "Number of weak hypotheses in the ensemble",
19291+
"Desc": "Total number of decision trees to create in the ensemble",
1929219292
"Aliases": [
1929319293
"iter"
1929419294
],
@@ -20263,7 +20263,7 @@
2026320263
{
2026420264
"Name": "NumTrees",
2026520265
"Type": "Int",
20266-
"Desc": "Number of weak hypotheses in the ensemble",
20266+
"Desc": "Total number of decision trees to create in the ensemble",
2026720267
"Aliases": [
2026820268
"iter"
2026920269
],
@@ -21145,7 +21145,7 @@
2114521145
{
2114621146
"Name": "NumTrees",
2114721147
"Type": "Int",
21148-
"Desc": "Number of weak hypotheses in the ensemble",
21148+
"Desc": "Total number of decision trees to create in the ensemble",
2114921149
"Aliases": [
2115021150
"iter"
2115121151
],

0 commit comments

Comments
 (0)