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, 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
static Params	clear(Param<?> param)
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.
static String	explainParam(Param<?> param)
static String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
int	getDegree()
static String	getInputCol()
static <T> T	getOrDefault(Param<T> param)
static String	getOutputCol()
static Param<Object>	getParam(String paramName)
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static Param<String>	inputCol()
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static PolynomialExpansion	load(String path)
static Param<String>	outputCol()
static Param<?>[]	params()
static void	save(String path)
static <T> Params	set(Param<T> param, T value)
PolynomialExpansion	setDegree(int value)
static T	setInputCol(String value)
static T	setOutputCol(String value)
static String	toString()
static Dataset<Row>	transform(Dataset<?> dataset)
static Dataset<Row>	transform(Dataset<?> dataset, ParamMap paramMap)
static Dataset<Row>	transform(Dataset<?> dataset, ParamPair<?> firstParamPair, ParamPair<?>... otherParamPairs)
static Dataset<Row>	transform(Dataset<?> dataset, ParamPair<?> firstParamPair, scala.collection.Seq<ParamPair<?>> otherParamPairs)
static StructType	transformSchema(StructType schema)
String	uid() An immutable unique ID for the object and its derivatives.
static MLWriter	write()

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.internal.Logging

initializeLogging, initializeLogIfNecessary, 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

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

toString

Constructor Detail

PolynomialExpansion

public PolynomialExpansion(String uid)

PolynomialExpansion

public PolynomialExpansion()

Method Detail

load

public static PolynomialExpansion load(String path)

toString

public static String toString()

params

public static Param<?>[] params()

explainParam

public static String explainParam(Param<?> param)

explainParams

public static String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(String paramName)

getParam

public static Param<Object> getParam(String paramName)

set

public static final <T> Params set(Param<T> param,
                                   T value)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

transform

public static Dataset<Row> transform(Dataset<?> dataset,
                                     ParamPair<?> firstParamPair,
                                     scala.collection.Seq<ParamPair<?>> otherParamPairs)

transform

public static Dataset<Row> transform(Dataset<?> dataset,
                                     ParamMap paramMap)

transform

public static Dataset<Row> transform(Dataset<?> dataset,
                                     ParamPair<?> firstParamPair,
                                     ParamPair<?>... otherParamPairs)

inputCol

public static final Param<String> inputCol()

getInputCol

public static final String getInputCol()

outputCol

public static final Param<String> outputCol()

getOutputCol

public static final String getOutputCol()

setInputCol

public static T setInputCol(String value)

setOutputCol

public static T setOutputCol(String value)

transformSchema

public static StructType transformSchema(StructType schema)

transform

public static Dataset<Row> transform(Dataset<?> dataset)

save

public static void save(String path)
                 throws java.io.IOException

Throws:

java.io.IOException

write

public static MLWriter write()

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)