Module org.elasticsearch.xcore

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

Class LangIdentNeuralNetwork

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.trainedmodel.langident.LangIdentNeuralNetwork

All Implemented Interfaces:

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

public class LangIdentNeuralNetwork
extends Object
implements StrictlyParsedTrainedModel, LenientlyParsedTrainedModel, InferenceModel

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	EMBEDDED_VECTOR_FEATURE_NAME
static final ParseField	HIDDEN_LAYER
static final ConstructingObjectParser<LangIdentNeuralNetwork,Void>	LENIENT_PARSER
static final ParseField	NAME
static final ParseField	SOFTMAX_LAYER
static final ConstructingObjectParser<LangIdentNeuralNetwork,Void>	STRICT_PARSER

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
LangIdentNeuralNetwork(String embeddedVectorFeatureName, LangNetLayer hiddenLayer, LangNetLayer softmaxLayer)
LangIdentNeuralNetwork(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
long	estimatedNumOperations()
static LangIdentNeuralNetwork	fromXContentLenient(XContentParser parser)
static LangIdentNeuralNetwork	fromXContentStrict(XContentParser parser)
String[]	getFeatureNames()
String	getName()
String	getWriteableName()
int	hashCode()
InferenceResults	infer(double[] embeddedVector, InferenceConfig config)	Same as InferenceModel.infer(Map, InferenceConfig, Map) but the features are already extracted.
InferenceResults	infer(Map<String,Object> fields, InferenceConfig config, Map<String,String> featureDecoderMap)	Infer against the provided fields
long	ramBytesUsed()
void	rewriteFeatureIndices(Map<String,Integer> newFeatureIndexMapping)	Rewrites underlying feature index mappings.
boolean	supportsFeatureImportance()
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.apache.lucene.util.Accountable

getChildResources

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

EMBEDDED_VECTOR_FEATURE_NAME

public static final ParseField EMBEDDED_VECTOR_FEATURE_NAME

HIDDEN_LAYER

public static final ParseField HIDDEN_LAYER

SOFTMAX_LAYER

public static final ParseField SOFTMAX_LAYER

STRICT_PARSER

public static final ConstructingObjectParser<LangIdentNeuralNetwork,Void> STRICT_PARSER

LENIENT_PARSER

public static final ConstructingObjectParser<LangIdentNeuralNetwork,Void> LENIENT_PARSER

Constructor Details

LangIdentNeuralNetwork

public LangIdentNeuralNetwork(String embeddedVectorFeatureName,
 LangNetLayer hiddenLayer,
 LangNetLayer softmaxLayer)

LangIdentNeuralNetwork

public LangIdentNeuralNetwork(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

fromXContentStrict

public static LangIdentNeuralNetwork fromXContentStrict(XContentParser parser)

fromXContentLenient

public static LangIdentNeuralNetwork fromXContentLenient(XContentParser parser)

infer

public InferenceResults infer(Map<String,Object> fields,
 InferenceConfig config,
 Map<String,String> featureDecoderMap)

Description copied from interface: InferenceModel

Infer against the provided fields

Specified by:

infer in interface InferenceModel

Parameters:

fields - The fields and their values to infer against

config - The configuration options for inference

featureDecoderMap - A map for decoding feature value names to their originating feature. Necessary for feature influence.

Returns:

The predicted value. For classification this will be discrete values (e.g. 0.0, or 1.0). For regression this is continuous.

infer

public InferenceResults infer(double[] embeddedVector,
 InferenceConfig config)

Description copied from interface: InferenceModel

Same as InferenceModel.infer(Map, InferenceConfig, Map) but the features are already extracted.

Specified by:

infer in interface InferenceModel

rewriteFeatureIndices

public void rewriteFeatureIndices(Map<String,Integer> newFeatureIndexMapping)

Description copied from interface: InferenceModel

Rewrites underlying feature index mappings. This is to allow optimization of the underlying models.

Specified by:

rewriteFeatureIndices in interface InferenceModel

getFeatureNames

public String[] getFeatureNames()

Specified by:

getFeatureNames in interface InferenceModel

Returns:

The feature names in their desired order

targetType

public TargetType targetType()

Specified by:

targetType in interface InferenceModel

Specified by:

targetType in interface TrainedModel

Returns:

TargetType for the model.

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

supportsFeatureImportance

public boolean supportsFeatureImportance()

Specified by:

supportsFeatureImportance in interface InferenceModel

Returns:

Does the model support feature importance

ramBytesUsed

public long ramBytesUsed()

Specified by:

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

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 InferenceModel

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