Package org.coordinatekit.crf.mallet.train

Class ModelOutputConfiguration.Builder

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

All parameters have sensible defaults.

Example: 

 
 ModelOutputConfiguration config = ModelOutputConfiguration.builder().outputDirectory(Path.of("models"))
         .filePrefix("crf_model").iterationInterval(5).build();

  • Method Details

    • build

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

    • filePrefix

      public ModelOutputConfiguration.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 ModelOutputConfiguration.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 ModelOutputConfiguration.Builder iterationInterval(int iterationInterval)
      Sets the iteration interval for writing model files.
      Parameters:
      iterationInterval - the interval, must be positive
      Returns:
      this builder
      Throws:
      IllegalArgumentException - if iterationInterval is not positive

    • outputDirectory

      public ModelOutputConfiguration.Builder outputDirectory(Path outputDirectory)
      Sets the directory in which to write model files.
      Parameters:
      outputDirectory - the output directory path, must not be null
      Returns:
      this builder
      Throws:
      NullPointerException - if outputDirectory is null