hex.ModelParametersBuilderFactory Maven / Gradle / Ivy

Go to download
package hex;

import water.util.PojoUtils;

/**
 * Factory for creating model parameters builders.
 *
 * @param   type of produced model parameters object
 */
public interface ModelParametersBuilderFactory {

  /** Get parameters builder for initial parameters.
   *
   * 
   *   The builder modifies passed parameters object, so the caller
   *   is responsible for cloning it if it is necessary.
   * 
   *
   * @param initialParams  initial model parameters which will be modified
   * @return  this parameters builder
   */
  ModelParametersBuilder get(MP initialParams);

  /**
   * Returns mapping from input parameter specification to
   * attribute names of MP.
   * @return  naming strategy
   */
  PojoUtils.FieldNaming getFieldNamingStrategy();

  /** A generic interface to configure a given initial parameters object
   * via sequence of {@link #set} method calls.
   *
   * 
   * The usage is sequence of set calls finalized by
   * build call which produces final version of parameters.
   * 
   *
   * @param   type of produced model parameters object
   */
   interface ModelParametersBuilder {

    ModelParametersBuilder set(String name, Object value);

    MP build();
  }
}