Skip to content

Commit df3efa5

Browse files
authored
XML documentation for FastForest regression trainer. (#3411)
* XML documentation for FastForest regression trainer. * PR feedback. * Pr feedback.
1 parent a9fce27 commit df3efa5

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

src/Microsoft.ML.FastTree/RandomForestRegression.cs

+24-2
Original file line numberDiff line numberDiff line change
@@ -244,12 +244,34 @@ ISchemaBindableMapper IQuantileRegressionPredictor.CreateMapper(Double[] quantil
244244
/// <summary>
245245
/// The <see cref="IEstimator{TTransformer}"/> for training a decision tree regression model using Fast Forest.
246246
/// </summary>
247-
/// <include file='doc.xml' path='doc/members/member[@name="FastForest_remarks"]/*' />
247+
/// <remarks>
248+
/// <format type="text/markdown"><![CDATA[
249+
/// To create this trainer, use [FastForest](xref:Microsoft.ML.TreeExtensions.FastForest(Microsoft.ML.RegressionCatalog.RegressionTrainers,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32))
250+
/// or [FastForest(Options)](xref:Microsoft.ML.TreeExtensions.FastForest(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.FastTree.FastForestRegressionTrainer.Options)).
251+
///
252+
/// [!include[io](~/../docs/samples/docs/api-reference/io-columns-regression.md)]
253+
///
254+
/// ### Trainer Characteristics
255+
/// | | |
256+
/// | -- | -- |
257+
/// | Machine learning task | Regression |
258+
/// | Is normalization required? | Yes |
259+
/// | Is caching required? | No |
260+
/// | Required NuGet in addition to Microsoft.ML | Microsoft.ML.FastTree |
261+
///
262+
/// [!include[algorithm](~/../docs/samples/docs/api-reference/algo-details-fastforest.md)]
263+
/// ]]>
264+
/// </format>
265+
/// </remarks>
266+
/// <seealso cref="Microsoft.ML.TreeExtensions.FastForest(Microsoft.ML.RegressionCatalog.RegressionTrainers,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32)"/>
267+
/// <seealso cref="Microsoft.ML.TreeExtensions.FastForest(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.FastTree.FastForestRegressionTrainer.Options)"/>
268+
/// <seealso cref="Options"/>
248269
public sealed partial class FastForestRegressionTrainer
249270
: RandomForestTrainerBase<FastForestRegressionTrainer.Options, RegressionPredictionTransformer<FastForestRegressionModelParameters>, FastForestRegressionModelParameters>
250271
{
251272
/// <summary>
252-
/// Options for the <see cref="FastForestRegressionTrainer"/>.
273+
/// Options for the <see cref="FastForestRegressionTrainer"/> as used in
274+
/// [FastForest(Options)](xref:Microsoft.ML.TreeExtensions.FastForest(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.FastTree.FastForestRegressionTrainer.Options)).
253275
/// </summary>
254276
public sealed class Options : FastForestOptionsBase
255277
{

src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -332,11 +332,11 @@ public static FastTreeTweedieTrainer FastTreeTweedie(this RegressionCatalog.Regr
332332
}
333333

334334
/// <summary>
335-
/// Predict a target using a decision tree regression model trained with the <see cref="FastForestRegressionTrainer"/>.
335+
/// Create <see cref="FastForestRegressionTrainer"/>, which predicts a target using a decision tree regression model.
336336
/// </summary>
337337
/// <param name="catalog">The <see cref="RegressionCatalog"/>.</param>
338-
/// <param name="labelColumnName">The name of the label column.</param>
339-
/// <param name="featureColumnName">The name of the feature column.</param>
338+
/// <param name="labelColumnName">The name of the label column. The column data must be <see cref="System.Single"/></param>
339+
/// <param name="featureColumnName">The name of the feature column. The column data must be a known-sized vector of <see cref="System.Single"/></param>
340340
/// <param name="exampleWeightColumnName">The name of the example weight column (optional).</param>
341341
/// <param name="numberOfLeaves">The maximum number of leaves per decision tree.</param>
342342
/// <param name="numberOfTrees">Total number of decision trees to create in the ensemble.</param>
@@ -362,7 +362,7 @@ public static FastForestRegressionTrainer FastForest(this RegressionCatalog.Regr
362362
}
363363

364364
/// <summary>
365-
/// Predict a target using a decision tree regression model trained with the <see cref="FastForestRegressionTrainer"/> and advanced options.
365+
/// Create <see cref="FastForestRegressionTrainer"/> with advanced options, which predicts a target using a decision tree regression model.
366366
/// </summary>
367367
/// <param name="catalog">The <see cref="RegressionCatalog"/>.</param>
368368
/// <param name="options">Trainer options.</param>

0 commit comments

Comments
 (0)