ChiSqSelectorModel (Spark 2.3.0 JavaDoc)

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, Logging, Params, Identifiable, MLWritable
```
public final class ChiSqSelectorModel
extends Model<ChiSqSelectorModel>
implements MLWritable
```
Model fitted by ChiSqSelector.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete 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 DoubleParam`	`fdr()`
`DoubleParam`	`fdr()` The upper bound of the expected false discovery rate.
`static Param<String>`	`featuresCol()`
`static DoubleParam`	`fpr()`
`DoubleParam`	`fpr()` The highest p-value for features to be kept.
`static DoubleParam`	`fwe()`
`DoubleParam`	`fwe()` The upper bound of the expected family-wise error rate.
`static <T> scala.Option<T>`	`get(Param<T> param)`
`static <T> scala.Option<T>`	`getDefault(Param<T> param)`
`static double`	`getFdr()`
`double`	`getFdr()`
`static String`	`getFeaturesCol()`
`static double`	`getFpr()`
`double`	`getFpr()`
`static double`	`getFwe()`
`double`	`getFwe()`
`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 double`	`getPercentile()`
`double`	`getPercentile()`
`static String`	`getSelectorType()`
`String`	`getSelectorType()`
`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 ascending p-value.
`static Param<String>`	`outputCol()`
`static Param<?>[]`	`params()`
`static void`	`parent_$eq(Estimator<M> x$1)`
`static Estimator<M>`	`parent()`
`static DoubleParam`	`percentile()`
`DoubleParam`	`percentile()` Percentile of features that selector will select, ordered by statistics value descending.
`static MLReader<ChiSqSelectorModel>`	`read()`
`static void`	`save(String path)`
`int[]`	`selectedFeatures()` list of indices to select (filter).
`static Param<String>`	`selectorType()`
`Param<String>`	`selectorType()` The selector type of the ChisqSelector.
`static <T> Params`	`set(Param<T> param, T value)`
`ChiSqSelectorModel`	`setFeaturesCol(String value)`
`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.
`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.shared.HasFeaturesCol
featuresCol, getFeaturesCol

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

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

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.Identifiable
toString

Methods inherited from interface org.apache.spark.ml.util.MLWritable
save

Methods inherited from interface org.apache.spark.internal.Logging
initializeLogging, initializeLogIfNecessary, initializeLogIfNecessary, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

- 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()
```
  - 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()
```
  - percentile
```
public static final DoubleParam percentile()
```
  - getPercentile
```
public static double getPercentile()
```
  - fpr
```
public static final DoubleParam fpr()
```
  - getFpr
```
public static double getFpr()
```
  - fdr
```
public static final DoubleParam fdr()
```
  - getFdr
```
public static double getFdr()
```
  - fwe
```
public static final DoubleParam fwe()
```
  - getFwe
```
public static double getFwe()
```
  - selectorType
```
public static final Param<String> selectorType()
```
  - getSelectorType
```
public static String getSelectorType()
```
  - 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).
  - 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
    
    :: DeveloperApi ::
    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)
  - numTopFeatures
```
public 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)
  - getNumTopFeatures
```
public int getNumTopFeatures()
```
  - percentile
```
public DoubleParam percentile()
```
    Percentile of features that selector will select, ordered by statistics value descending. Only applicable when selectorType = "percentile". Default value is 0.1.
    
    Returns:
    
    (undocumented)
  - getPercentile
```
public double getPercentile()
```
  - fpr
```
public DoubleParam fpr()
```
    The highest p-value for features to be kept. Only applicable when selectorType = "fpr". Default value is 0.05.
    
    Returns:
    
    (undocumented)
  - getFpr
```
public double getFpr()
```
  - fdr
```
public DoubleParam fdr()
```
    The upper bound of the expected false discovery rate. Only applicable when selectorType = "fdr". Default value is 0.05.
    
    Returns:
    
    (undocumented)
  - getFdr
```
public double getFdr()
```
  - fwe
```
public DoubleParam fwe()
```
    The upper bound of the expected family-wise error rate. Only applicable when selectorType = "fwe". Default value is 0.05.
    
    Returns:
    
    (undocumented)
  - getFwe
```
public double getFwe()
```
  - selectorType
```
public Param<String> selectorType()
```
    The selector type of the ChisqSelector. Supported options: "numTopFeatures" (default), "percentile", "fpr", "fdr", "fwe".
    
    Returns:
    
    (undocumented)
  - getSelectorType
```
public String getSelectorType()
```

Class ChiSqSelectorModel

Method Summary

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

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

Methods inherited from class Object

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

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

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

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

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

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

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

Method Detail

read

load

toString

params

explainParam

explainParams

isSet

isDefined

hasParam

getParam

set

get

clear

getOrDefault

getDefault

hasDefault

extractParamMap

extractParamMap

parent

parent_$eq

setParent

hasParent

featuresCol

getFeaturesCol

outputCol

getOutputCol

labelCol

getLabelCol

numTopFeatures

getNumTopFeatures

percentile

getPercentile

fpr

getFpr

fdr

getFdr

fwe

getFwe

selectorType

getSelectorType

save

uid

selectedFeatures

setFeaturesCol

setOutputCol

transform

transformSchema

copy

write

numTopFeatures

getNumTopFeatures

percentile

getPercentile

fpr

getFpr

fdr

getFdr

fwe

getFwe

selectorType

getSelectorType