org.apache.spark.ml.feature

Class VectorAttributeRewriter

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

public class VectorAttributeRewriter
extends Transformer
implements MLWritable

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(String vectorCol, scala.collection.immutable.Map<String,String> prefixesToRewrite)
VectorAttributeRewriter(String uid, String vectorCol, scala.collection.immutable.Map<String,String> prefixesToRewrite)

Method Summary

Modifier and Type	Method and Description
static Params	clear(Param<?> param)
VectorAttributeRewriter	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
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)
static <T> T	getOrDefault(Param<T> param)
static Param<Object>	getParam(String paramName)
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static VectorAttributeRewriter	load(String path)
static Param<?>[]	params()
scala.collection.immutable.Map<String,String>	prefixesToRewrite()
static MLReader<VectorAttributeRewriter>	read()
static void	save(String path)
static <T> Params	set(Param<T> param, T value)
static String	toString()
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
String	vectorCol()
MLWriter	write() Returns an MLWriter instance for this ML instance.

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

save

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

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

Constructor Detail

VectorAttributeRewriter

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

VectorAttributeRewriter

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

Method Detail

read

public static MLReader<VectorAttributeRewriter> read()

load

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

save

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

Throws:

java.io.IOException

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)

vectorCol

public String vectorCol()

prefixesToRewrite

public scala.collection.immutable.Map<String,String> prefixesToRewrite()

transform

public Dataset<Row> transform(Dataset<?> 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 ::

Check transform validity and derive the output schema from the input schema.

We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

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. See defaultCopy().

Specified by:

copy in interface Params

Specified by:

copy in class Transformer

Parameters:

extra - (undocumented)

Returns:

(undocumented)

write

public MLWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)