Skip to content

Commit 3826e50

Browse files
committed
PR feedback.
1 parent 30741e9 commit 3826e50

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

src/Microsoft.ML.StandardTrainers/Standard/PoissonRegression/PoissonRegression.cs

+4-3
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ namespace Microsoft.ML.Trainers
4949
/// ]]>
5050
/// </format>
5151
/// </remarks>
52-
/// <seealso cref="Microsoft.ML.StandardTrainersCatalog.LbfgsPoissonRegression(Microsoft.ML.RegressionCatalog.RegressionTrainers,System.String,System.String,System.String,System.Single,System.Single,System.Single,System.Int32,System.Boolean)"/>
53-
/// <seealso cref="Microsoft.ML.StandardTrainersCatalog.LbfgsPoissonRegression(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.LbfgsPoissonRegressionTrainer.Options)"/>
52+
/// <seealso cref="StandardTrainersCatalog.LbfgsPoissonRegression(RegressionCatalog.RegressionTrainers, string, string, string, float, float, float, int, bool)"/>
53+
/// <seealso cref="StandardTrainersCatalog.LbfgsPoissonRegression(RegressionCatalog.RegressionTrainers, LbfgsPoissonRegressionTrainer.Options)"/>
5454
/// <seealso cref="Options"/>
5555
public sealed class LbfgsPoissonRegressionTrainer : LbfgsTrainerBase<LbfgsPoissonRegressionTrainer.Options, RegressionPredictionTransformer<PoissonRegressionModelParameters>, PoissonRegressionModelParameters>
5656
{
@@ -60,7 +60,8 @@ public sealed class LbfgsPoissonRegressionTrainer : LbfgsTrainerBase<LbfgsPoisso
6060
internal const string Summary = "Poisson Regression assumes the unknown function, denoted Y has a Poisson distribution.";
6161

6262
/// <summary>
63-
/// Options for the <see cref="LbfgsPoissonRegressionTrainer"/>.
63+
/// Options for the <see cref="LbfgsPoissonRegressionTrainer"/> as used in
64+
/// [LbfgsPoissonRegression(Options)](xref:Microsoft.ML.StandardTrainersCatalog.LbfgsPoissonRegression(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.LbfgsPoissonRegressionTrainer.Options)).
6465
/// </summary>
6566
public sealed class Options : OptionsBase
6667
{

src/Microsoft.ML.StandardTrainers/StandardTrainersCatalog.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -573,11 +573,11 @@ public static LbfgsLogisticRegressionBinaryTrainer LbfgsLogisticRegression(this
573573
}
574574

575575
/// <summary>
576-
/// Creates a <see cref="Microsoft.ML.Trainers.LbfgsPoissonRegressionTrainer"/>, which predicts a target using a linear regression model.
576+
/// Create <see cref="LbfgsPoissonRegressionTrainer"/>, which predicts a target using a linear regression model.
577577
/// </summary>
578578
/// <param name="catalog">The regression catalog trainer object.</param>
579-
/// <param name="labelColumnName">The name of the label column. The column data must be <see cref="System.Single"/></param>
580-
/// <param name="featureColumnName">The name of the feature column. The column data must be a known-sized vector of <see cref="System.Single"/></param>
579+
/// <param name="labelColumnName">The name of the label column. The column data must be <see cref="System.Single"/>.</param>
580+
/// <param name="featureColumnName">The name of the feature column. The column data must be a known-sized vector of <see cref="System.Single"/>.</param>
581581
/// <param name="exampleWeightColumnName">The name of the example weight column (optional).</param>
582582
/// <param name="l1Regularization">The L1 <a href='https://en.wikipedia.org/wiki/Regularization_(mathematics)'>regularization</a> hyperparameter. Higher values will tend to lead to more sparse model.</param>
583583
/// <param name="l2Regularization">The L2 weight for <a href='https://en.wikipedia.org/wiki/Regularization_(mathematics)'>regularization</a>.</param>
@@ -606,7 +606,7 @@ public static LbfgsPoissonRegressionTrainer LbfgsPoissonRegression(this Regressi
606606
}
607607

608608
/// <summary>
609-
/// Creates a <see cref="Microsoft.ML.Trainers.LbfgsPoissonRegressionTrainer"/>, which predicts a target using a linear regression model with advanced options.
609+
/// Create <see cref="LbfgsPoissonRegressionTrainer"/> using advanced options, which predicts a target using a linear regression model.
610610
/// </summary>
611611
/// <param name="catalog">The regression catalog trainer object.</param>
612612
/// <param name="options">Trainer options.</param>

0 commit comments

Comments
 (0)