[
https://issues.apache.org/jira/browse/OPENNLP-1423?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17651985#comment-17651985
]
ASF GitHub Bot commented on OPENNLP-1423:
-----------------------------------------
mawiesne commented on code in PR #469:
URL: https://github.com/apache/opennlp/pull/469#discussion_r1057168805
##########
opennlp-tools/src/main/java/opennlp/tools/commons/Trainer.java:
##########
@@ -17,8 +17,36 @@
package opennlp.tools.commons;
+import java.util.Map;
+
+import opennlp.tools.ml.AbstractTrainer;
+import opennlp.tools.ml.EventModelSequenceTrainer;
+import opennlp.tools.util.TrainingParameters;
+
/**
* Represents a common base for training implementations.
*/
public interface Trainer {
+
+ /**
+ * Initializes a {@link AbstractTrainer} via {@link TrainingParameters} and
+ * a {@link Map report map}.
+ *
+ * @param trainParams The {@link Map} that maps training parameters on a
key-value basis.
+ * @param reportMap The {@link Map} instance used as report map.
+ *
+ * @deprecated Use {@link #init(TrainingParameters, Map)} instead.
+ */
+ @Deprecated
+ void init(Map<String, Object> trainParams, Map<String, String> reportMap);
Review Comment:
Resolved with latest commit. The oldskool method now resides in
`AbstractTrainer` not in the `Trainer` interface.
> Enhance JavaDoc in opennlp.tools.ml package
> -------------------------------------------
>
> Key: OPENNLP-1423
> URL: https://issues.apache.org/jira/browse/OPENNLP-1423
> Project: OpenNLP
> Issue Type: Improvement
> Components: Machine Learning
> Affects Versions: 2.1.0
> Reporter: Martin Wiesner
> Assignee: Martin Wiesner
> Priority: Minor
> Fix For: 2.1.1
>
>
> The JavaDoc of the _opennlp.tools.ml_ packages suffer from several
> inconsistencies and missing descriptions. Moreover, several typos are present
> that need sanitizing.
> The classes, interfaces, etc., require enhancements and/or additions to
> provide more clarity for readers.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
