OPENNLP-124 : Fixed some comments and general refactoring.

Author: NishantShri4

Diff for: opennlp-tools/src/main/java/opennlp/tools/commons/Trainer.java

@@ -37,7 +37,7 @@ public interface Trainer {
   void init(TrainingParameters trainParams, Map<String, String> reportMap);
 
   /**
-   * Conducts the initialization of an {@link Trainer} via
+   * Conducts the initialization of a {@link Trainer} via
    * {@link TrainingParameters}, {@link Map report map} and {@link TrainingConfiguration}
    *
    * @param trainParams The {@link TrainingParameters} to use.

Diff for: opennlp-tools/src/main/java/opennlp/tools/ml/maxent/GISTrainer.java

@@ -504,7 +504,7 @@ private void findParameters(int iterations, double correctionConstant) {
     double prevLL = 0.0;
     double currLL;
 
-    //Get the Training Progress Monitor to log training progress.
+    //Get the Training Progress Monitor and the StopCriteria.
     TrainingProgressMonitor progressMonitor = getTrainingProgressMonitor(trainingConfiguration);
     StopCriteria stopCriteria = getStopCriteria(trainingConfiguration);
 

Diff for: opennlp-tools/src/main/java/opennlp/tools/ml/perceptron/PerceptronTrainer.java

@@ -263,7 +263,6 @@ public AbstractModel trainModel(int iterations, DataIndexer di, int cutoff, bool
 
     logger.info("Computing model parameters...");
 
-
     MutableContext[] finalParameters = findParameters(iterations, useAverage);
 
     logger.info("...done.");
@@ -300,6 +299,7 @@ private MutableContext[] findParameters(int iterations, boolean useAverage) {
       }
     }
 
+    //Get the Training Progress Monitor and the StopCriteria.
     TrainingProgressMonitor progressMonitor = getTrainingProgressMonitor(trainingConfiguration);
     StopCriteria stopCriteria = getStopCriteria(trainingConfiguration);
 
@@ -382,8 +382,6 @@ private MutableContext[] findParameters(int iterations, boolean useAverage) {
       // If the tolerance is greater than the difference between the
       // current training accuracy and all of the previous three
       // training accuracies, stop training.
-
-
       if (stopCriteria.test(prevAccuracy1 - trainingAccuracy)
           && stopCriteria.test(prevAccuracy2 - trainingAccuracy)
           && stopCriteria.test(prevAccuracy3 - trainingAccuracy)) {

Diff for: opennlp-tools/src/main/java/opennlp/tools/monitoring/DefaultTrainingProgressMonitor.java

@@ -54,7 +54,7 @@ public DefaultTrainingProgressMonitor() {
    */
   @Override
   public synchronized void finishedIteration(int iteration, int numberCorrectEvents, int totalEvents,
-                                TrainingMeasure measure, double measureValue) {
+                                             TrainingMeasure measure, double measureValue) {
     progress.add(String.format("%s: (%s/%s) %s : %s", iteration, numberCorrectEvents, totalEvents,
         measure.getMeasureName(), measureValue));
   }

Diff for: opennlp-tools/src/main/java/opennlp/tools/monitoring/IterDeltaAccuracyUnderTolerance.java

@@ -21,7 +21,7 @@
 import opennlp.tools.util.TrainingParameters;
 
 /**
- * A {@link StopCriteria} implementation to identify whether the
+ * A {@link StopCriteria} implementation to identify whether the absolute
  * difference between the training accuracy of current and previous iteration is under the defined tolerance.
  */
 public class IterDeltaAccuracyUnderTolerance implements StopCriteria {

Diff for: opennlp-tools/src/test/java/opennlp/tools/ml/MockEventTrainer.java

@@ -46,5 +46,4 @@ public void init(TrainingParameters trainParams, Map<String, String> reportMap,
                    TrainingConfiguration config) {
   }
 
-
 }

Diff for: opennlp-tools/src/test/java/opennlp/tools/monitoring/DefaultTrainingProgressMonitorTest.java

@@ -42,7 +42,7 @@ class DefaultTrainingProgressMonitorTest {
   private TrainingProgressMonitor progressMonitor;
   private final ListAppender<ILoggingEvent> appender = new ListAppender<>();
   private static final Logger logger = (Logger) LoggerFactory.getLogger(LOGGER_NAME);
-  private static final Level originalLogLevel  = logger.getLevel();
+  private static final Level originalLogLevel  = logger != null ? logger.getLevel() : Level.OFF;
 
   @BeforeAll
   static void beforeAll() {
@@ -78,6 +78,7 @@ void testTrainingEndWithStopCriteria() {
     progressMonitor.finishedTraining(150, stopCriteria);
     progressMonitor.displayAndClear();
 
+    //Assert that the logs captured the training completion message with StopCriteria satisfied.
     Assertions.assertThat(appender.list.stream().map(ILoggingEvent::getMessage).
             collect(Collectors.toList())).
         isEqualTo(List.of("Stopping: change in training set accuracy less than {2.0E-5}"));
@@ -88,6 +89,7 @@ void testTrainingEndWithoutHittingStopCriteria() {
     progressMonitor.finishedTraining(150, null);
     progressMonitor.displayAndClear();
 
+    //Assert that the logs captured the training completion message when all iterations are exhausted.
     Assertions.assertThat(appender.list.stream().map(ILoggingEvent::getMessage).
             collect(Collectors.toList())).
         isEqualTo(List.of("Training Finished after completing 150 Iterations successfully."));