Package org.coordinatekit.crf.mallet.train

Class ConllOutputConfiguration.Builder

java.lang.Object
org.coordinatekit.crf.mallet.train.ConllOutputConfiguration.Builder
Enclosing class:
ConllOutputConfiguration
@NullMarked public static final class ConllOutputConfiguration.Builder extends Object
Builder for constructing ConllOutputConfiguration instances.

The outputDirectory(Path) must be set before calling build(). All other parameters have sensible defaults.

Example: 

 
 ConllOutputEvaluatorConfiguration config = ConllOutputEvaluatorConfiguration.builder()
         .outputDirectory(Path.of("results")).filePrefix("test_predictions").iterationInterval(5).build();

  • Method Details

    • build

      public ConllOutputConfiguration build()
      Builds the configuration with the current settings.
      Returns:
      an immutable configuration instance

    • filePrefix

      public ConllOutputConfiguration.Builder filePrefix(String filePrefix)
      Sets the prefix for output file names.
      Parameters:
      filePrefix - the file prefix, must not be null
      Returns:
      this builder
      Throws:
      NullPointerException - if filePrefix is null

    • fileSuffix

      public ConllOutputConfiguration.Builder fileSuffix(String fileSuffix)
      Sets the suffix (extension) for output file names.
      Parameters:
      fileSuffix - the file suffix, must not be null
      Returns:
      this builder
      Throws:
      NullPointerException - if fileSuffix is null

    • iterationInterval

      public ConllOutputConfiguration.Builder iterationInterval(int iterationInterval)
      Sets the iteration interval for writing output files.
      Parameters:
      iterationInterval - the interval, must be positive
      Returns:
      this builder
      Throws:
      IllegalArgumentException - if iterationInterval is not positive

    • outputDirectory

      public ConllOutputConfiguration.Builder outputDirectory(Path outputDirectory)
      Sets the directory in which to write output files.

      This is a required parameter and must be set before calling build().

      Parameters:
      outputDirectory - the output directory path, must not be null
      Returns:
      this builder
      Throws:
      NullPointerException - if outputDirectory is null