[
https://issues.apache.org/jira/browse/OPENNLP-1410?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17649326#comment-17649326
]
ASF GitHub Bot commented on OPENNLP-1410:
-----------------------------------------
mawiesne commented on code in PR #456:
URL: https://github.com/apache/opennlp/pull/456#discussion_r1052216345
##########
opennlp-tools/src/main/java/opennlp/tools/namefind/TokenNameFinderModel.java:
##########
@@ -88,37 +117,109 @@ public TokenNameFinderModel(String languageCode,
MaxentModel nameFinderModel, in
}
}
- // TODO: Extend this one with beam size!
- public TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel,
- byte[] generatorDescriptor, Map<String, Object> resources, Map<String,
String> manifestInfoEntries) {
+ /**
+ * Initializes a {@link TokenNameFinderModel} instance via given parameters.
+ *
+ * @param languageCode The ISO conform language code.
+ * @param nameFinderModel A valid {@link MaxentModel}.
+ * @param generatorDescriptor The {@code byte[]} representing the feature
generator descriptor.
+ * @param resources Additional resources in a mapping.
+ * @param manifestInfoEntries Additional information kept in the manifest.
+ *
+ * @throws IllegalArgumentException Thrown if the {@code namFinderModel}
incompatible
+ * with {@code seqCodec}.
+ */
+ public TokenNameFinderModel(String languageCode, MaxentModel
nameFinderModel, byte[] generatorDescriptor,
+ Map<String, Object> resources, Map<String,
String> manifestInfoEntries) {
this(languageCode, nameFinderModel, NameFinderME.DEFAULT_BEAM_SIZE,
- generatorDescriptor, resources, manifestInfoEntries, new BioCodec(),
new TokenNameFinderFactory());
+ generatorDescriptor, resources, manifestInfoEntries,
+ new BioCodec(), new TokenNameFinderFactory());
}
+ /**
+ * Initializes a {@link TokenNameFinderModel} instance via given parameters.
+ *
+ * @param languageCode The ISO conform language code.
+ * @param nameFinderModel A valid {@link MaxentModel}.
+ * @param beamSize The beam size. Must be greater than {@code 0}.
+ * @param generatorDescriptor The {@code byte[]} representing the feature
generator descriptor.
+ * @param resources Additional resources in a mapping.
+ * @param manifestInfoEntries Additional information kept in the manifest.
+ *
+ * @throws IllegalArgumentException Thrown if the {@code namFinderModel}
incompatible
+ * with {@code seqCodec}.
+ */
+ public TokenNameFinderModel(String languageCode, MaxentModel
nameFinderModel, int beamSize,
+ byte[] generatorDescriptor, Map<String, Object>
resources,
+ Map<String, String> manifestInfoEntries) {
+ this(languageCode, nameFinderModel, beamSize,
+ generatorDescriptor, resources, manifestInfoEntries,
+ new BioCodec(), new TokenNameFinderFactory());
+ }
+
+ /**
+ * Initializes a {@link TokenNameFinderModel} instance via given parameters.
+ *
+ * @param languageCode The ISO conform language code.
+ * @param nameFinderModel A valid {@link MaxentModel}.
+ * @param resources Additional resources in a mapping.
+ * @param manifestInfoEntries Additional information kept in the manifest.
+ *
+ * @throws IllegalArgumentException Thrown if the {@code namFinderModel}
incompatible
Review Comment:
Eagle eye!
> Enhance JavaDoc in opennlp.tools.namefind package
> -------------------------------------------------
>
> Key: OPENNLP-1410
> URL: https://issues.apache.org/jira/browse/OPENNLP-1410
> Project: OpenNLP
> Issue Type: Improvement
> Components: Name Finder
> Affects Versions: 2.1.0
> Reporter: Martin Wiesner
> Assignee: Martin Wiesner
> Priority: Minor
> Fix For: 2.1.1
>
>
> The JavaDoc the _opennlp.tools.namefind_ package suffers from several
> inconsistencies and missing descriptions. Moreover, several typos are present
> that need sanitizing.
> It needs enhancements and/or additions to provide more clarity for readers.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
