org.apache.spark.ml.feature

Class VectorSizeHint

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.feature.VectorSizeHint

All Implemented Interfaces:

java.io.Serializable, Logging, Params, HasHandleInvalid, HasInputCol, DefaultParamsWritable, Identifiable, MLWritable

public class VectorSizeHint
extends Transformer
implements HasInputCol, HasHandleInvalid, DefaultParamsWritable

:: Experimental :: A feature transformer that adds size information to the metadata of a vector column. VectorAssembler needs size information for its input columns and cannot be used on streaming dataframes without this metadata.

Note: VectorSizeHint modifies inputCol to include size metadata and does not have an outputCol.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VectorSizeHint()
VectorSizeHint(String uid)

Method Summary

Modifier and Type	Method and Description
static Params	clear(Param<?> param)
VectorSizeHint	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 String	getHandleInvalid()
static String	getInputCol()
static <T> T	getOrDefault(Param<T> param)
static Param<Object>	getParam(String paramName)
int	getSize() group getParam
Param<String>	handleInvalid() Param for how to handle invalid entries.
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static Param<String>	inputCol()
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static VectorSizeHint	load(String path)
static Param<?>[]	params()
static void	save(String path)
static <T> Params	set(Param<T> param, T value)
VectorSizeHint	setHandleInvalid(String value)
VectorSizeHint	setInputCol(String value)
VectorSizeHint	setSize(int value)
IntParam	size() The size of Vectors in inputCol.
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.
static MLWriter	write()

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.param.shared.HasInputCol

getInputCol, inputCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasHandleInvalid

getHandleInvalid

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.ml.util.DefaultParamsWritable

write

Methods inherited from interface org.apache.spark.ml.util.MLWritable

save

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

VectorSizeHint

public VectorSizeHint(String uid)

VectorSizeHint

public VectorSizeHint()

Method Detail

load

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

inputCol

public static final Param<String> inputCol()

getInputCol

public static final String getInputCol()

getHandleInvalid

public static final String getHandleInvalid()

save

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

Throws:

java.io.IOException

write

public static MLWriter write()

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)

size

public IntParam size()

The size of Vectors in inputCol.

Returns:

(undocumented)

getSize

public int getSize()

group getParam

setSize

public VectorSizeHint setSize(int value)

setInputCol

public VectorSizeHint setInputCol(String value)

handleInvalid

public Param<String> handleInvalid()

Param for how to handle invalid entries. Invalid vectors include nulls and vectors with the wrong size. The options are skip (filter out rows with invalid vectors), error (throw an error) and optimistic (do not check the vector size, and keep all rows). error by default.

Note: Users should take care when setting this param to optimistic. The use of the optimistic option will prevent the transformer from validating the sizes of vectors in inputCol. A mismatch between the metadata of a column and its contents could result in unexpected behaviour or errors when using that column.

Specified by:

handleInvalid in interface HasHandleInvalid

Returns:

(undocumented)

setHandleInvalid

public VectorSizeHint setHandleInvalid(String value)

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 VectorSizeHint 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)