Skip to content

Commit 2425485

Browse files
committed
documentation.
1 parent 25c76f6 commit 2425485

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

src/Microsoft.ML.HalLearners/SymSgdClassificationTrainer.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ public void Check(IExceptionContext ectx)
9191
public override TrainerInfo Info { get; }
9292
private readonly Arguments _args;
9393

94-
///REVIEW: Copy-paste from LinearClassificationTrainer.
9594
/// <summary>
9695
/// This method ensures that the data meets the requirements of this trainer and its
9796
/// subclasses, injects necessary transforms, and throws if it couldn't meet them.

src/Microsoft.ML.HalLearners/doc.xml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,26 @@
2222
</code>
2323
</example>
2424
</member>
25-
25+
26+
<member name="SymSGD">
27+
<summary>
28+
Parallel Stochastic Gradient Descent trainer.
29+
</summary>
30+
<remarks>
31+
<a href='https://en.wikipedia.org/wiki/Stochastic_gradient_descent'>Stochastic gradient descent (SGD)</a> is an interative algorithm
32+
that optimizes a differentiable objective function. <a href='https://arxiv.org/abs/1705.08030'>SYMSGD</a> parallelizes SGD using Sound Combiners.
33+
</remarks>
34+
<example>
35+
<code language="csharp">
36+
new SymSgdBinaryClassifier()
37+
{
38+
NumberOfIterations = 50,
39+
L2Regularization = 0,
40+
Shuffle = true
41+
}
42+
</code>
43+
</example>
44+
</member>
45+
2646
</members>
2747
</doc>

0 commit comments

Comments
 (0)