Packages

final class ChiSqSelectorModel extends SelectorModel[ChiSqSelectorModel]

Model fitted by ChiSqSelector.

Annotations
@Since( "1.6.0" )
Source
ChiSqSelector.scala
Linear Supertypes
SelectorModel[ChiSqSelectorModel], MLWritable, SelectorParams, HasOutputCol, HasLabelCol, HasFeaturesCol, Model[ChiSqSelectorModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ChiSqSelectorModel
  2. SelectorModel
  3. MLWritable
  4. SelectorParams
  5. HasOutputCol
  6. HasLabelCol
  7. HasFeaturesCol
  8. Model
  9. Transformer
  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

Parameters

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

  1. 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" )
  2. final val featuresCol: Param[String]

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  3. 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" )
  4. 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" )
  5. final val labelCol: Param[String]

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  6. 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" )
  7. final val outputCol: Param[String]

    Param for output column name.

    Param for output column name.

    Definition Classes
    HasOutputCol
  8. 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" )
  9. 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" )

Members

  1. final def clear(param: Param[_]): ChiSqSelectorModel.this.type

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  2. def copy(extra: ParamMap): ChiSqSelectorModel

    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
    ChiSqSelectorModelModelTransformerPipelineStageParams
    Annotations
    @Since( "1.6.0" )
  3. 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
  4. def explainParams(): String

    Explains all params of this instance.

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

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

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  6. 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
  7. 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
  8. 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
  9. 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
  10. def getParam(paramName: String): Param[Any]

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  11. 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
  12. 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
  13. def hasParent: Boolean

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes
    Model
  14. 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
  15. final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  16. 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.

  17. var parent: Estimator[ChiSqSelectorModel]

    The parent estimator that produced this model.

    The parent estimator that produced this model.

    Definition Classes
    Model
    Note

    For ensembles' component Models, this value can be null.

  18. 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( ... )
  19. val selectedFeatures: Array[Int]
    Definition Classes
    ChiSqSelectorModel → SelectorModel
    Annotations
    @Since( "3.1.0" )
  20. final def set[T](param: Param[T], value: T): ChiSqSelectorModel.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  21. def setParent(parent: Estimator[ChiSqSelectorModel]): ChiSqSelectorModel

    Sets the parent of this model (Java API).

    Sets the parent of this model (Java API).

    Definition Classes
    Model
  22. def toString(): String
    Definition Classes
    ChiSqSelectorModelIdentifiable → AnyRef → Any
    Annotations
    @Since( "3.0.0" )
  23. def transform(dataset: Dataset[_]): DataFrame

    Transforms the input dataset.

    Transforms the input dataset.

    Definition Classes
    SelectorModel → Transformer
    Annotations
    @Since( "3.1.0" )
  24. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Transforms the dataset with provided parameter map as additional parameters.

    Transforms the dataset with provided parameter map as additional parameters.

    dataset

    input dataset

    paramMap

    additional parameters, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  25. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Transforms the dataset with optional parameters

    Transforms the dataset with optional parameters

    dataset

    input dataset

    firstParamPair

    the first param pair, overwrite embedded params

    otherParamPairs

    other param pairs, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  26. 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
    ChiSqSelectorModel → SelectorModel → PipelineStage
    Annotations
    @Since( "1.6.0" )
  27. 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
    ChiSqSelectorModel → SelectorModel → Identifiable
    Annotations
    @Since( "1.6.0" )
  28. def write: MLWriter

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    ChiSqSelectorModelMLWritable
    Annotations
    @Since( "1.6.0" )

Parameter setters

  1. def setFeaturesCol(value: String): ChiSqSelectorModel.this.type

    Definition Classes
    ChiSqSelectorModel → SelectorModel
    Annotations
    @Since( "1.6.0" )
  2. def setOutputCol(value: String): ChiSqSelectorModel.this.type

    Definition Classes
    ChiSqSelectorModel → SelectorModel
    Annotations
    @Since( "1.6.0" )

Parameter getters

  1. def getFdr: Double

    Definition Classes
    SelectorParams
  2. final def getFeaturesCol: String

    Definition Classes
    HasFeaturesCol
  3. def getFpr: Double

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

    Definition Classes
    SelectorParams
  5. final def getLabelCol: String

    Definition Classes
    HasLabelCol
  6. def getNumTopFeatures: Int

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  7. final def getOutputCol: String

    Definition Classes
    HasOutputCol
  8. def getPercentile: Double

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )
  9. def getSelectorType: String

    Definition Classes
    SelectorParams
    Annotations
    @Since( "3.1.0" )