public final class VectorSlicer extends Transformer implements HasInputCol, HasOutputCol, DefaultParamsWritable
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).
Constructor and Description |
---|
VectorSlicer() |
VectorSlicer(String uid) |
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() |
String[] |
getNames() |
IntArrayParam |
indices()
An array of indices to select features from a vector column.
|
Param<String> |
inputCol()
Param for input column name.
|
static VectorSlicer |
load(String path) |
StringArrayParam |
names()
An array of feature names to select features from a vector column.
|
Param<String> |
outputCol()
Param for output column name.
|
static MLReader<T> |
read() |
VectorSlicer |
setIndices(int[] value) |
VectorSlicer |
setInputCol(String value) |
VectorSlicer |
setNames(String[] value) |
VectorSlicer |
setOutputCol(String value) |
String |
toString() |
Dataset<Row> |
transform(Dataset<?> dataset)
Transforms the input dataset.
|
StructType |
transformSchema(StructType schema)
Check transform validity and derive the output schema from the input schema.
|
String |
uid()
An immutable unique ID for the object and its derivatives.
|
transform, transform, transform
params
getInputCol
getOutputCol
clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, onParamChange, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn
write
save
$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize
public static VectorSlicer load(String path)
public static MLReader<T> read()
public final Param<String> outputCol()
HasOutputCol
outputCol
in interface HasOutputCol
public final Param<String> inputCol()
HasInputCol
inputCol
in interface HasInputCol
public String uid()
Identifiable
uid
in interface Identifiable
public IntArrayParam indices()
names
.
Default: Empty arraypublic int[] getIndices()
public VectorSlicer setIndices(int[] value)
public StringArrayParam names()
Attribute
s.
There can be no overlap with indices
.
Default: Empty Arraypublic String[] getNames()
public VectorSlicer setNames(String[] value)
public VectorSlicer setInputCol(String value)
public VectorSlicer setOutputCol(String value)
public Dataset<Row> transform(Dataset<?> dataset)
Transformer
transform
in class Transformer
dataset
- (undocumented)public StructType transformSchema(StructType schema)
PipelineStage
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.
transformSchema
in class PipelineStage
schema
- (undocumented)public VectorSlicer copy(ParamMap extra)
Params
defaultCopy()
.copy
in interface Params
copy
in class Transformer
extra
- (undocumented)public String toString()
toString
in interface Identifiable
toString
in class Object