Module org.elasticsearch.xcore

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

Class Tree

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.trainedmodel.tree.Tree

All Implemented Interfaces:

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

public class Tree
extends Object
implements LenientlyParsedTrainedModel, StrictlyParsedTrainedModel, org.apache.lucene.util.Accountable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Tree.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	CLASSIFICATION_LABELS
static final ParseField	FEATURE_NAMES
static final ParseField	NAME
static final ParseField	TREE_STRUCTURE

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
Tree(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static Tree.Builder	builder()
boolean	equals(Object o)
long	estimatedNumOperations()
static Tree	fromXContentLenient(XContentParser parser)
static Tree	fromXContentStrict(XContentParser parser)
Collection<org.apache.lucene.util.Accountable>	getChildResources()
String	getName()
String	getWriteableName()
int	hashCode()
long	ramBytesUsed()
TargetType	targetType()
String	toString()
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, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.TrainedModel

getMinimalCompatibilityVersion

Field Details

NAME

public static final ParseField NAME

FEATURE_NAMES

public static final ParseField FEATURE_NAMES

TREE_STRUCTURE

public static final ParseField TREE_STRUCTURE

CLASSIFICATION_LABELS

public static final ParseField CLASSIFICATION_LABELS

Constructor Details

Tree

public Tree(StreamInput in)
     throws IOException

Throws:

IOException

Method Details

fromXContentStrict

public static Tree fromXContentStrict(XContentParser parser)

fromXContentLenient

public static Tree fromXContentLenient(XContentParser parser)

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static Tree.Builder builder()

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

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