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

Class TargetMeanEncoding

java.lang.Object

org.elasticsearch.client.ml.inference.preprocessing.TargetMeanEncoding

All Implemented Interfaces:

NamedXContentObject, PreProcessor, ToXContent, ToXContentObject

public class TargetMeanEncoding
extends java.lang.Object
implements PreProcessor

PreProcessor for target mean encoding a set of categorical values for a given field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TargetMeanEncoding.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	DEFAULT_VALUE
static ParseField	FEATURE_NAME
static ParseField	FIELD
static java.lang.String	NAME
static ConstructingObjectParser<TargetMeanEncoding,java.lang.Void>	PARSER
static ParseField	TARGET_MAP

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TargetMeanEncoding(java.lang.String field, java.lang.String featureName, java.util.Map<java.lang.String,java.lang.Double> meanMap, java.lang.Double defaultValue)

Method Summary

Modifier and Type	Method	Description
TargetMeanEncoding.Builder	builder(java.lang.String field)
boolean	equals(java.lang.Object o)
static TargetMeanEncoding	fromXContent(XContentParser parser)
double	getDefaultValue()
java.lang.String	getFeatureName()
java.lang.String	getField()
java.util.Map<java.lang.String,java.lang.Double>	getMeanMap()
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

TARGET_MAP

public static final ParseField TARGET_MAP

DEFAULT_VALUE

public static final ParseField DEFAULT_VALUE

PARSER

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

Constructor Detail

TargetMeanEncoding

public TargetMeanEncoding(java.lang.String field,
                          java.lang.String featureName,
                          java.util.Map<java.lang.String,java.lang.Double> meanMap,
                          java.lang.Double defaultValue)

Method Detail

fromXContent

public static TargetMeanEncoding fromXContent(XContentParser parser)

getField

public java.lang.String getField()

Returns:

Field name on which to target mean encode

getMeanMap

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

Returns:

Map of Value: targetMean for the target mean encoding

getDefaultValue

public double getDefaultValue()

Returns:

The default value to set when a previously unobserved value is seen

getFeatureName

public java.lang.String getFeatureName()

Returns:

The feature name for the encoded value

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 TargetMeanEncoding.Builder builder(java.lang.String field)