UnaryTransformer

class pyspark.ml.UnaryTransformer

Abstract class for transformers that take one input column, apply transformation, and output the result as a new column.

New in version 2.3.0.

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.
createTransformFunc()	Creates the transform function using the given param map.
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.
getInputCol()	Gets the value of inputCol 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.
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.
outputDataType()	Returns the data type of the output column.
set(param, value)	Sets a parameter in the embedded param map.
setInputCol(value)	Sets the value of inputCol.
setOutputCol(value)	Sets the value of outputCol.
transform(dataset[, params])	Transforms the input dataset with optional parameters.
transformSchema(schema)
validateInputType(inputType)	Validates the input type.

Attributes

inputCol
outputCol
params	Returns all params ordered by name.

Methods Documentation

clear(param)

Clears a param from the param map if it has been explicitly set.

copy(extra=None)

Creates a copy of this instance with the same uid and some extra params. The default implementation creates a shallow copy using copy.copy(), and then copies the embedded and extra parameters over and returns the copy. Subclasses should override this method if the default approach is not sufficient.

Parameters

extradict, optional

Extra parameters to copy to the new instance

Returns

Params

Copy of this instance

abstract createTransformFunc()

Creates the transform function using the given param map. The input param map already takes account of the embedded param map. So the param values should be determined solely by the input param map.

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=None)

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

getInputCol()

Gets the value of inputCol or its default value.

getOrDefault(param)

Gets the value of a param in the user-supplied param map or its default value. Raises an error if neither is set.

getOutputCol()

Gets the value of outputCol 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.

abstract outputDataType()

Returns the data type of the output column.

set(param, value)

Sets a parameter in the embedded param map.

setInputCol(value)

Sets the value of inputCol.

setOutputCol(value)

Sets the value of outputCol.

transform(dataset, params=None)

Transforms the input dataset with optional parameters.

New in version 1.3.0.

Parameters

datasetpyspark.sql.DataFrame

input dataset

paramsdict, optional

an optional param map that overrides embedded params.

Returns

pyspark.sql.DataFrame

transformed dataset

transformSchema(schema)

abstract validateInputType(inputType)

Validates the input type. Throw an exception if it is invalid.

Attributes Documentation

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

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

params

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

Transformer Estimator