Packages

final class ChiSqSelector extends Selector[ChiSqSelectorModel]

Chi-Squared feature selection, which selects categorical features to use for predicting a categorical label. The selector supports different selection methods: numTopFeatures, percentile, fpr, fdr, fwe.

  • numTopFeatures chooses a fixed number of top features according to a chi-squared test.
  • percentile is similar but chooses a fraction of all features instead of a fixed number.
  • fpr chooses all features whose p-value are below a threshold, thus controlling the false positive rate of selection.
  • fdr uses the [Benjamini-Hochberg procedure] (https://en.wikipedia.org/wiki/False_discovery_rate#Benjamini.E2.80.93Hochberg_procedure) to choose all features whose false discovery rate is below a threshold.
  • fwe chooses all features whose p-values are below a threshold. The threshold is scaled by 1/numFeatures, thus controlling the family-wise error rate of selection. By default, the selection method is numTopFeatures, with the default number of top features set to 50.
Annotations
@deprecated @Since( "1.6.0" )
Deprecated

(Since version 3.1.1) use UnivariateFeatureSelector instead

Source
ChiSqSelector.scala
Linear Supertypes
Selector[ChiSqSelectorModel], DefaultParamsWritable, MLWritable, SelectorParams, HasOutputCol, HasLabelCol, HasFeaturesCol, Estimator[ChiSqSelectorModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ChiSqSelector
  2. Selector
  3. DefaultParamsWritable
  4. MLWritable
  5. SelectorParams
  6. HasOutputCol
  7. HasLabelCol
  8. HasFeaturesCol
  9. Estimator
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChiSqSelector()
    Annotations
    @Since( "1.6.0" )
  2. new ChiSqSelector(uid: String)
    Annotations
    @Since( "1.6.0" )

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    An alias for getOrDefault().

    An alias for getOrDefault().

    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def clear(param: Param[_]): ChiSqSelector.this.type

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def copy(extra: ParamMap): ChiSqSelector

    Creates a copy of this instance with the same UID and some extra 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().

    Definition Classes
    ChiSqSelector → Selector → Estimator → PipelineStage → Params
    Annotations
    @Since( "1.6.0" )
  9. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Copies param values from this instance to another instance for params shared by them.

    Copies param values from this instance to another instance for params shared by them.

    This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

    to

    the target instance, which should work with the same set of default Params as this source instance

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

    Attributes
    protected
    Definition Classes
    Params
  10. def createSelectorModel(uid: String, indices: Array[Int]): ChiSqSelectorModel

    Create a new instance of concrete SelectorModel.

    Create a new instance of concrete SelectorModel.

    indices

    The indices of the selected features

    returns

    A new SelectorModel instance

    Attributes
    protected[this]
    Definition Classes
    ChiSqSelector → Selector
  11. final def defaultCopy[T <: Params](extra: ParamMap): T

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

    Attributes
    protected
    Definition Classes
    Params
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def explainParam(param: Param[_]): String

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

    a string that contains the input param name, doc, and optionally its default value and the user-supplied value

    Definition Classes
    Params
  15. def explainParams(): String

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes
    Params
  16. final def extractParamMap(): ParamMap

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  17. final def extractParamMap(extra: ParamMap): ParamMap

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Definition Classes
    Params
  18. final val fdr: DoubleParam

    The upper bound of the expected false discovery rate.

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

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  19. final val featuresCol: Param[String]

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def fit(dataset: Dataset[_]): ChiSqSelectorModel

    Fits a model to the input data.

    Fits a model to the input data.

    Definition Classes
    ChiSqSelector → Selector → Estimator
    Annotations
    @Since( "1.6.0" )
  22. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[ChiSqSelectorModel]

    Fits multiple models to the input data with multiple sets of parameters.

    Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could override this to optimize multi-model training.

    dataset

    input dataset

    paramMaps

    An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted models, matching the input parameter maps

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  23. def fit(dataset: Dataset[_], paramMap: ParamMap): ChiSqSelectorModel

    Fits a single model to the input data with provided parameter map.

    Fits a single model to the input data with provided parameter map.

    dataset

    input dataset

    paramMap

    Parameter map. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): ChiSqSelectorModel

    Fits a single model to the input data with optional parameters.

    Fits a single model to the input data with optional parameters.

    dataset

    input dataset

    firstParamPair

    the first param pair, overrides embedded params

    otherParamPairs

    other param pairs. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  25. final val fpr: DoubleParam

    The highest p-value for features to be kept.

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

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  26. final val fwe: DoubleParam

    The upper bound of the expected family-wise error rate.

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

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  27. final def get[T](param: Param[T]): Option[T]

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. final def getDefault[T](param: Param[T]): Option[T]

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  30. def getFdr: Double

    Definition Classes
    SelectorParams
  31. final def getFeaturesCol: String

    Definition Classes
    HasFeaturesCol
  32. def getFpr: Double

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  33. def getFwe: Double

    Definition Classes
    SelectorParams
  34. final def getLabelCol: String

    Definition Classes
    HasLabelCol
  35. def getNumTopFeatures: Int

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  36. final def getOrDefault[T](param: Param[T]): T

    Gets the value of a param in the embedded param map or its default value.

    Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

    Definition Classes
    Params
  37. final def getOutputCol: String

    Definition Classes
    HasOutputCol
  38. def getParam(paramName: String): Param[Any]

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  39. def getPercentile: Double

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  40. def getSelectionTestResult(df: DataFrame): DataFrame

    get the SelectionTestResult for every feature against the label

    get the SelectionTestResult for every feature against the label

    Attributes
    protected[this]
    Definition Classes
    ChiSqSelector → Selector
  41. def getSelectorType: String

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  42. final def hasDefault[T](param: Param[T]): Boolean

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

    Definition Classes
    Params
  43. def hasParam(paramName: String): Boolean

    Tests whether this instance contains a param with a given name.

    Tests whether this instance contains a param with a given name.

    Definition Classes
    Params
  44. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  46. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. final def isDefined(param: Param[_]): Boolean

    Checks whether a param is explicitly set or has a default value.

    Checks whether a param is explicitly set or has a default value.

    Definition Classes
    Params
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  50. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  51. final val labelCol: Param[String]

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  52. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  53. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  60. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  67. final val numTopFeatures: IntParam

    Number of features that selector will select, ordered by ascending p-value.

    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.

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  68. final val outputCol: Param[String]

    Param for output column name.

    Param for output column name.

    Definition Classes
    HasOutputCol
  69. lazy val params: Array[Param[_]]

    Returns all params sorted by their names.

    Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

    Definition Classes
    Params
    Note

    Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

  70. final val percentile: DoubleParam

    Percentile of features that selector will select, ordered by ascending p-value.

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

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  71. def save(path: String): Unit

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  72. final val selectorType: Param[String]

    The selector type.

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

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  73. final def set(paramPair: ParamPair[_]): ChiSqSelector.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  74. final def set(param: String, value: Any): ChiSqSelector.this.type

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  75. final def set[T](param: Param[T], value: T): ChiSqSelector.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  76. final def setDefault(paramPairs: ParamPair[_]*): ChiSqSelector.this.type

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

    Attributes
    protected
    Definition Classes
    Params
  77. final def setDefault[T](param: Param[T], value: T): ChiSqSelector.this.type

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes
    protected
    Definition Classes
    Params
  78. def setFdr(value: Double): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "2.2.0" )
  79. def setFeaturesCol(value: String): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "1.6.0" )
  80. def setFpr(value: Double): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "2.1.0" )
  81. def setFwe(value: Double): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "2.2.0" )
  82. def setLabelCol(value: String): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "1.6.0" )
  83. def setNumTopFeatures(value: Int): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "1.6.0" )
  84. def setOutputCol(value: String): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "1.6.0" )
  85. def setPercentile(value: Double): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "2.1.0" )
  86. def setSelectorType(value: String): ChiSqSelector.this.type

    Definition Classes
    ChiSqSelector → Selector
    Annotations
    @Since( "2.1.0" )
  87. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  88. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  89. def transformSchema(schema: StructType): StructType

    Check transform validity and derive the output schema from the input schema.

    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.

    Definition Classes
    ChiSqSelector → Selector → PipelineStage
    Annotations
    @Since( "1.6.0" )
  90. def transformSchema(schema: StructType, logging: Boolean): StructType

    :: DeveloperApi ::

    :: DeveloperApi ::

    Derives the output schema from the input schema and parameters, optionally with logging.

    This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  91. val uid: String

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    ChiSqSelector → Identifiable
    Annotations
    @Since( "1.6.0" )
  92. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  95. def write: MLWriter

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from Selector[ChiSqSelectorModel]

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from SelectorParams

Inherited from HasOutputCol

Inherited from HasLabelCol

Inherited from HasFeaturesCol

Inherited from Estimator[ChiSqSelectorModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters