Package co.elastic.clients.elasticsearch.ml

Class Hyperparameter

java.lang.Object

co.elastic.clients.elasticsearch.ml.Hyperparameter

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class Hyperparameter
extends Object
implements JsonpSerializable

See Also:

• API specification

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 final JsonpDeserializer<Hyperparameter>	_DESERIALIZER	Json deserializer for Hyperparameter

Method Summary

Modifier and Type	Method	Description
final Double	absoluteImportance()	A positive number showing how much the parameter influences the variation of the loss function.
final String	name()	Required - Name of the hyperparameter.
static Hyperparameter	of(Function<Hyperparameter.Builder,ObjectBuilder<Hyperparameter>> fn)
final 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(ObjectDeserializer<Hyperparameter.Builder> op)
final boolean	supplied()	Required - Indicates if the hyperparameter is specified by the user (true) or optimized (false).
String	toString()
final 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, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Hyperparameter> _DESERIALIZER

Json deserializer for Hyperparameter

Method Details

of

public static Hyperparameter of(Function<Hyperparameter.Builder,ObjectBuilder<Hyperparameter>> fn)

absoluteImportance

@Nullable
public final 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 final String name()

Required - Name of the hyperparameter.

API name: name

relativeImportance

@Nullable
public final 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 final boolean supplied()

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

API name: supplied

value

public final 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)

toString

public String toString()

Overrides:

toString in class Object

setupHyperparameterDeserializer

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