Skip to content

Commit a36641c

Browse files
committed
PR feedback.
1 parent c0312b5 commit a36641c

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

src/Microsoft.ML.Mkl.Components/MklComponentsCatalog.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ namespace Microsoft.ML
1515
public static class MklComponentsCatalog
1616
{
1717
/// <summary>
18-
/// Creates a <see cref="OlsTrainer"/>, which predicts a target using a linear regression model.
18+
/// Creates <see cref="OlsTrainer"/>, which predicts a target using a linear regression model.
1919
/// </summary>
2020
/// <param name="catalog">The <see cref="RegressionCatalog"/>.</param>
21-
/// <param name="labelColumnName">The name of the label column. The column data must be <see cref="System.Single"/></param>
22-
/// <param name="featureColumnName">The name of the feature column. The column data must be a known-sized vector of <see cref="System.Single"/></param>
21+
/// <param name="labelColumnName">The name of the label column. The column data must be <see cref="System.Single"/>.</param>
22+
/// <param name="featureColumnName">The name of the feature column. The column data must be a known-sized vector of <see cref="System.Single"/>.</param>
2323
/// <param name="exampleWeightColumnName">The name of the example weight column (optional).</param>
2424
/// <example>
2525
/// <format type="text/markdown">
@@ -46,7 +46,7 @@ public static OlsTrainer Ols(this RegressionCatalog.RegressionTrainers catalog,
4646
}
4747

4848
/// <summary>
49-
/// Creates a <see cref="OlsTrainer"/>, which predicts a target using a linear regression model with advanced options.
49+
/// Create <see cref="OlsTrainer"/> using advanced options, which predicts a target using a linear regression model.
5050
/// </summary>
5151
/// <param name="catalog">The <see cref="RegressionCatalog"/>.</param>
5252
/// <param name="options">Algorithm advanced options. See <see cref="OlsTrainer.Options"/>.</param>

src/Microsoft.ML.Mkl.Components/OlsLinearRegression.cs

+6-5
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ namespace Microsoft.ML.Trainers
3737
/// </summary>
3838
/// <remarks>
3939
/// <format type="text/markdown"><![CDATA[
40-
/// To create this trainer, use [Ols](xref:Microsoft.ML.MklComponentsCatalog.Ols(Microsoft.ML.RegressionCatalog.RegressionTrainers, System.String, System.String, System.String))
41-
/// or [Ols(Options)](xref:Microsoft.ML.MklComponentsCatalog.Ols(Microsoft.ML.RegressionCatalog.RegressionTrainers, Microsoft.ML.Trainers.OlsTrainer.Options)).
40+
/// To create this trainer, use [Ols](xref:Microsoft.ML.MklComponentsCatalog.Ols(Microsoft.ML.RegressionCatalog.RegressionTrainers,System.String,System.String,System.String))
41+
/// or [Ols(Options)](xref:Microsoft.ML.MklComponentsCatalog.Ols(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.OlsTrainer.Options)).
4242
///
4343
/// [!include[io](~/../docs/samples/docs/api-reference/io-columns-regression.md)]
4444
///
@@ -57,13 +57,14 @@ namespace Microsoft.ML.Trainers
5757
/// ]]>
5858
/// </format>
5959
/// </remarks>
60-
/// <seealso cref="Microsoft.ML.MklComponentsCatalog.Ols(Microsoft.ML.RegressionCatalog.RegressionTrainers, System.String, System.String, System.String)"/>
61-
/// <seealso cref="Microsoft.ML.MklComponentsCatalog.Ols(Microsoft.ML.RegressionCatalog.RegressionTrainers, Microsoft.ML.Trainers.OlsTrainer.Options)"/>
60+
/// <seealso cref="MklComponentsCatalog.Ols(RegressionCatalog.RegressionTrainers, string, string, string)"/>
61+
/// <seealso cref="MklComponentsCatalog.Ols(RegressionCatalog.RegressionTrainers, OlsTrainer.Options)"/>
6262
/// <seealso cref="Options"/>
6363
public sealed class OlsTrainer : TrainerEstimatorBase<RegressionPredictionTransformer<OlsModelParameters>, OlsModelParameters>
6464
{
6565
/// <summary>
66-
/// Options for the <see cref="OlsTrainer"/>.
66+
/// Options for the <see cref="OlsTrainer"/> as used in
67+
/// [Ols(Options)](xref:Microsoft.ML.MklComponentsCatalog.Ols(Microsoft.ML.RegressionCatalog.RegressionTrainers,Microsoft.ML.Trainers.OlsTrainer.Options))
6768
/// </summary>
6869
public sealed class Options : TrainerInputBaseWithWeight
6970
{

0 commit comments

Comments
 (0)