Package org.coordinatekit.crf.mallet.train

Class ConllOutputConfiguration

java.lang.Object
org.coordinatekit.crf.mallet.train.ConllOutputConfiguration
@NullMarked public final class ConllOutputConfiguration extends Object
Configuration settings for ConllOutputEvaluator.

This immutable class encapsulates all configurable parameters for the CoNLL output evaluator. Use the ConllOutputConfiguration.Builder to construct instances. The ConllOutputConfiguration.Builder.outputDirectory(Path) must be set before calling ConllOutputConfiguration.Builder.build().

Example usage: 

 
 ConllOutputEvaluatorConfiguration config = ConllOutputEvaluatorConfiguration.builder()
         .outputDirectory(Path.of("output")).filePrefix("predictions").fileSuffix("tsv").iterationInterval(10)
         .build();
See Also:

  • Method Details

    • builder

      public static ConllOutputConfiguration.Builder builder()
      Returns a new ConllOutputConfiguration.Builder instance for constructing a configuration.
      Returns:
      a new builder with default values

    • defaults

      public static ConllOutputConfiguration defaults()
      Returns a configuration with all default values.

      This is equivalent to calling ConllOutputEvaluatorConfiguration.builder().build().

      Returns:
      a configuration with default settings

    • filePrefix

      public String filePrefix()
      Returns the prefix for output file names.

      Output files are named as {prefix}_iter{N}.{suffix}. Default is "output".

      Returns:
      the file prefix

    • fileSuffix

      public String fileSuffix()
      Returns the suffix (extension) for output file names.

      Output files are named as {prefix}_iter{N}.{suffix}. Default is "conll".

      Returns:
      the file suffix

    • iterationInterval

      public int iterationInterval()
      Returns the iteration interval for writing output files.

      Output is written every N iterations. For example, if set to 10, files are written at iterations 10, 20, 30, etc. Default is 10.

      Returns:
      the iteration interval

    • outputDirectory

      public Path outputDirectory()
      Returns the directory in which to write output files.
      Returns:
      the output directory path