Package co.elastic.clients.elasticsearch.ml

Class Hyperparameter.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<Hyperparameter.Builder>
co.elastic.clients.elasticsearch.ml.Hyperparameter.Builder
All Implemented Interfaces:
WithJson<Hyperparameter.Builder>, ObjectBuilder<Hyperparameter>
Enclosing class:
Hyperparameter
public static class Hyperparameter.Builder extends WithJsonObjectBuilderBase<Hyperparameter.Builder> implements ObjectBuilder<Hyperparameter>
Builder for Hyperparameter.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • absoluteImportance

      public final Hyperparameter.Builder absoluteImportance(@Nullable Double value)
      A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.

      API name: absolute_importance

    • name

      public final Hyperparameter.Builder name(String value)
      Required - Name of the hyperparameter.

      API name: name

    • relativeImportance

      public final Hyperparameter.Builder relativeImportance(@Nullable Double value)
      A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.

      API name: relative_importance

    • supplied

      public final Hyperparameter.Builder supplied(boolean value)
      Required - Indicates if the hyperparameter is specified by the user (true) or optimized (false).

      API name: supplied

    • value

      public final Hyperparameter.Builder value(double value)
      Required - The value of the hyperparameter, either optimized or specified by the user.

      API name: value

    • self

      protected Hyperparameter.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<Hyperparameter.Builder>

    • build

      public Hyperparameter build()
      Builds a Hyperparameter.
      Specified by:
      build in interface ObjectBuilder<Hyperparameter>
      Throws:
      NullPointerException - if some of the required fields are null.