org.apache.spark.ml.feature

Class Interaction

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.feature.Interaction

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class Interaction
extends Transformer

:: Experimental :: Implements the feature interaction transform. This transformer takes in Double and Vector type columns and outputs a flattened vector of their feature interactions. To handle interaction, we first one-hot encode any nominal features. Then, a vector of the feature cross-products is produced.

For example, given the input feature values Double(2) and Vector(3, 4), the output would be Vector(6, 8) if all input features were numeric. If the first feature was instead nominal with four categories, the output would then be Vector(0, 0, 0, 0, 3, 4, 0, 0).

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Interaction	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
static Interaction	load(java.lang.String path)
Interaction	setInputCols(java.lang.String[] values)
Interaction	setOutputCol(java.lang.String value)
DataFrame	transform(DataFrame dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
java.lang.String	uid() An immutable unique ID for the object and its derivatives.
void	validateParams()

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

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

Constructor Detail

Interaction

public Interaction(java.lang.String uid)

Interaction

public Interaction()

Method Detail

load

public static Interaction load(java.lang.String path)

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Returns:

(undocumented)

setInputCols

public Interaction setInputCols(java.lang.String[] values)

setOutputCol

public Interaction setOutputCol(java.lang.String value)

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 Interaction 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()

validateParams

public void validateParams()