org.apache.spark.ml

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

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, org.apache.spark.internal.Logging, Params, HasInputCol, HasOutputCol, 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 HasInputCol, HasOutputCol, org.apache.spark.internal.Logging

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(scala.reflect.api.TypeTags.TypeTag<IN> evidence$1, scala.reflect.api.TypeTags.TypeTag<OUT> evidence$2)

Method Summary

Modifier and Type	Method and Description
T	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
Param<String>	inputCol() Param for input column name.
Param<String>	outputCol() Param for output column name.
T	setInputCol(String value)
T	setOutputCol(String value)
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) Check transform validity and derive the output schema from the input schema.

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

transform, transform, transform

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

params

Methods inherited from class Object

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

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

getInputCol

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

getOutputCol

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

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

$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize

Constructor Detail

UnaryTransformer

public UnaryTransformer(scala.reflect.api.TypeTags.TypeTag<IN> evidence$1,
                        scala.reflect.api.TypeTags.TypeTag<OUT> evidence$2)

Method Detail

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. See defaultCopy().

Specified by:

copy in interface Params

Specified by:

copy in class Transformer

Parameters:

extra - (undocumented)

Returns:

(undocumented)

inputCol

public final Param<String> inputCol()

Description copied from interface: HasInputCol

Param for input column name.

Specified by:

inputCol in interface HasInputCol

Returns:

(undocumented)

outputCol

public final Param<String> outputCol()

Description copied from interface: HasOutputCol

Param for output column name.

Specified by:

outputCol in interface HasOutputCol

Returns:

(undocumented)

setInputCol

public T setInputCol(String value)

setOutputCol

public T setOutputCol(String value)

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)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

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)