Module org.elasticsearch.xcore

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

Class Ensemble

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.trainedmodel.ensemble.Ensemble

All Implemented Interfaces:

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

public class Ensemble
extends Object
implements LenientlyParsedTrainedModel, StrictlyParsedTrainedModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Ensemble.Builder

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	AGGREGATE_OUTPUT
static final ParseField	CLASSIFICATION_LABELS
static final ParseField	CLASSIFICATION_WEIGHTS
static final ParseField	FEATURE_NAMES
static final ParseField	NAME
static final ParseField	TRAINED_MODELS

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

NULL_ACCOUNTABLE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Ensemble(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static Ensemble.Builder	builder()
boolean	equals(Object o)
long	estimatedNumOperations()
static Ensemble	fromXContentLenient(XContentParser parser)
static Ensemble	fromXContentStrict(XContentParser parser)
Collection<org.apache.lucene.util.Accountable>	getChildResources()
TransportVersion	getMinimalCompatibilityVersion()
List<TrainedModel>	getModels()
String	getName()
String	getWriteableName()
int	hashCode()
long	ramBytesUsed()
TargetType	targetType()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	validate()	Runs validations against the model.
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 ParseField NAME

FEATURE_NAMES

public static final ParseField FEATURE_NAMES

TRAINED_MODELS

public static final ParseField TRAINED_MODELS

AGGREGATE_OUTPUT

public static final ParseField AGGREGATE_OUTPUT

CLASSIFICATION_LABELS

public static final ParseField CLASSIFICATION_LABELS

CLASSIFICATION_WEIGHTS

public static final ParseField CLASSIFICATION_WEIGHTS

Constructor Details

Ensemble

public Ensemble(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

fromXContentStrict

public static Ensemble fromXContentStrict(XContentParser parser)

fromXContentLenient

public static Ensemble fromXContentLenient(XContentParser parser)

getModels

public List<TrainedModel> getModels()

targetType

public TargetType targetType()

Specified by:

targetType in interface TrainedModel

Returns:

TargetType for the model.

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

validate

public void validate()

Description copied from interface: TrainedModel

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

Specified by:

validate in interface TrainedModel

estimatedNumOperations

public long estimatedNumOperations()

Specified by:

estimatedNumOperations in interface TrainedModel

Returns:

The estimated number of operations required at inference time

builder

public static Ensemble.Builder builder()

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable

getChildResources

public Collection<org.apache.lucene.util.Accountable> getChildResources()

Specified by:

getChildResources in interface org.apache.lucene.util.Accountable

getMinimalCompatibilityVersion

public TransportVersion getMinimalCompatibilityVersion()

Specified by:

getMinimalCompatibilityVersion in interface TrainedModel