Skip to content

Commit 16c6c3a

Browse files
authored
XML documentation for FastTree regression trainer. (#3412)
* XML documentation for FastTree regression trainer. * PR feedback.
1 parent f51ecdb commit 16c6c3a

File tree

3 files changed

+28
-6
lines changed

3 files changed

+28
-6
lines changed

src/Microsoft.ML.FastTree/FastTreeArguments.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ public Options()
111111
public sealed partial class FastTreeRegressionTrainer
112112
{
113113
/// <summary>
114-
/// Options for the <see cref="FastTreeRegressionTrainer"/>.
114+
/// Options for the <see cref="FastTreeRegressionTrainer"/> as used in
115+
/// [FastTree(Options)](xref:Microsoft.ML.TreeExtensions.FastTree(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.FastTree.FastTreeRegressionTrainer.Options)).
115116
/// </summary>
116117
[TlcModule.Component(Name = LoadNameValue, FriendlyName = UserNameValue, Desc = Summary)]
117118
public sealed class Options : BoostedTreeOptions, IFastTreeTrainerFactory

src/Microsoft.ML.FastTree/FastTreeRegression.cs

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,28 @@ namespace Microsoft.ML.Trainers.FastTree
3232
/// <summary>
3333
/// The <see cref="IEstimator{TTransformer}"/> for training a decision tree regression model using FastTree.
3434
/// </summary>
35-
/// <include file='doc.xml' path='doc/members/member[@name="FastTree_remarks"]/*' />
35+
/// <remarks>
36+
/// <format type="text/markdown"><![CDATA[
37+
/// To create this trainer, use [FastTree](xref:Microsoft.ML.TreeExtensions.FastTree(Microsoft.ML.RegressionCatalog.RegressionTrainers,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Double))
38+
/// or [FastTree(Options)](xref:Microsoft.ML.TreeExtensions.FastTree(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.FastTree.FastTreeRegressionTrainer.Options)).
39+
///
40+
/// [!include[io](~/../docs/samples/docs/api-reference/io-columns-regression.md)]
41+
///
42+
/// ### Trainer Characteristics
43+
/// | | |
44+
/// | -- | -- |
45+
/// | Machine learning task | Regression |
46+
/// | Is normalization required? | No |
47+
/// | Is caching required? | No |
48+
/// | Required NuGet in addition to Microsoft.ML | Microsoft.ML.FastTree |
49+
///
50+
/// [!include[algorithm](~/../docs/samples/docs/api-reference/algo-details-fasttree.md)]
51+
/// ]]>
52+
/// </format>
53+
/// </remarks>
54+
/// <seealso cref="Microsoft.ML.TreeExtensions.FastTree(Microsoft.ML.RegressionCatalog.RegressionTrainers,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Double)"/>
55+
/// <seealso cref="Microsoft.ML.TreeExtensions.FastTree(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.FastTree.FastTreeRegressionTrainer.Options)"/>
56+
/// <seealso cref="Options"/>
3657
public sealed partial class FastTreeRegressionTrainer
3758
: BoostingFastTreeTrainerBase<FastTreeRegressionTrainer.Options, RegressionPredictionTransformer<FastTreeRegressionModelParameters>, FastTreeRegressionModelParameters>
3859
{

src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ namespace Microsoft.ML
1414
public static class TreeExtensions
1515
{
1616
/// <summary>
17-
/// Predict a target using a decision tree regression model trained with the <see cref="FastTreeRegressionTrainer"/>.
17+
/// Create <see cref="FastTreeRegressionTrainer"/>, which predicts a target using a decision tree regression model.
1818
/// </summary>
1919
/// <param name="catalog">The <see cref="RegressionCatalog"/>.</param>
20-
/// <param name="labelColumnName">The name of the label column.</param>
21-
/// <param name="featureColumnName">The name of the feature column.</param>
20+
/// <param name="labelColumnName">The name of the label column. The column data must be <see cref="System.Single"/>.</param>
21+
/// <param name="featureColumnName">The name of the feature column. The column data must be a known-sized vector of <see cref="System.Single"/>.</param>
2222
/// <param name="exampleWeightColumnName">The name of the example weight column (optional).</param>
2323
/// <param name="numberOfTrees">Total number of decision trees to create in the ensemble.</param>
2424
/// <param name="numberOfLeaves">The maximum number of leaves per decision tree.</param>
@@ -46,7 +46,7 @@ public static FastTreeRegressionTrainer FastTree(this RegressionCatalog.Regressi
4646
}
4747

4848
/// <summary>
49-
/// Predict a target using a decision tree regression model trained with the <see cref="FastTreeRegressionTrainer"/>.
49+
/// Create <see cref="FastTreeRegressionTrainer"/> with advanced options, which predicts a target using a decision tree regression model.
5050
/// </summary>
5151
/// <param name="catalog">The <see cref="RegressionCatalog"/>.</param>
5252
/// <param name="options">Trainer options.</param>

0 commit comments

Comments
 (0)