OneHotEncoder¶

class pyspark.ml.feature.OneHotEncoder(*, inputCols: Optional[List[str]] = None, outputCols: Optional[List[str]] = None, handleInvalid: str = 'error', dropLast: bool = True, inputCol: Optional[str] = None, outputCol: Optional[str] = None)¶

A one-hot encoder that maps a column of category indices to a column of binary vectors, with at most a single one-value per row that indicates the input category index. For example with 5 categories, an input value of 2.0 would map to an output vector of [0.0, 0.0, 1.0, 0.0]. The last category is not included by default (configurable via dropLast), because it makes the vector entries sum up to one, and hence linearly dependent. So an input value of 4.0 maps to [0.0, 0.0, 0.0, 0.0].

When handleInvalid is configured to ‘keep’, an extra “category” indicating invalid values is added as last category. So when dropLast is true, invalid values are encoded as all-zeros vector.

See also

StringIndexer: for converting categorical values into category indices

Notes

This is different from scikit-learn’s OneHotEncoder, which keeps all categories. The output vectors are sparse.

When encoding multi-column by using inputCols and outputCols params, input/output cols come in pairs, specified by the order in the arrays, and each pair is treated independently.

Examples

>>> from pyspark.ml.linalg import Vectors
>>> df = spark.createDataFrame([(0.0,), (1.0,), (2.0,)], ["input"])
>>> ohe = OneHotEncoder()
>>> ohe.setInputCols(["input"])
OneHotEncoder...
>>> ohe.setOutputCols(["output"])
OneHotEncoder...
>>> model = ohe.fit(df)
>>> model.setOutputCols(["output"])
OneHotEncoderModel...
>>> model.getHandleInvalid()
'error'
>>> model.transform(df).head().output
SparseVector(2, {0: 1.0})
>>> single_col_ohe = OneHotEncoder(inputCol="input", outputCol="output")
>>> single_col_model = single_col_ohe.fit(df)
>>> single_col_model.transform(df).head().output
SparseVector(2, {0: 1.0})
>>> ohePath = temp_path + "/ohe"
>>> ohe.save(ohePath)
>>> loadedOHE = OneHotEncoder.load(ohePath)
>>> loadedOHE.getInputCols() == ohe.getInputCols()
True
>>> modelPath = temp_path + "/ohe-model"
>>> model.save(modelPath)
>>> loadedModel = OneHotEncoderModel.load(modelPath)
>>> loadedModel.categorySizes == model.categorySizes
True
>>> loadedModel.transform(df).take(1) == model.transform(df).take(1)
True

Methods

`clear`(param)	Clears a param from the param map if it has been explicitly set.
`copy`([extra])	Creates a copy of this instance with the same uid and some extra params.
`explainParam`(param)	Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.
`explainParams`()	Returns the documentation of all params with their optionally default values and user-supplied values.
`extractParamMap`([extra])	Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values < user-supplied values < extra.
`fit`(dataset[, params])	Fits a model to the input dataset with optional parameters.
`fitMultiple`(dataset, paramMaps)	Fits a model to the input dataset for each param map in paramMaps.
`getDropLast`()	Gets the value of dropLast or its default value.
`getHandleInvalid`()	Gets the value of handleInvalid or its default value.
`getInputCol`()	Gets the value of inputCol or its default value.
`getInputCols`()	Gets the value of inputCols or its default value.
`getOrDefault`(param)	Gets the value of a param in the user-supplied param map or its default value.
`getOutputCol`()	Gets the value of outputCol or its default value.
`getOutputCols`()	Gets the value of outputCols or its default value.
`getParam`(paramName)	Gets a param by its name.
`hasDefault`(param)	Checks whether a param has a default value.
`hasParam`(paramName)	Tests whether this instance contains a param with a given (string) name.
`isDefined`(param)	Checks whether a param is explicitly set by user or has a default value.
`isSet`(param)	Checks whether a param is explicitly set by user.
`load`(path)	Reads an ML instance from the input path, a shortcut of read().load(path).
`read`()	Returns an MLReader instance for this class.
`save`(path)	Save this ML instance to the given path, a shortcut of ‘write().save(path)’.
`set`(param, value)	Sets a parameter in the embedded param map.
`setDropLast`(value)	Sets the value of `dropLast`.
`setHandleInvalid`(value)	Sets the value of `handleInvalid`.
`setInputCol`(value)	Sets the value of `inputCol`.
`setInputCols`(value)	Sets the value of `inputCols`.
`setOutputCol`(value)	Sets the value of `outputCol`.
`setOutputCols`(value)	Sets the value of `outputCols`.
`setParams`(self, \*[, inputCols, outputCols, …])	Sets params for this OneHotEncoder.
`write`()	Returns an MLWriter instance for this ML instance.

Attributes

`dropLast`
`handleInvalid`
`inputCol`
`inputCols`
`outputCol`
`outputCols`
`params`	Returns all params ordered by name.

Methods Documentation

clear(param: pyspark.ml.param.Param) → None¶: Clears a param from the param map if it has been explicitly set.

copy(extra: Optional[ParamMap] = None) → JP¶

Creates a copy of this instance with the same uid and some extra params. This implementation first calls Params.copy and then make a copy of the companion Java pipeline component with extra params. So both the Python wrapper and the Java pipeline component get copied.

Parameters

extradict, optional: Extra parameters to copy to the new instance

Returns

JavaParams: Copy of this instance

explainParam(param: Union[str, pyspark.ml.param.Param]) → str¶: Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.

explainParams() → str¶: Returns the documentation of all params with their optionally default values and user-supplied values.

extractParamMap(extra: Optional[ParamMap] = None) → ParamMap¶

Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values < user-supplied values < extra.

Parameters

extradict, optional: extra param values

Returns

dict: merged param map

fit(dataset: pyspark.sql.dataframe.DataFrame, params: Union[ParamMap, List[ParamMap], Tuple[ParamMap], None] = None) → Union[M, List[M]]¶

Fits a model to the input dataset with optional parameters.

Parameters

datasetpyspark.sql.DataFrame: input dataset.
paramsdict or list or tuple, optional: an optional param map that overrides embedded params. If a list/tuple of param maps is given, this calls fit on each param map and returns a list of models.

Returns

Transformer or a list of Transformer: fitted model(s)

fitMultiple(dataset: pyspark.sql.dataframe.DataFrame, paramMaps: Sequence[ParamMap]) → Iterator[Tuple[int, M]]¶

Fits a model to the input dataset for each param map in paramMaps.

Parameters

datasetpyspark.sql.DataFrame: input dataset.
paramMapscollections.abc.Sequence: A Sequence of param maps.

Returns

_FitMultipleIterator: A thread safe iterable which contains one model for each param map. Each call to next(modelIterator) will return (index, model) where model was fit using paramMaps[index]. index values may not be sequential.

getDropLast() → bool¶: Gets the value of dropLast or its default value.

getHandleInvalid() → str¶: Gets the value of handleInvalid or its default value.

getInputCol() → str¶: Gets the value of inputCol or its default value.

getInputCols() → List[str]¶: Gets the value of inputCols or its default value.

getOrDefault(param: Union[str, pyspark.ml.param.Param[T]]) → Union[Any, T]¶: Gets the value of a param in the user-supplied param map or its default value. Raises an error if neither is set.

getOutputCol() → str¶: Gets the value of outputCol or its default value.

getOutputCols() → List[str]¶: Gets the value of outputCols or its default value.

getParam(paramName: str) → pyspark.ml.param.Param ¶: Gets a param by its name.

hasDefault(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param has a default value.

hasParam(paramName: str) → bool¶: Tests whether this instance contains a param with a given (string) name.

isDefined(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param is explicitly set by user or has a default value.

isSet(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param is explicitly set by user.

classmethod load(path: str) → RL¶: Reads an ML instance from the input path, a shortcut of read().load(path).

classmethod read() → pyspark.ml.util.JavaMLReader[RL]¶: Returns an MLReader instance for this class.

save(path: str) → None¶: Save this ML instance to the given path, a shortcut of ‘write().save(path)’.

set(param: pyspark.ml.param.Param, value: Any) → None¶: Sets a parameter in the embedded param map.

setDropLast(value: bool) → pyspark.ml.feature.OneHotEncoder ¶: Sets the value of dropLast.

setHandleInvalid(value: str) → pyspark.ml.feature.OneHotEncoder ¶: Sets the value of handleInvalid.

setInputCol(value: str) → pyspark.ml.feature.OneHotEncoder ¶: Sets the value of inputCol.

setInputCols(value: List[str]) → pyspark.ml.feature.OneHotEncoder ¶: Sets the value of inputCols.

setOutputCol(value: str) → pyspark.ml.feature.OneHotEncoder ¶: Sets the value of outputCol.

setOutputCols(value: List[str]) → pyspark.ml.feature.OneHotEncoder ¶: Sets the value of outputCols.

setParams(self, \*, inputCols=None, outputCols=None, handleInvalid="error", dropLast=True, inputCol=None, outputCol=None)¶: Sets params for this OneHotEncoder.

write() → pyspark.ml.util.JavaMLWriter¶: Returns an MLWriter instance for this ML instance.

Attributes Documentation

dropLast = Param(parent='undefined', name='dropLast', doc='whether to drop the last category')¶

handleInvalid = Param(parent='undefined', name='handleInvalid', doc="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.")¶

inputCol = Param(parent='undefined', name='inputCol', doc='input column name.')¶

inputCols = Param(parent='undefined', name='inputCols', doc='input column names.')¶

outputCol = Param(parent='undefined', name='outputCol', doc='output column name.')¶

outputCols = Param(parent='undefined', name='outputCols', doc='output column names.')¶

params¶: Returns all params ordered by name. The default implementation uses dir() to get all attributes of type Param.

Normalizer

OneHotEncoderModel