Package org.elasticsearch.client.ml.inference.preprocessing

Class FrequencyEncoding

java.lang.Object

org.elasticsearch.client.ml.inference.preprocessing.FrequencyEncoding

All Implemented Interfaces:

NamedXContentObject, PreProcessor, ToXContent, ToXContentObject

public class FrequencyEncoding
extends java.lang.Object
implements PreProcessor

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FrequencyEncoding.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	FEATURE_NAME
static ParseField	FIELD
static ParseField	FREQUENCY_MAP
static java.lang.String	NAME
static ConstructingObjectParser<FrequencyEncoding,java.lang.Void>	PARSER

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FrequencyEncoding(java.lang.String field, java.lang.String featureName, java.util.Map<java.lang.String,java.lang.Double> frequencyMap)

Method Summary

Modifier and Type	Method	Description
FrequencyEncoding.Builder	builder(java.lang.String field)
boolean	equals(java.lang.Object o)
static FrequencyEncoding	fromXContent(XContentParser parser)
java.lang.String	getFeatureName()
java.lang.String	getField()
java.util.Map<java.lang.String,java.lang.Double>	getFrequencyMap()
java.lang.String	getName()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

FIELD

public static final ParseField FIELD

FEATURE_NAME

public static final ParseField FEATURE_NAME

FREQUENCY_MAP

public static final ParseField FREQUENCY_MAP

PARSER

public static final ConstructingObjectParser<FrequencyEncoding,java.lang.Void> PARSER

Constructor Detail

FrequencyEncoding

public FrequencyEncoding(java.lang.String field,
                         java.lang.String featureName,
                         java.util.Map<java.lang.String,java.lang.Double> frequencyMap)

Method Detail

fromXContent

public static FrequencyEncoding fromXContent(XContentParser parser)

getField

public java.lang.String getField()

Returns:

Field name on which to frequency encode

getFrequencyMap

public java.util.Map<java.lang.String,java.lang.Double> getFrequencyMap()

Returns:

Map of Value: frequency for the frequency encoding

getFeatureName

public java.lang.String getFeatureName()

Returns:

The encoded feature name

getName

public java.lang.String getName()

Specified by:

getName in interface NamedXContentObject

Specified by:

getName in interface PreProcessor

Returns:

The name of the pre-processor

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

builder

public FrequencyEncoding.Builder builder(java.lang.String field)