Package org.coordinatekit.crf.mallet.train

Class ModelOutputConfiguration

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

This immutable class encapsulates all configurable parameters for the model output evaluator. Use the ModelOutputConfiguration.Builder to construct instances.

Example usage: 

 
 ModelOutputConfiguration config = ModelOutputConfiguration.builder().outputDirectory(Path.of("models"))
         .filePrefix("crf_model").fileSuffix("ser").iterationInterval(10).build();
See Also:

  • Method Details

    • builder

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

    • defaults

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

      This is equivalent to calling ModelOutputConfiguration.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 "model".

      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 "ser".

      Returns:
      the file suffix

    • iterationInterval

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

      The model 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 model files.
      Returns:
      the output directory path