org.apache.spark.ml

Class UnaryTransformer<IN,OUT,T extends UnaryTransformer<IN,OUT,T>>

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.UnaryTransformer<IN,OUT,T>

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

Direct Known Subclasses:

DCT, ElementwiseProduct, NGram, Normalizer, PolynomialExpansion, RegexTokenizer, Tokenizer

public abstract class UnaryTransformer<IN,OUT,T extends UnaryTransformer<IN,OUT,T>>
extends Transformer
implements Logging

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnaryTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
T	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
protected abstract scala.Function1<IN,OUT>	createTransformFunc() Creates the transform function using the given param map.
protected abstract DataType	outputDataType() Returns the data type of the output column.
T	setInputCol(java.lang.String value)
T	setOutputCol(java.lang.String value)
DataFrame	transform(DataFrame dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
protected void	validateInputType(DataType inputType) Validates the input type.

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

transform, transform, transform

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

transformSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.spark.Logging

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

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, validateParams

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

toString, uid

Constructor Detail

UnaryTransformer

public UnaryTransformer()

Method Detail

setInputCol

public T setInputCol(java.lang.String value)

setOutputCol

public T setOutputCol(java.lang.String value)

createTransformFunc

protected abstract scala.Function1<IN,OUT> 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.

Returns:

(undocumented)

outputDataType

protected abstract DataType outputDataType()

Returns the data type of the output column.

Returns:

(undocumented)

validateInputType

protected void validateInputType(DataType inputType)

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

Parameters:

inputType - (undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

transform

public DataFrame transform(DataFrame dataset)

Description copied from class: Transformer

Transforms the input dataset.

Specified by:

transform in class Transformer

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

copy

public T 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.

Specified by:

copy in interface Params

Specified by:

copy in class Transformer

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()