OPENNLP-1150: TokenNameFinderTrainerTool should use ModelUtil.createD…

[kojisekig]

…efaultTrainingParameters() when mlParams is null

Thank you for contributing to Apache OpenNLP.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

• Is there a JIRA ticket associated with this PR? Is it referenced
  in the commit message?

• Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

• Has your PR been rebased against the latest commit within the target branch (typically master)?

• Is your initial contribution a single, squashed commit?

For code changes:

• Have you ensured that the full suite of tests is executed via mvn clean install at the root opennlp folder?
• Have you written or updated unit tests to verify your changes?
• If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
• If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp folder?
• If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp folder?

For documentation related changes:

• Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

[jzonthemtn]

Should the public constructor for TrainingParameters be made private?

[kottmann]

We probably set default somewhere in case they are missing. This change here would set the defaults to the default training parameters.

[danielruss]

No, please don’t make the constructor private. opennlp-tools is used as a library also. If you make the TrainingParameters constructor private, you can ONLY create training parameters via a file. Also a defaultTrainingParameters method uses this constructor. From: Jeff Zemerick <notifications@github.com> Reply-To: apache/opennlp <reply@reply.github.com> Date: Monday, October 23, 2017 at 7:32 AM To: apache/opennlp <opennlp@noreply.github.com> Cc: Subscribed <subscribed@noreply.github.com> Subject: Re: [apache/opennlp] OPENNLP-1150: TokenNameFinderTrainerTool should use ModelUtil.createD… (#281) @jzonthemtn commented on this pull request.

________________________________ In opennlp-tools/src/main/java/opennlp/tools/cmdline/namefind/TokenNameFinderTrainerTool.java<#281 (comment)>:

@@ -115,7 +114,7 @@ public void run(String format, String[] args) {

mlParams = CmdLineUtil.loadTrainingParameters(params.getParams(), true); if (mlParams == null) { - mlParams = new TrainingParameters(); Should the public constructor for TrainingParameters be made private? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub<#281 (review)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/ADl9e7QyZInReTI2dTWY6Z-wdMA1jmFuks5svHk0gaJpZM4QCh66>.

[jzonthemtn]

Thanks, @danielruss. Maybe a javadoc comment on the TrainingParameters constructor that says you can use ModelUtil.createDefaultTrainingParameters() would be helpful in case someone doesn't know it exists.

[smarthi]

Folks could we merge this into master after fixing the javadocs @kojisekig

[kojisekig]

Thanks everyone for reviewing this!

As @jzonthemtn commented, when I created this patch, I thought we could add the notice in the javadoc of TrainingParameters constructor so that users can know the existence of ModelUtil.createDefaultTrainingParameters(), but I noticed that the javadoc of ModelUtil.createDefaultTrainingParameters() says

Note: Do not use this method, internal use only!

So I didn't touch them. :)

Can someone explain the background on this?