org.apache.spark.ml.feature

Class PolynomialExpansion

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.UnaryTransformer<Vector,Vector,PolynomialExpansion>

org.apache.spark.ml.feature.PolynomialExpansion

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class PolynomialExpansion
extends UnaryTransformer<Vector,Vector,PolynomialExpansion>

:: Experimental :: Perform feature expansion in a polynomial space. As said in wikipedia of Polynomial Expansion, which is available at http://en.wikipedia.org/wiki/Polynomial_expansion, "In mathematics, an expansion of a product of sums expresses it as a sum of products by using the fact that multiplication distributes over addition". Take a 2-variable feature vector as an example: (x, y), if we want to expand it with degree 2, then we get (x, x * x, y, x * y, y * y).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PolynomialExpansion()
PolynomialExpansion(java.lang.String uid)

Method Summary

Methods

Modifier and Type	Method and Description
PolynomialExpansion	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
protected scala.Function1<Vector,Vector>	createTransformFunc() Creates the transform function using the given param map.
IntParam	degree() The polynomial degree to expand, which should be >= 1.
static Vector	expand(Vector v, int degree)
int	getDegree()
protected DataType	outputDataType() Returns the data type of the output column.
PolynomialExpansion	setDegree(int value)
java.lang.String	uid() An immutable unique ID for the object and its derivatives.

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

setInputCol, setOutputCol, transform, transformSchema, validateInputType

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

Constructor Detail

PolynomialExpansion

public PolynomialExpansion(java.lang.String uid)

PolynomialExpansion

public PolynomialExpansion()

Method Detail

expand

public static Vector expand(Vector v,
            int degree)

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Returns:

(undocumented)

degree

public IntParam degree()

The polynomial degree to expand, which should be >= 1. A value of 1 means no expansion. Default: 2

Returns:

(undocumented)

getDegree

public int getDegree()

setDegree

public PolynomialExpansion setDegree(int value)

createTransformFunc

protected scala.Function1<Vector,Vector> createTransformFunc()

Description copied from class: UnaryTransformer

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.

Specified by:

createTransformFunc in class UnaryTransformer<Vector,Vector,PolynomialExpansion>

Returns:

(undocumented)

outputDataType

protected DataType outputDataType()

Description copied from class: UnaryTransformer

Returns the data type of the output column.

Specified by:

outputDataType in class UnaryTransformer<Vector,Vector,PolynomialExpansion>

Returns:

(undocumented)

copy

public PolynomialExpansion 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

Overrides:

copy in class UnaryTransformer<Vector,Vector,PolynomialExpansion>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()