Package co.elastic.clients.elasticsearch.ml

Class Hyperparameter.Builder

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

  • Constructor Summary

    Constructors
    Constructor Description
    Builder()  

  • Method Summary

    Modifier and Type Method Description
    Hyperparameter.Builder absoluteImportance​(java.lang.Double value)
    A positive number showing how much the parameter influences the variation of the loss function.
    Hyperparameter build()
    Builds a Hyperparameter.
    Hyperparameter.Builder name​(java.lang.String value)
    Required - Name of the hyperparameter.
    Hyperparameter.Builder relativeImportance​(java.lang.Double value)
    A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters.
    Hyperparameter.Builder supplied​(boolean value)
    Required - Indicates if the hyperparameter is specified by the user (true) or optimized (false).
    Hyperparameter.Builder value​(double value)
    Required - The value of the hyperparameter, either optimized or specified by the user.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • absoluteImportance

      public Hyperparameter.Builder absoluteImportance​(@Nullable java.lang.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 Hyperparameter.Builder name​(java.lang.String value)
      Required - Name of the hyperparameter.

      API name: name

    • relativeImportance

      public Hyperparameter.Builder relativeImportance​(@Nullable java.lang.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 Hyperparameter.Builder supplied​(boolean value)
      Required - Indicates if the hyperparameter is specified by the user (true) or optimized (false).

      API name: supplied

    • value

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

      API name: value

    • build

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