Module org.elasticsearch.xcore
Class OneHotEncoding
java.lang.Object
org.elasticsearch.xpack.core.ml.inference.preprocessing.OneHotEncoding
- All Implemented Interfaces:
org.apache.lucene.util.Accountable,NamedWriteable,Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject,LenientlyParsedPreProcessor,PreProcessor,StrictlyParsedPreProcessor,NamedXContentObject
public class OneHotEncoding
extends Object
implements LenientlyParsedPreProcessor, StrictlyParsedPreProcessor
PreProcessor for one hot 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.PreProcessorParseContextNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final longFields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLEFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic OneHotEncodingfromXContentLenient(org.elasticsearch.xcontent.XContentParser parser, PreProcessor.PreProcessorParseContext context) static OneHotEncodingfromXContentStrict(org.elasticsearch.xcontent.XContentParser parser, PreProcessor.PreProcessorParseContext context) getField()getName()getOutputFieldType(String outputField) inthashCode()The expected input fieldsbooleanisCustom()voidProcess the given fields and their values and return the modified map.longtoString()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.lucene.util.Accountable
getChildResourcesMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
SHALLOW_SIZE
public static final long SHALLOW_SIZE -
NAME
public static final org.elasticsearch.xcontent.ParseField NAME -
FIELD
public static final org.elasticsearch.xcontent.ParseField FIELD -
HOT_MAP
public static final org.elasticsearch.xcontent.ParseField HOT_MAP -
CUSTOM
public static final org.elasticsearch.xcontent.ParseField CUSTOM
-
-
Constructor Details
-
OneHotEncoding
-
OneHotEncoding
- Throws:
IOException
-
-
Method Details
-
fromXContentStrict
public static OneHotEncoding fromXContentStrict(org.elasticsearch.xcontent.XContentParser parser, PreProcessor.PreProcessorParseContext context) -
fromXContentLenient
public static OneHotEncoding fromXContentLenient(org.elasticsearch.xcontent.XContentParser parser, PreProcessor.PreProcessorParseContext context) -
getField
- Returns:
- Field name on which to one hot encode
-
getHotMap
- Returns:
- Map of Value: ColumnName for the one hot encoding
-
reverseLookup
- Specified by:
reverseLookupin interfacePreProcessor- Returns:
- Reverse lookup map to match resulting features to their original feature name
-
isCustom
public boolean isCustom()- Specified by:
isCustomin interfacePreProcessor- 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
- Specified by:
getOutputFieldTypein interfacePreProcessor
-
getName
- Specified by:
getNamein interfaceNamedXContentObject- Returns:
- The name of the XContentObject that is to be serialized
-
inputFields
Description copied from interface:PreProcessorThe expected input fields- Specified by:
inputFieldsin interfacePreProcessor
-
outputFields
- Specified by:
outputFieldsin interfacePreProcessor- Returns:
- The resulting output fields. It is imperative that the order is consistent between calls.
-
process
Description copied from interface:PreProcessorProcess the given fields and their values and return the modified map. NOTE: The passed map object is mutated directly- Specified by:
processin interfacePreProcessor- Parameters:
fields- The fields and their values to process
-
getWriteableName
- Specified by:
getWriteableNamein interfaceNamedWriteable
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
ramBytesUsed
public long ramBytesUsed()- Specified by:
ramBytesUsedin interfaceorg.apache.lucene.util.Accountable
-
toString
-