[
https://issues.apache.org/jira/browse/FLINK-2083?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14558812#comment-14558812
]
ASF GitHub Bot commented on FLINK-2083:
---------------------------------------
Github user tillrohrmann commented on a diff in the pull request:
https://github.com/apache/flink/pull/715#discussion_r31010852
--- Diff: docs/libs/ml/optimization.md ---
@@ -184,12 +192,15 @@ mini-batch SGD will be performed.
</td>
</tr>
<tr>
- <td><strong>Prediction Function</strong></td>
+ <td><strong>ConvergenceThreshold</strong></td>
<td>
<p>
- Class that provides the prediction function, used to calculate
$\hat{y}$ based on the
- weights and the example features, and the prediction gradient.
- (Default value: <strong>LinearPrediction</strong>)
+ When set, this value acts as a convergence stopping criterion
for the algorithm.
+ If the relative difference in the objective function (loss)
between two consecutive
+ iterations
+ is less than this value we stop the iterations and return the
last weights.
+ This allows us to avoid unnecessary iterations after the
algorithm has converged.
+ (Default value: <strong>None</strong>)
--- End diff --
Maybe we could specify the convergence criterion also as a formula, then
it's clear which value is used to calculate the relative change. Maybe we can
make a list with all supported convergence schemes (at the moment only the
relative change one).
> Ensure high quality docs for FlinkML in 0.9
> -------------------------------------------
>
> Key: FLINK-2083
> URL: https://issues.apache.org/jira/browse/FLINK-2083
> Project: Flink
> Issue Type: Improvement
> Components: Machine Learning Library
> Reporter: Theodore Vasiloudis
> Assignee: Theodore Vasiloudis
> Labels: ML
> Fix For: 0.9
>
>
> As defined in our vision for FlinkML, providing high-quality documentation is
> a primary goal for us.
> This issue concerns the docs that will be included in 0.9, and will track
> improvements and additions for the release.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
