Module org.elasticsearch.xcore

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

Interface TrainedModel

All Superinterfaces:

org.apache.lucene.util.Accountable, NamedWriteable, NamedXContentObject, ToXContent, ToXContentObject, Writeable

All Known Subinterfaces:

LenientlyParsedTrainedModel, StrictlyParsedTrainedModel

All Known Implementing Classes:

Ensemble, LangIdentNeuralNetwork, Tree

public interface TrainedModel
extends NamedXContentObject, NamedWriteable, org.apache.lucene.util.Accountable

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 inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
long	estimatedNumOperations()
default TransportVersion	getMinimalCompatibilityVersion()
TargetType	targetType()
void	validate()	Runs validations against the model.

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources, ramBytesUsed

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.xpack.core.ml.utils.NamedXContentObject

getName

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Method Details

targetType

TargetType targetType()

Returns:

TargetType for the model.

validate

void validate()

Runs validations against the model. Example: Tree should check if there are any loops

Throws:

ElasticsearchException - if validations fail

estimatedNumOperations

long estimatedNumOperations()

Returns:

The estimated number of operations required at inference time

getMinimalCompatibilityVersion

default TransportVersion getMinimalCompatibilityVersion()