Package org.apache.spark.ml.feature

Class UnivariateFeatureSelectorModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.Model<UnivariateFeatureSelectorModel>

org.apache.spark.ml.feature.UnivariateFeatureSelectorModel

All Implemented Interfaces:

Serializable, org.apache.spark.internal.Logging, UnivariateFeatureSelectorParams, Params, HasFeaturesCol, HasLabelCol, HasOutputCol, Identifiable, MLWritable, scala.Serializable

public class UnivariateFeatureSelectorModel
extends Model<UnivariateFeatureSelectorModel>
implements UnivariateFeatureSelectorParams, MLWritable

Model fitted by UnivariateFeatureSelectorModel.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.spark.internal.Logging

org.apache.spark.internal.Logging.SparkShellLoggingFilter

Method Summary

Modifier and Type	Method	Description
UnivariateFeatureSelectorModel	copy(ParamMap extra)	Creates a copy of this instance with the same UID and some extra params.
final Param<String>	featuresCol()	Param for features column name.
final Param<String>	featureType()	The feature type.
final Param<String>	labelCol()	Param for label column name.
final Param<String>	labelType()	The label type.
static UnivariateFeatureSelectorModel	load(String path)
final Param<String>	outputCol()	Param for output column name.
static MLReader<UnivariateFeatureSelectorModel>	read()
int[]	selectedFeatures()
final Param<String>	selectionMode()	The selection mode.
final DoubleParam	selectionThreshold()	The upper bound of the features that selector will select.
UnivariateFeatureSelectorModel	setFeaturesCol(String value)
UnivariateFeatureSelectorModel	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.
MLWriter	write()	Returns an MLWriter instance for this ML instance.

Methods inherited from class org.apache.spark.ml.Model

hasParent, parent, setParent

Methods inherited from class org.apache.spark.ml.Transformer

transform, transform, transform

Methods inherited from class org.apache.spark.ml.PipelineStage

params

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getFeaturesCol

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

getLabelCol

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

getOutputCol

Methods inherited from interface org.apache.spark.internal.Logging

initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log_, org$apache$spark$internal$Logging$$log__$eq

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, onParamChange, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

Methods inherited from interface org.apache.spark.ml.feature.UnivariateFeatureSelectorParams

getFeatureType, getLabelType, getSelectionMode, getSelectionThreshold

Method Details

read

public static MLReader<UnivariateFeatureSelectorModel> read()

load

public static UnivariateFeatureSelectorModel load(String path)

featureType

public final Param<String> featureType()

Description copied from interface: UnivariateFeatureSelectorParams

The feature type. Supported options: "categorical", "continuous"

Specified by:

featureType in interface UnivariateFeatureSelectorParams

Returns:

(undocumented)

labelType

public final Param<String> labelType()

Description copied from interface: UnivariateFeatureSelectorParams

The label type. Supported options: "categorical", "continuous"

Specified by:

labelType in interface UnivariateFeatureSelectorParams

Returns:

(undocumented)

selectionMode

public final Param<String> selectionMode()

Description copied from interface: UnivariateFeatureSelectorParams

The selection mode. Supported options: "numTopFeatures" (default), "percentile", "fpr", "fdr", "fwe"

Specified by:

selectionMode in interface UnivariateFeatureSelectorParams

Returns:

(undocumented)

selectionThreshold

public final DoubleParam selectionThreshold()

Description copied from interface: UnivariateFeatureSelectorParams

The upper bound of the features that selector will select.

Specified by:

selectionThreshold in interface UnivariateFeatureSelectorParams

Returns:

(undocumented)

outputCol

public final Param<String> outputCol()

Description copied from interface: HasOutputCol

Param for output column name.

Specified by:

outputCol in interface HasOutputCol

Returns:

(undocumented)

labelCol

public final Param<String> labelCol()

Description copied from interface: HasLabelCol

Param for label column name.

Specified by:

labelCol in interface HasLabelCol

Returns:

(undocumented)

featuresCol

public final Param<String> featuresCol()

Description copied from interface: HasFeaturesCol

Param for features column name.

Specified by:

featuresCol in interface HasFeaturesCol

Returns:

(undocumented)

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)

selectedFeatures

public int[] selectedFeatures()

setFeaturesCol

public UnivariateFeatureSelectorModel setFeaturesCol(String value)

setOutputCol

public UnivariateFeatureSelectorModel setOutputCol(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

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 UnivariateFeatureSelectorModel 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 Model<UnivariateFeatureSelectorModel>

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)

toString

public String toString()

Specified by:

toString in interface Identifiable

Overrides:

toString in class Object