Package co.elastic.clients.elasticsearch.ml

Class TotalFeatureImportance

java.lang.Object

co.elastic.clients.elasticsearch.ml.TotalFeatureImportance

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class TotalFeatureImportance
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final List<TotalFeatureImportanceClass>	classes()	Required - If the trained model is a classification model, feature importance statistics are gathered per target class value.
final String	featureName()	Required - The feature for which this importance was calculated.
final List<TotalFeatureImportanceStatistics>	importance()	Required - A collection of feature importance statistics related to the training data set for this particular feature.
static TotalFeatureImportance	of(Function<TotalFeatureImportance.Builder,ObjectBuilder<TotalFeatureImportance>> fn)
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	setupTotalFeatureImportanceDeserializer(ObjectDeserializer<TotalFeatureImportance.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TotalFeatureImportance> _DESERIALIZER

Json deserializer for TotalFeatureImportance

Method Details

of

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

featureName

public final String featureName()

Required - The feature for which this importance was calculated.

API name: feature_name

importance

public final List<TotalFeatureImportanceStatistics> importance()

Required - A collection of feature importance statistics related to the training data set for this particular feature.

API name: importance

classes

public final List<TotalFeatureImportanceClass> classes()

Required - If the trained model is a classification model, feature importance statistics are gathered per target class value.

API name: classes

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

setupTotalFeatureImportanceDeserializer

protected static void setupTotalFeatureImportanceDeserializer(ObjectDeserializer<TotalFeatureImportance.Builder> op)