diff --git a/src/Microsoft.ML.FastTree/FastTreeArguments.cs b/src/Microsoft.ML.FastTree/FastTreeArguments.cs index 04d7e5be94..08d9a828d4 100644 --- a/src/Microsoft.ML.FastTree/FastTreeArguments.cs +++ b/src/Microsoft.ML.FastTree/FastTreeArguments.cs @@ -213,7 +213,8 @@ public Options() public sealed partial class FastTreeRankingTrainer { /// - /// Options for the . + /// Options for the as used in + /// [FastTree(Options)](xref:Microsoft.ML.TreeExtensions.FastTree(Microsoft.ML.RankingCatalog.RankingTrainers,Microsoft.ML.Trainers.FastTree.FastTreeRankingTrainer.Options)). /// [TlcModule.Component(Name = LoadNameValue, FriendlyName = UserNameValue, Desc = Summary)] public sealed class Options : BoostedTreeOptions, IFastTreeTrainerFactory diff --git a/src/Microsoft.ML.FastTree/FastTreeRanking.cs b/src/Microsoft.ML.FastTree/FastTreeRanking.cs index 01e2f90a40..9abfa6add9 100644 --- a/src/Microsoft.ML.FastTree/FastTreeRanking.cs +++ b/src/Microsoft.ML.FastTree/FastTreeRanking.cs @@ -41,7 +41,28 @@ namespace Microsoft.ML.Trainers.FastTree /// /// The for training a decision tree ranking model using FastTree. /// - /// + /// + /// + /// + /// + /// + /// + /// public sealed partial class FastTreeRankingTrainer : BoostingFastTreeTrainerBase, FastTreeRankingModelParameters> { diff --git a/src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs b/src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs index 78e03edba9..987abb2ac6 100644 --- a/src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs +++ b/src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs @@ -122,11 +122,11 @@ public static FastTreeBinaryTrainer FastTree(this BinaryClassificationCatalog.Bi } /// - /// Ranks a series of inputs based on their relevance, training a decision tree ranking model with the . + /// Create a , which ranks a series of inputs based on their relevancee, using a decision tree ranking model. /// /// The . - /// The name of the label column. - /// The name of the feature column. + /// The name of the label column. The column data must be . + /// The name of the feature column. The column data must be a known-sized vector of . /// The name of the group column. /// The name of the example weight column (optional). /// Total number of decision trees to create in the ensemble. @@ -156,7 +156,7 @@ public static FastTreeRankingTrainer FastTree(this RankingCatalog.RankingTrainer } /// - /// Ranks a series of inputs based on their relevance, training a decision tree ranking model with the and advanced options. + /// Create a with advanced options, which ranks a series of inputs based on their relevance, using a decision tree ranking model. /// /// The . /// Trainer options.