Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.inference.trainedmodel.metadata

Class TrainedModelMetadata

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.trainedmodel.metadata.TrainedModelMetadata

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class TrainedModelMetadata
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	FEATURE_IMPORTANCE_BASELINE
static final ParseField	HYPERPARAMETERS
static final ConstructingObjectParser<TrainedModelMetadata,Void>	LENIENT_PARSER
static final ParseField	MODEL_ID
static final String	NAME
static final ConstructingObjectParser<TrainedModelMetadata,Void>	STRICT_PARSER
static final ParseField	TOTAL_FEATURE_IMPORTANCE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TrainedModelMetadata(String modelId, List<TotalFeatureImportance> totalFeatureImportances, FeatureImportanceBaseline featureImportanceBaselines, List<Hyperparameters> hyperparameters)
TrainedModelMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static String	docId(String modelId)
boolean	equals(Object o)
static TrainedModelMetadata	fromXContent(XContentParser parser, boolean lenient)
String	getDocId()
FeatureImportanceBaseline	getFeatureImportanceBaselines()
List<Hyperparameters>	getHyperparameters()
String	getModelId()
List<TotalFeatureImportance>	getTotalFeatureImportances()
int	hashCode()
static String	modelId(String docId)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

TOTAL_FEATURE_IMPORTANCE

public static final ParseField TOTAL_FEATURE_IMPORTANCE

HYPERPARAMETERS

public static final ParseField HYPERPARAMETERS

FEATURE_IMPORTANCE_BASELINE

public static final ParseField FEATURE_IMPORTANCE_BASELINE

MODEL_ID

public static final ParseField MODEL_ID

LENIENT_PARSER

public static final ConstructingObjectParser<TrainedModelMetadata,Void> LENIENT_PARSER

STRICT_PARSER

public static final ConstructingObjectParser<TrainedModelMetadata,Void> STRICT_PARSER

Constructor Details

TrainedModelMetadata

public TrainedModelMetadata(StreamInput in)
                     throws IOException

Throws:

IOException

TrainedModelMetadata

public TrainedModelMetadata(String modelId,
 List<TotalFeatureImportance> totalFeatureImportances,
 FeatureImportanceBaseline featureImportanceBaselines,
 List<Hyperparameters> hyperparameters)

Method Details

fromXContent

public static TrainedModelMetadata fromXContent(XContentParser parser,
 boolean lenient)
                                         throws IOException

Throws:

IOException

docId

public static String docId(String modelId)

modelId

public static String modelId(String docId)

getModelId

public String getModelId()

getDocId

public String getDocId()

getTotalFeatureImportances

public List<TotalFeatureImportance> getTotalFeatureImportances()

getFeatureImportanceBaselines

public FeatureImportanceBaseline getFeatureImportanceBaselines()

getHyperparameters

public List<Hyperparameters> getHyperparameters()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException