Skip to content

Commit 05018b8

Browse files
committed
review comments - 2. updating comments, help summary etc
1 parent 3341561 commit 05018b8

7 files changed

+10
-10
lines changed

src/Microsoft.ML.FastTree/FastTreeArguments.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ public sealed partial class FastTreeBinaryClassificationTrainer
2727
public sealed class Options : BoostedTreeArgs, IFastTreeTrainerFactory
2828
{
2929
/// <summary>
30-
/// Should we use derivatives optimized for unbalanced sets?
30+
/// Option for using derivatives optimized for unbalanced sets.
3131
/// </summary>
32-
[Argument(ArgumentType.LastOccurenceWins, HelpText = "Should we use derivatives optimized for unbalanced sets", ShortName = "us")]
32+
[Argument(ArgumentType.LastOccurenceWins, HelpText = "Option for using derivatives optimized for unbalanced sets", ShortName = "us")]
3333
[TGUI(Label = "Optimize for unbalanced")]
3434
public bool UnbalancedSets = false;
3535

@@ -448,9 +448,9 @@ public abstract class BoostedTreeArgs : TreeArgs
448448
//Use the second derivative for split gains (not just outputs). Use MaxTreeOutput to "clip" cases where the second derivative is too close to zero.
449449
//Turning BSR on makes larger steps in initial stages and converges to better results with fewer trees (though in the end, it asymptotes to the same results).
450450
/// <summary>
451-
/// Use best regression step trees?
451+
/// Option for using best regression step trees.
452452
/// </summary>
453-
[Argument(ArgumentType.LastOccurenceWins, HelpText = "Use best regression step trees?", ShortName = "bsr")]
453+
[Argument(ArgumentType.LastOccurenceWins, HelpText = "Option for using best regression step trees", ShortName = "bsr")]
454454
public bool BestStepRankingRegressionTrees = false;
455455

456456
/// <summary>

src/Microsoft.ML.FastTree/FastTreeClassification.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ public FastTreeBinaryClassificationTrainer(IHostEnvironment env,
142142
}
143143

144144
/// <summary>
145-
/// Initializes a new instance of <see cref="FastTreeBinaryClassificationTrainer"/> by using the legacy <see cref="Options"/> class.
145+
/// Initializes a new instance of <see cref="FastTreeBinaryClassificationTrainer"/> by using the <see cref="Options"/> class.
146146
/// </summary>
147147
public FastTreeBinaryClassificationTrainer(IHostEnvironment env, Options args)
148148
: base(env, args, TrainerUtils.MakeBoolScalarLabel(args.LabelColumn))

src/Microsoft.ML.FastTree/FastTreeRanking.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public FastTreeRankingTrainer(IHostEnvironment env,
8686
}
8787

8888
/// <summary>
89-
/// Initializes a new instance of <see cref="FastTreeRankingTrainer"/> by using the legacy <see cref="Options"/> class.
89+
/// Initializes a new instance of <see cref="FastTreeRankingTrainer"/> by using the <see cref="Options"/> class.
9090
/// </summary>
9191
public FastTreeRankingTrainer(IHostEnvironment env, Options args)
9292
: base(env, args, TrainerUtils.MakeR4ScalarColumn(args.LabelColumn))

src/Microsoft.ML.FastTree/FastTreeRegression.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public FastTreeRegressionTrainer(IHostEnvironment env,
7575
}
7676

7777
/// <summary>
78-
/// Initializes a new instance of <see cref="FastTreeRegressionTrainer"/> by using the legacy <see cref="Options"/> class.
78+
/// Initializes a new instance of <see cref="FastTreeRegressionTrainer"/> by using the <see cref="Options"/> class.
7979
/// </summary>
8080
public FastTreeRegressionTrainer(IHostEnvironment env, Options args)
8181
: base(env, args, TrainerUtils.MakeR4ScalarColumn(args.LabelColumn))

src/Microsoft.ML.FastTree/FastTreeTweedie.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public FastTreeTweedieTrainer(IHostEnvironment env,
7676
}
7777

7878
/// <summary>
79-
/// Initializes a new instance of <see cref="FastTreeTweedieTrainer"/> by using the legacy <see cref="Options"/> class.
79+
/// Initializes a new instance of <see cref="FastTreeTweedieTrainer"/> by using the <see cref="Options"/> class.
8080
/// </summary>
8181
public FastTreeTweedieTrainer(IHostEnvironment env, Options args)
8282
: base(env, args, TrainerUtils.MakeR4ScalarColumn(args.LabelColumn))

src/Microsoft.ML.FastTree/RandomForestClassification.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ public FastForestClassification(IHostEnvironment env,
160160
}
161161

162162
/// <summary>
163-
/// Initializes a new instance of <see cref="FastForestClassification"/> by using the legacy <see cref="Options"/> class.
163+
/// Initializes a new instance of <see cref="FastForestClassification"/> by using the <see cref="Options"/> class.
164164
/// </summary>
165165
public FastForestClassification(IHostEnvironment env, Options args)
166166
: base(env, args, TrainerUtils.MakeBoolScalarLabel(args.LabelColumn))

src/Microsoft.ML.FastTree/RandomForestRegression.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ public FastForestRegression(IHostEnvironment env,
178178
}
179179

180180
/// <summary>
181-
/// Initializes a new instance of <see cref="FastForestRegression"/> by using the legacy <see cref="Options"/> class.
181+
/// Initializes a new instance of <see cref="FastForestRegression"/> by using the <see cref="Options"/> class.
182182
/// </summary>
183183
public FastForestRegression(IHostEnvironment env, Options args)
184184
: base(env, args, TrainerUtils.MakeR4ScalarColumn(args.LabelColumn), true)

0 commit comments

Comments
 (0)