org.apache.spark.ml.feature

Class OneHotEncoderModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.Model<OneHotEncoderModel>

org.apache.spark.ml.feature.OneHotEncoderModel

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable, MLWritable

public class OneHotEncoderModel
extends Model<OneHotEncoderModel>
implements MLWritable

param: categorySizes Original number of categories for each feature being encoded. The array contains one value for each input column, in order.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int[]	categorySizes()
static Params	clear(Param<?> param)
OneHotEncoderModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
static BooleanParam	dropLast()
BooleanParam	dropLast() Whether to drop the last category in the encoded vector (default: true)
static String	explainParam(Param<?> param)
static String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
static boolean	getDropLast()
boolean	getDropLast()
static String	getHandleInvalid()
static String[]	getInputCols()
static <T> T	getOrDefault(Param<T> param)
static String[]	getOutputCols()
static Param<Object>	getParam(String paramName)
static Param<String>	handleInvalid()
Param<String>	handleInvalid() Param for how to handle invalid data during transform().
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static boolean	hasParent()
static StringArrayParam	inputCols()
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static OneHotEncoderModel	load(String path)
static StringArrayParam	outputCols()
static Param<?>[]	params()
static void	parent_$eq(Estimator<M> x$1)
static Estimator<M>	parent()
static MLReader<OneHotEncoderModel>	read()
static void	save(String path)
static <T> Params	set(Param<T> param, T value)
OneHotEncoderModel	setDropLast(boolean value)
OneHotEncoderModel	setHandleInvalid(String value)
OneHotEncoderModel	setInputCols(String[] values)
OneHotEncoderModel	setOutputCols(String[] values)
static M	setParent(Estimator<M> parent)
static String	toString()
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
StructType	validateAndTransformSchema(StructType schema, boolean dropLast, boolean keepInvalid)
MLWriter	write() Returns an MLWriter instance for this ML instance.

Methods inherited from class org.apache.spark.ml.Model

hasParent, parent, setParent

Methods inherited from class org.apache.spark.ml.Transformer

transform, transform, transform

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.param.shared.HasHandleInvalid

getHandleInvalid

Methods inherited from interface org.apache.spark.ml.param.shared.HasInputCols

getInputCols, inputCols

Methods inherited from interface org.apache.spark.ml.param.shared.HasOutputCols

getOutputCols, outputCols

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString

Methods inherited from interface org.apache.spark.ml.util.MLWritable

save

Methods inherited from interface org.apache.spark.internal.Logging

initializeLogging, initializeLogIfNecessary, initializeLogIfNecessary, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Method Detail

read

public static MLReader<OneHotEncoderModel> read()

load

public static OneHotEncoderModel load(String path)

toString

public static String toString()

params

public static Param<?>[] params()

explainParam

public static String explainParam(Param<?> param)

explainParams

public static String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(String paramName)

getParam

public static Param<Object> getParam(String paramName)

set

public static final <T> Params set(Param<T> param,
                                   T value)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

parent

public static Estimator<M> parent()

parent_$eq

public static void parent_$eq(Estimator<M> x$1)

setParent

public static M setParent(Estimator<M> parent)

hasParent

public static boolean hasParent()

getHandleInvalid

public static final String getHandleInvalid()

inputCols

public static final StringArrayParam inputCols()

getInputCols

public static final String[] getInputCols()

outputCols

public static final StringArrayParam outputCols()

getOutputCols

public static final String[] getOutputCols()

handleInvalid

public static Param<String> handleInvalid()

dropLast

public static final BooleanParam dropLast()

getDropLast

public static boolean getDropLast()

save

public static void save(String path)
                 throws java.io.IOException

Throws:

java.io.IOException

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

categorySizes

public int[] categorySizes()

setInputCols

public OneHotEncoderModel setInputCols(String[] values)

setOutputCols

public OneHotEncoderModel setOutputCols(String[] values)

setDropLast

public OneHotEncoderModel setDropLast(boolean value)

setHandleInvalid

public OneHotEncoderModel setHandleInvalid(String value)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Check transform validity and derive the output schema from the input schema.

We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

transform

public Dataset<Row> transform(Dataset<?> dataset)

Description copied from class: Transformer

Transforms the input dataset.

Specified by:

transform in class Transformer

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

copy

public OneHotEncoderModel copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

Specified by:

copy in interface Params

Specified by:

copy in class Model<OneHotEncoderModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

write

public MLWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)

dropLast

public BooleanParam dropLast()

Whether to drop the last category in the encoded vector (default: true)

Returns:

(undocumented)

getDropLast

public boolean getDropLast()

handleInvalid

public Param<String> handleInvalid()

Param for how to handle invalid data during transform(). Options are 'keep' (invalid data presented as an extra categorical feature) or 'error' (throw an error). Note that this Param is only used during transform; during fitting, invalid data will result in an error. Default: "error"

Specified by:

handleInvalid in interface HasHandleInvalid

Returns:

(undocumented)

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema,
                                             boolean dropLast,
                                             boolean keepInvalid)