Module org.elasticsearch.xcore

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

Class FrequencyEncoding

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.preprocessing.FrequencyEncoding

All Implemented Interfaces:

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

public class FrequencyEncoding
extends Object
implements LenientlyParsedPreProcessor, StrictlyParsedPreProcessor

PreProcessor for frequency encoding a set of categorical values for a given field.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.core.ml.inference.preprocessing.PreProcessor

PreProcessor.PreProcessorParseContext

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	CUSTOM
static final ParseField	FEATURE_NAME
static final ParseField	FIELD
static final ParseField	FREQUENCY_MAP
static final ParseField	NAME
static final long	SHALLOW_SIZE

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
FrequencyEncoding(String field, String featureName, Map<String,Double> frequencyMap, Boolean custom)
FrequencyEncoding(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static FrequencyEncoding	fromXContentLenient(XContentParser parser, PreProcessor.PreProcessorParseContext context)
static FrequencyEncoding	fromXContentStrict(XContentParser parser, PreProcessor.PreProcessorParseContext context)
String	getFeatureName()
String	getField()
Map<String,Double>	getFrequencyMap()
String	getName()
String	getOutputFieldType(String outputField)
String	getWriteableName()
int	hashCode()
List<String>	inputFields()	The expected input fields
boolean	isCustom()
List<String>	outputFields()
void	process(Map<String,Object> fields)	Process the given fields and their values and return the modified map.
long	ramBytesUsed()
Map<String,String>	reverseLookup()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

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

getChildResources

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

SHALLOW_SIZE

public static final long SHALLOW_SIZE

NAME

public static final ParseField NAME

FIELD

public static final ParseField FIELD

FEATURE_NAME

public static final ParseField FEATURE_NAME

FREQUENCY_MAP

public static final ParseField FREQUENCY_MAP

CUSTOM

public static final ParseField CUSTOM

Constructor Details

FrequencyEncoding

public FrequencyEncoding(String field,
 String featureName,
 Map<String,Double> frequencyMap,
 Boolean custom)

FrequencyEncoding

public FrequencyEncoding(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

fromXContentStrict

public static FrequencyEncoding fromXContentStrict(XContentParser parser,
 PreProcessor.PreProcessorParseContext context)

fromXContentLenient

public static FrequencyEncoding fromXContentLenient(XContentParser parser,
 PreProcessor.PreProcessorParseContext context)

getField

public String getField()

Returns:

Field name on which to frequency encode

getFrequencyMap

public Map<String,Double> getFrequencyMap()

Returns:

Map of Value: frequency for the frequency encoding

getFeatureName

public String getFeatureName()

Returns:

The encoded feature name

reverseLookup

public Map<String,String> reverseLookup()

Specified by:

reverseLookup in interface PreProcessor

Returns:

Reverse lookup map to match resulting features to their original feature name

isCustom

public boolean isCustom()

Specified by:

isCustom in interface PreProcessor

Returns:

Is the pre-processor a custom one provided by the user, or automatically created? This changes how feature importance is calculated, as fields generated by custom processors get individual feature importance calculations.

getOutputFieldType

public String getOutputFieldType(String outputField)

Specified by:

getOutputFieldType in interface PreProcessor

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized

inputFields

public List<String> inputFields()

Description copied from interface: PreProcessor

The expected input fields

Specified by:

inputFields in interface PreProcessor

outputFields

public List<String> outputFields()

Specified by:

outputFields in interface PreProcessor

Returns:

The resulting output fields. It is imperative that the order is consistent between calls.

process

public void process(Map<String,Object> fields)

Description copied from interface: PreProcessor

Process the given fields and their values and return the modified map. NOTE: The passed map object is mutated directly

Specified by:

process in interface PreProcessor

Parameters:

fields - The fields and their values to process

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

ramBytesUsed

public long ramBytesUsed()

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object