org.apache.spark.ml.feature

Class ChiSqSelector

Object

org.apache.spark.ml.PipelineStage

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

org.apache.spark.ml.feature.ChiSqSelector

All Implemented Interfaces:

java.io.Serializable, Params, DefaultParamsWritable, Identifiable, MLWritable

public final class ChiSqSelector
extends Estimator<ChiSqSelectorModel>
implements DefaultParamsWritable

Chi-Squared feature selection, which selects categorical features to use for predicting a categorical label.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChiSqSelector()
ChiSqSelector(String uid)

Method Summary

Methods

Modifier and Type	Method and Description
static Params	clear(Param<?> param)
ChiSqSelector	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 Param<String>	featuresCol()
ChiSqSelectorModel	fit(Dataset<?> dataset) Fits a model to the input data.
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
static String	getFeaturesCol()
static String	getLabelCol()
static int	getNumTopFeatures()
int	getNumTopFeatures()
static <T> T	getOrDefault(Param<T> param)
static String	getOutputCol()
static Param<Object>	getParam(String paramName)
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static Param<String>	labelCol()
static ChiSqSelector	load(String path)
static IntParam	numTopFeatures()
IntParam	numTopFeatures() Number of features that selector will select (ordered by statistic value descending).
static Param<String>	outputCol()
static Param<?>[]	params()
static void	save(String path)
static <T> Params	set(Param<T> param, T value)
ChiSqSelector	setFeaturesCol(String value)
ChiSqSelector	setLabelCol(String value)
ChiSqSelector	setNumTopFeatures(int value)
ChiSqSelector	setOutputCol(String value)
static String	toString()
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
static void	validateParams()
static MLWriter	write()

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

fit, fit, fit, fit

Methods inherited from class Object

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

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, validateParams

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

Constructor Detail

ChiSqSelector

public ChiSqSelector(String uid)

ChiSqSelector

public ChiSqSelector()

Method Detail

load

public static ChiSqSelector load(String path)

toString

public static String toString()

params

public static Param<?>[] params()

validateParams

public static void validateParams()

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

featuresCol

public static final Param<String> featuresCol()

getFeaturesCol

public static final String getFeaturesCol()

outputCol

public static final Param<String> outputCol()

getOutputCol

public static final String getOutputCol()

labelCol

public static final Param<String> labelCol()

getLabelCol

public static final String getLabelCol()

numTopFeatures

public static final IntParam numTopFeatures()

getNumTopFeatures

public static int getNumTopFeatures()

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)

setNumTopFeatures

public ChiSqSelector setNumTopFeatures(int value)

setFeaturesCol

public ChiSqSelector setFeaturesCol(String value)

setOutputCol

public ChiSqSelector setOutputCol(String value)

setLabelCol

public ChiSqSelector setLabelCol(String value)

fit

public ChiSqSelectorModel fit(Dataset<?> dataset)

Description copied from class: Estimator

Fits a model to the input data.

Specified by:

fit in class Estimator<ChiSqSelectorModel>

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.

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 ChiSqSelector 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 Estimator<ChiSqSelectorModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

numTopFeatures

public IntParam numTopFeatures()

Number of features that selector will select (ordered by statistic value descending). If the number of features is less than numTopFeatures, then this will select all features. The default value of numTopFeatures is 50.

Returns:

(undocumented)

getNumTopFeatures

public int getNumTopFeatures()