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, Params, Identifiable, MLWritable

public final class ChiSqSelectorModel
extends Model<ChiSqSelectorModel>
implements MLWritable

Model fitted by ChiSqSelector.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static Params	clear(Param<?> param)
ChiSqSelectorModel	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()
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	hasParent()
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static Param<String>	labelCol()
static ChiSqSelectorModel	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	parent_$eq(Estimator<M> x$1)
static Estimator<M>	parent()
static MLReader<ChiSqSelectorModel>	read()
static void	save(String path)
int[]	selectedFeatures() list of indices to select (filter).
static <T> Params	set(Param<T> param, T value)
ChiSqSelectorModel	setFeaturesCol(String value)
ChiSqSelectorModel	setLabelCol(String value) Deprecated. labelCol is not used by ChiSqSelectorModel. Since 2.0.0.
ChiSqSelectorModel	setOutputCol(String value)
static M	setParent(Estimator<M> parent)
static String	toString()
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
static void	validateParams()
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 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.MLWritable

save

Method Detail

read

public static MLReader<ChiSqSelectorModel> read()

load

public static ChiSqSelectorModel 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()

parent

public static Estimator<M> parent()

parent_$eq

public static void parent_$eq(Estimator<M> x$1)

setParent

public static M setParent(Estimator<M> parent)

hasParent

public static boolean hasParent()

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

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). Must be ordered asc

setFeaturesCol

public ChiSqSelectorModel setFeaturesCol(String value)

setOutputCol

public ChiSqSelectorModel setOutputCol(String value)

setLabelCol

public ChiSqSelectorModel setLabelCol(String value)

Deprecated. labelCol is not used by ChiSqSelectorModel. Since 2.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)

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

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

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