Skip to content

Commit 4d517fb

Browse files
committed
XML documentation for Symbolic Stochastic Gradient Descent Trainer.
1 parent cc40049 commit 4d517fb

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

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

+5-4
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ namespace Microsoft.ML.Trainers
3636
/// </summary>
3737
/// <remarks>
3838
/// <format type="text/markdown"><![CDATA[
39-
/// To create this trainer, use [SymbolicStochasticGradientDescent](xref:Microsoft.ML.MklComponentsCatalog.SymbolicSgdLogisticRegression(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,System.String,System.String,System.Int32)
40-
/// or [SymbolicStochasticGradientDescent(Options)](xref:Microsoft.ML.MklComponentsCatalog.SymbolicSgdLogisticRegression(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options).
39+
/// To create this trainer, use [SymbolicStochasticGradientDescent](xref:Microsoft.ML.MklComponentsCatalog.SymbolicSgdLogisticRegression(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,System.String,System.String,System.Int32))
40+
/// or [SymbolicStochasticGradientDescent(Options)](xref:Microsoft.ML.MklComponentsCatalog.SymbolicSgdLogisticRegression(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options)).
4141
///
4242
/// [!include[io](~/../docs/samples/docs/api-reference/io-columns-binary-classification.md)]
4343
///
@@ -48,6 +48,7 @@ namespace Microsoft.ML.Trainers
4848
/// | Is normalization required? | Yes |
4949
/// | Is caching required? | No |
5050
/// | Required NuGet in addition to Microsoft.ML |Microsoft.ML.Mkl.Components |
51+
///
5152
/// ### Training Algorithm Details
5253
/// The symbolic SGD is a classification algorithm that makes its predictions by finding a separating hyperplane.
5354
/// For instance, with feature values $f0, f1,..., f_{D-1}$, the prediction is given by determining what side of the hyperplane the point falls into.
@@ -61,8 +62,8 @@ namespace Microsoft.ML.Trainers
6162
/// ]]>
6263
/// </format>
6364
/// </remarks>
64-
/// <seealso cref="MklComponentsCatalog.SymbolicSgdLogisticRegression(BinaryClassificationCatalog.BinaryClassificationTrainers, string, string, int)" />
65-
/// <seealso cref="MklComponentsCatalog.SymbolicSgdLogisticRegression(BinaryClassificationCatalog.BinaryClassificationTrainers, Options)"/>
65+
/// <seealso cref="Microsoft.ML.MklComponentsCatalog.SymbolicSgdLogisticRegression(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,System.String,System.String,System.Int32)" />
66+
/// <seealso cref="Microsoft.ML.MklComponentsCatalog.SymbolicSgdLogisticRegression(Microsoft.ML.BinaryClassificationCatalog.BinaryClassificationTrainers,Microsoft.ML.Trainers.SymbolicSgdLogisticRegressionBinaryTrainer.Options)"/>
6667
/// <seealso cref="Options"/>
6768
public sealed class SymbolicSgdLogisticRegressionBinaryTrainer : TrainerEstimatorBase<BinaryPredictionTransformer<TPredictor>, TPredictor>
6869
{

0 commit comments

Comments
 (0)