org.apache.spark.ml.feature

Class ChiSqSelectorModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

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

org.apache.spark.ml.feature.ChiSqSelectorModel

All Implemented Interfaces:

java.io.Serializable, org.apache.spark.internal.Logging, ChiSqSelectorParams, Params, HasFeaturesCol, HasLabelCol, HasOutputCol, Identifiable, MLWritable

public final class ChiSqSelectorModel
extends Model<ChiSqSelectorModel>
implements ChiSqSelectorParams, MLWritable

Model fitted by ChiSqSelector.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
ChiSqSelectorModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
DoubleParam	fdr() The upper bound of the expected false discovery rate.
Param<String>	featuresCol() Param for features column name.
DoubleParam	fpr() The highest p-value for features to be kept.
DoubleParam	fwe() The upper bound of the expected family-wise error rate.
Param<String>	labelCol() Param for label column name.
static ChiSqSelectorModel	load(String path)
IntParam	numTopFeatures() Number of features that selector will select, ordered by ascending p-value.
Param<String>	outputCol() Param for output column name.
DoubleParam	percentile() Percentile of features that selector will select, ordered by statistics value descending.
static MLReader<ChiSqSelectorModel>	read()
int[]	selectedFeatures() list of indices to select (filter).
Param<String>	selectorType() The selector type of the ChisqSelector.
ChiSqSelectorModel	setFeaturesCol(String value)
ChiSqSelectorModel	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 Object

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

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

getFdr, getFpr, getFwe, getNumTopFeatures, getPercentile, getSelectorType

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

getFeaturesCol

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

getOutputCol

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

getLabelCol

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

save

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

$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

Method Detail

read

public static MLReader<ChiSqSelectorModel> read()

load

public static ChiSqSelectorModel load(String path)

numTopFeatures

public final IntParam numTopFeatures()

Description copied from interface: ChiSqSelectorParams

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.

Specified by:

numTopFeatures in interface ChiSqSelectorParams

Returns:

(undocumented)

percentile

public final DoubleParam percentile()

Description copied from interface: ChiSqSelectorParams

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

Specified by:

percentile in interface ChiSqSelectorParams

Returns:

(undocumented)

fpr

public final DoubleParam fpr()

Description copied from interface: ChiSqSelectorParams

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

Specified by:

fpr in interface ChiSqSelectorParams

Returns:

(undocumented)

fdr

public final DoubleParam fdr()

Description copied from interface: ChiSqSelectorParams

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

Specified by:

fdr in interface ChiSqSelectorParams

Returns:

(undocumented)

fwe

public final DoubleParam fwe()

Description copied from interface: ChiSqSelectorParams

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

Specified by:

fwe in interface ChiSqSelectorParams

Returns:

(undocumented)

selectorType

public final Param<String> selectorType()

Description copied from interface: ChiSqSelectorParams

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

Specified by:

selectorType in interface ChiSqSelectorParams

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)

outputCol

public final Param<String> outputCol()

Description copied from interface: HasOutputCol

Param for output column name.

Specified by:

outputCol in interface HasOutputCol

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

list of indices to select (filter).

setFeaturesCol

public ChiSqSelectorModel setFeaturesCol(String value)

setOutputCol

public ChiSqSelectorModel 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 ChiSqSelectorModel 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<ChiSqSelectorModel>

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