org.apache.spark.ml.feature

Class VectorSlicer

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.feature.VectorSlicer

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public final class VectorSlicer
extends Transformer

:: Experimental :: This class takes a feature vector and outputs a new feature vector with a subarray of the original features.

The subset of features can be specified with either indices (setIndices()) or names (setNames()). At least one feature must be selected. Duplicate features are not allowed, so there can be no overlap between selected indices and names.

The output vector will order features with the selected indices first (in the order given), followed by the selected names (in the order given).

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
VectorSlicer	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
int[]	getIndices()
java.lang.String[]	getNames()
IntArrayParam	indices() An array of indices to select features from a vector column.
static VectorSlicer	load(java.lang.String path)
StringArrayParam	names() An array of feature names to select features from a vector column.
VectorSlicer	setIndices(int[] value)
VectorSlicer	setInputCol(java.lang.String value)
VectorSlicer	setNames(java.lang.String[] value)
VectorSlicer	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

VectorSlicer

public VectorSlicer(java.lang.String uid)

VectorSlicer

public VectorSlicer()

Method Detail

load

public static VectorSlicer 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)

indices

public IntArrayParam indices()

An array of indices to select features from a vector column. There can be no overlap with names. Default: Empty array

Returns:

(undocumented)

getIndices

public int[] getIndices()

setIndices

public VectorSlicer setIndices(int[] value)

names

public StringArrayParam names()

An array of feature names to select features from a vector column. These names must be specified by ML Attributes. There can be no overlap with indices. Default: Empty Array

Returns:

(undocumented)

getNames

public java.lang.String[] getNames()

setNames

public VectorSlicer setNames(java.lang.String[] value)

setInputCol

public VectorSlicer setInputCol(java.lang.String value)

setOutputCol

public VectorSlicer setOutputCol(java.lang.String value)

validateParams

public void validateParams()

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)

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