Package org.apache.spark.ml.feature

Interface SelectorParams

All Superinterfaces:

HasFeaturesCol, HasLabelCol, HasOutputCol, Identifiable, Params, Serializable

All Known Implementing Classes:

ChiSqSelector, ChiSqSelectorModel

public interface SelectorParams
extends Params, HasFeaturesCol, HasLabelCol, HasOutputCol

Params for Selector and SelectorModel.

Method Summary

Modifier and Type	Method	Description
DoubleParam	fdr()	The upper bound of the expected false discovery rate.
DoubleParam	fpr()	The highest p-value for features to be kept.
DoubleParam	fwe()	The upper bound of the expected family-wise error rate.
double	getFdr()
double	getFpr()
double	getFwe()
int	getNumTopFeatures()
double	getPercentile()
String	getSelectorType()
IntParam	numTopFeatures()	Number of features that selector will select, ordered by ascending p-value.
DoubleParam	percentile()	Percentile of features that selector will select, ordered by ascending p-value.
Param<String>	selectorType()	The selector type.

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

featuresCol, getFeaturesCol

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

getLabelCol, labelCol

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

getOutputCol, outputCol

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

toString, uid

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copy, copyValues, defaultCopy, defaultParamMap, estimateMatadataSize, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, onParamChange, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

Method Details

fdr

DoubleParam fdr()

The upper bound of the expected false discovery rate. Only applicable when selectorType = "fdr". Default value is 0.05.

Returns:

(undocumented)

fpr

DoubleParam fpr()

The highest p-value for features to be kept. Only applicable when selectorType = "fpr". Default value is 0.05.

Returns:

(undocumented)

fwe

DoubleParam fwe()

The upper bound of the expected family-wise error rate. Only applicable when selectorType = "fwe". Default value is 0.05.

Returns:

(undocumented)

getFdr

double getFdr()

getFpr

double getFpr()

getFwe

double getFwe()

getNumTopFeatures

int getNumTopFeatures()

getPercentile

double getPercentile()

getSelectorType

String getSelectorType()

numTopFeatures

IntParam numTopFeatures()

Number of features that selector will select, ordered by ascending p-value. If the number of features is less than numTopFeatures, then this will select all features. Only applicable when selectorType = "numTopFeatures". The default value of numTopFeatures is 50.

Returns:

(undocumented)

percentile

DoubleParam percentile()

Percentile of features that selector will select, ordered by ascending p-value. Only applicable when selectorType = "percentile". Default value is 0.1.

Returns:

(undocumented)

selectorType

Param<String> selectorType()

The selector type. Supported options: "numTopFeatures" (default), "percentile", "fpr", "fdr", "fwe"

Returns:

(undocumented)