Skip to content

Update fast tree argument help text #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 19, 2018
Merged

Update fast tree argument help text #372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cc03576
Update fast tree argument help text
jwood803 Jun 18, 2018
1d52aa5
Update wording
jwood803 Jun 18, 2018
fc5fb5f
Update API to fix test
jwood803 Jun 19, 2018
c8d9240
Update core manifest JSON to update help text
jwood803 Jun 19, 2018
e5c821f
Merge branch 'master' into update-argument-text
jwood803 Jun 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Microsoft.ML.FastTree/FastTreeArguments.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
20 changes: 10 additions & 10 deletions src/Microsoft.ML/CSharpApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: sentences should have punctuation

also per DevDiv guidelines for API docs, read/write properties should start with Gets or sets...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! I'll add those in. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actualy, @mairaw, in FastTreeArguments.cs the other help text properties don't have those in them. Is it still ok to add them to this one or should I do it to all of them to be consistent in the file?

/// </summary>
[TlcModule.SweepableDiscreteParamAttribute("NumTrees", new object[]{20, 100, 500})]
public int NumTrees { get; set; } = 100;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down
20 changes: 10 additions & 10 deletions test/BaselineOutput/Common/EntryPoints/core_manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down Expand Up @@ -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"
],
Expand Down