[
https://issues.apache.org/jira/browse/OPENNLP-1423?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17651715#comment-17651715
]
ASF GitHub Bot commented on OPENNLP-1423:
-----------------------------------------
rzo1 commented on code in PR #469:
URL: https://github.com/apache/opennlp/pull/469#discussion_r1056619744
##########
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:
If it is `@Deprecated` (as it was pulled up from some implementing classes),
why should we keep it in the interface, i.e. shouldn't we just remove it here
and migrate the remaining four usages to the other signature?
We already broke binary compatibility, so imho it would be a good
opportunity to get rid of it instead of keeping it in the interface. Wdyt,
@mawiesne @jzonthemtn ?
##########
opennlp-tools/src/main/java/opennlp/tools/ml/model/AbstractDataIndexer.java:
##########
@@ -188,17 +233,15 @@ protected List<ComparableEvent> index(ObjectStream<Event>
events,
return eventsToCompare;
}
- public int getNumEvents() {
- return numEvents;
- }
-
/**
- * Updates the set of predicated and counter with the specified event
contexts and cutoff.
+ * Updates the set of predicates and counter with the specified event
contexts and cutoff.
+ *
* @param ec The contexts/features which occur in a event.
* @param predicateSet The set of predicates which will be used for model
building.
* @param counter The predicate counters.
* @param cutoff The cutoff which determines whether a predicate is included.
- * @deprecated will be removed after 1.8.1 release
+ *
+ * @deprecated Use {{@link #update(String[], Map)}}. This method will be
removed after 1.8.1 release
Review Comment:
"1.8.1" did happen a while ago? maybe time to remove? wdyt?
> 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)
