org.apache.spark.ml.feature

Class VectorAttributeRewriter

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.feature.VectorAttributeRewriter

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class VectorAttributeRewriter
extends Transformer

Utility transformer that rewrites Vector attribute names via prefix replacement. For example, it can rewrite attribute names starting with 'foo_' to start with 'bar_' instead.

param: vectorCol name of the vector column to rewrite. param: prefixesToRewrite the map of string prefixes to their replacement values. Each attribute name defined in vectorCol will be checked against the keys of this map. When a key prefixes a name, the matching prefix will be replaced by the value in the map.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VectorAttributeRewriter(java.lang.String vectorCol, scala.collection.immutable.Map<java.lang.String,java.lang.String> prefixesToRewrite)

Method Summary

Methods

Modifier and Type	Method and Description
VectorAttributeRewriter	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
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.

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

VectorAttributeRewriter

public VectorAttributeRewriter(java.lang.String vectorCol,
                       scala.collection.immutable.Map<java.lang.String,java.lang.String> prefixesToRewrite)

Method Detail

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

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)

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