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

Class FrequencyEncoding

java.lang.Object

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

All Implemented Interfaces:

NamedXContentObject, PreProcessor, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class FrequencyEncoding
extends 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.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final org.elasticsearch.xcontent.ParseField	CUSTOM
static final org.elasticsearch.xcontent.ParseField	FEATURE_NAME
static final org.elasticsearch.xcontent.ParseField	FIELD
static final org.elasticsearch.xcontent.ParseField	FREQUENCY_MAP
static final String	NAME
static final org.elasticsearch.xcontent.ConstructingObjectParser<FrequencyEncoding,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
FrequencyEncoding.Builder	builder(String fieldName)
boolean	equals(Object o)
static FrequencyEncoding	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
Boolean	getCustom()
String	getFeatureName()
String	getField()
Map<String,Double>	getFrequencyMap()
String	getName()
int	hashCode()
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

FIELD

public static final org.elasticsearch.xcontent.ParseField FIELD

FEATURE_NAME

public static final org.elasticsearch.xcontent.ParseField FEATURE_NAME

FREQUENCY_MAP

public static final org.elasticsearch.xcontent.ParseField FREQUENCY_MAP

CUSTOM

public static final org.elasticsearch.xcontent.ParseField CUSTOM

PARSER

public static final org.elasticsearch.xcontent.ConstructingObjectParser<FrequencyEncoding,Void> PARSER

Method Details

fromXContent

public static FrequencyEncoding fromXContent(org.elasticsearch.xcontent.XContentParser parser)

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

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Specified by:

getName in interface PreProcessor

Returns:

The name of the pre-processor

getCustom

public Boolean getCustom()

toXContent

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

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public FrequencyEncoding.Builder builder(String fieldName)