Package co.elastic.clients.elasticsearch.ml

Class Hyperparameter

java.lang.Object

co.elastic.clients.elasticsearch.ml.Hyperparameter

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public final class Hyperparameter
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Hyperparameter.Builder	Builder for Hyperparameter.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<Hyperparameter>	_DESERIALIZER	Json deserializer for Hyperparameter

Constructor Summary

Constructors

Constructor	Description
Hyperparameter(Hyperparameter.Builder builder)
Hyperparameter(java.util.function.Function<Hyperparameter.Builder,Hyperparameter.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Double	absoluteImportance()	A positive number showing how much the parameter influences the variation of the loss function.
java.lang.String	name()	Required - Name of the hyperparameter.
java.lang.Double	relativeImportance()	A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHyperparameterDeserializer(DelegatingDeserializer<Hyperparameter.Builder> op)
boolean	supplied()	Required - Indicates if the hyperparameter is specified by the user (true) or optimized (false).
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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Hyperparameter> _DESERIALIZER

Json deserializer for Hyperparameter

Constructor Details

Hyperparameter

public Hyperparameter(Hyperparameter.Builder builder)

Hyperparameter

public Hyperparameter(java.util.function.Function<Hyperparameter.Builder,Hyperparameter.Builder> fn)

Method Details

absoluteImportance

@Nullable
public java.lang.Double absoluteImportance()

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 java.lang.String name()

Required - Name of the hyperparameter.

API name: name

relativeImportance

@Nullable
public java.lang.Double relativeImportance()

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 boolean supplied()

Required - Indicates if the hyperparameter is specified by the user (true) or optimized (false).

API name: supplied

value

public double value()

Required - The value of the hyperparameter, either optimized or specified by the user.

API name: value

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

setupHyperparameterDeserializer

protected static void setupHyperparameterDeserializer(DelegatingDeserializer<Hyperparameter.Builder> op)