org.apache.spark.ml.feature

Class PCA

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Estimator<PCAModel>

org.apache.spark.ml.feature.PCA

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class PCA
extends Estimator<PCAModel>

:: Experimental :: PCA trains a model to project vectors to a low-dimensional space using PCA.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
PCA	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
PCAModel	fit(DataFrame dataset) Computes a PCAModel that contains the principal components of the input vectors.
int	getK()
IntParam	k() The number of principal components.
static PCA	load(java.lang.String path)
PCA	setInputCol(java.lang.String value)
PCA	setK(int value)
PCA	setOutputCol(java.lang.String value)
StructType	transformSchema(StructType schema) :: DeveloperApi ::
java.lang.String	uid() An immutable unique ID for the object and its derivatives.

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

fit, fit, fit, fit

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

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

PCA

public PCA(java.lang.String uid)

PCA

public PCA()

Method Detail

load

public static PCA 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.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

setInputCol

public PCA setInputCol(java.lang.String value)

setOutputCol

public PCA setOutputCol(java.lang.String value)

setK

public PCA setK(int value)

fit

public PCAModel fit(DataFrame dataset)

Computes a PCAModel that contains the principal components of the input vectors.

Specified by:

fit in class Estimator<PCAModel>

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

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)

copy

public PCA 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 Estimator<PCAModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

k

public IntParam k()

The number of principal components.

Returns:

(undocumented)

getK

public int getK()