org.apache.spark.ml.feature

Class PolynomialExpansion

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, HasInputCol, HasOutputCol, DefaultParamsWritable, Identifiable, MLWritable

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

Perform feature expansion in a polynomial space. As said in wikipedia of Polynomial Expansion, which is available at Polynomial expansion (Wikipedia) , "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(String uid)

Method Summary

Modifier and Type	Method and Description
PolynomialExpansion	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
IntParam	degree() The polynomial degree to expand, which should be greater than equal to 1.
int	getDegree()
static PolynomialExpansion	load(String path)
static MLReader<T>	read()
PolynomialExpansion	setDegree(int value)
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

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

transform, transform, transform

Methods inherited from class Object

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

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

write

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

save

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

getInputCol, inputCol

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

getOutputCol, outputCol

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

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

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

Constructor Detail

PolynomialExpansion

public PolynomialExpansion(String uid)

PolynomialExpansion

public PolynomialExpansion()

Method Detail

load

public static PolynomialExpansion load(String path)

read

public static MLReader<T> read()

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

degree

public IntParam degree()

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

Returns:

(undocumented)

getDegree

public int getDegree()

setDegree

public PolynomialExpansion setDegree(int value)

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

Specified by:

copy in interface Params

Overrides:

copy in class UnaryTransformer<Vector,Vector,PolynomialExpansion>

Parameters:

extra - (undocumented)

Returns:

(undocumented)