Package co.elastic.clients.elasticsearch.ml

Class TotalFeatureImportance

java.lang.Object

co.elastic.clients.elasticsearch.ml.TotalFeatureImportance

All Implemented Interfaces:

JsonpSerializable

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

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

Constructor Summary

Constructors

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

Method Summary

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

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<TotalFeatureImportance> _DESERIALIZER

Json deserializer for TotalFeatureImportance

Constructor Details

TotalFeatureImportance

public TotalFeatureImportance(TotalFeatureImportance.Builder builder)

TotalFeatureImportance

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

Method Details

featureName

public java.lang.String featureName()

Required - The feature for which this importance was calculated.

API name: feature_name

importance

public java.util.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 java.util.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)

setupTotalFeatureImportanceDeserializer

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