Skip to content

Commit 44fca76

Browse files
committed
PR feedback.
1 parent 1f875b4 commit 44fca76

File tree

2 files changed

+6
-17
lines changed

2 files changed

+6
-17
lines changed

src/Microsoft.ML.FastTree/GamRegression.cs

+4-15
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,16 @@ namespace Microsoft.ML.Trainers.FastTree
3737
/// | | |
3838
/// | -- | -- |
3939
/// | Machine learning task | Regression |
40-
/// | Is normalization required? | Yes |
40+
/// | Is normalization required? | No |
4141
/// | Is caching required? | No |
4242
/// | Required NuGet in addition to Microsoft.ML | Microsoft.ML.FastTree |
4343
///
44-
/// ### Training Algorithm Details
45-
/// Generalized Additive Models, or GAMs, model the data as a set of linearly independent features
46-
/// similar to a linear model.For each feature, the GAM trainer learns a non-linear function,
47-
/// called a "shape function", that computes the response as a function of the feature's value.
48-
/// (In contrast, a linear model fits a linear response(e.g.a line) to each feature.)
49-
/// To score an example, the outputs of all the shape functions are summed and the score is the total value.
50-
/// This GAM trainer is implemented using shallow gradient boosted trees(e.g.tree stumps) to learn nonparametric
51-
/// shape functions, and is based on the method described in Lou, Caruana, and Gehrke.
52-
/// [" Intelligible Models for Classification and Regression."](http://www.cs.cornell.edu/~yinlou/papers/lou-kdd12.pdf) KDD'12, Beijing, China. 2012.
53-
/// After training, an intercept is added to represent the average prediction over the training set,
54-
/// and the shape functions are normalized to represent the deviation from the average prediction.This results
55-
/// in models that are easily interpreted simply by inspecting the intercept and the shape functions.
44+
/// [!include[algorithm](~/../docs/samples/docs/api-reference/algo-details-gam.md)]
5645
/// ]]>
5746
/// </format>
5847
/// </remarks>
59-
/// <seealso cref="Microsoft.ML.TreeExtensions.Gam(Microsoft.ML.RegressionCatalog.RegressionTrainers,System.String,System.String,System.String,System.Int32,System.Int32,System.Double)"/>
60-
/// <seealso cref="Microsoft.ML.TreeExtensions.Gam(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.FastTree.GamRegressionTrainer.Options)"/>
48+
/// <seealso cref="TreeExtensions.Gam(RegressionCatalog.RegressionTrainers, string, string, string, int, int, double)"/>
49+
/// <seealso cref="TreeExtensions.Gam(RegressionCatalog.RegressionTrainers, GamRegressionTrainer.Options)"/>
6150
/// <seealso cref="Options"/>
6251
public sealed class GamRegressionTrainer : GamTrainerBase<GamRegressionTrainer.Options, RegressionPredictionTransformer<GamRegressionModelParameters>, GamRegressionModelParameters>
6352
{

src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ public static GamBinaryTrainer Gam(this BinaryClassificationCatalog.BinaryClassi
228228
}
229229

230230
/// <summary>
231-
/// Creates <see cref="GamRegressionTrainer"/>, which predicts a target using generalized additive models (GAM).
231+
/// Create <see cref="GamRegressionTrainer"/>, which predicts a target using generalized additive models (GAM).
232232
/// </summary>
233233
/// <param name="catalog">The <see cref="RegressionCatalog"/>.</param>
234234
/// <param name="labelColumnName">The name of the label column. The column data must be <see cref="System.Single"/>.</param>
@@ -258,7 +258,7 @@ public static GamRegressionTrainer Gam(this RegressionCatalog.RegressionTrainers
258258
}
259259

260260
/// <summary>
261-
/// Creates <see cref="GamRegressionTrainer"/>, which predicts a target using generalized additive models (GAM) using advanced options.
261+
/// Create <see cref="GamRegressionTrainer"/> using advanced options, which predicts a target using generalized additive models (GAM).
262262
/// </summary>
263263
/// <param name="catalog">The <see cref="RegressionCatalog"/>.</param>
264264
/// <param name="options">Trainer options.</param>

0 commit comments

Comments
 (0)