RobustScalerParams (Spark 3.5.5 JavaDoc) (original) (raw)

• All Superinterfaces:
  HasInputCol, HasOutputCol, HasRelativeError, Identifiable, Params, java.io.Serializable
  All Known Implementing Classes:
  RobustScaler, RobustScalerModel

public interface RobustScalerParams
extends Params, HasInputCol, HasOutputCol, HasRelativeError

• • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method and Description
  double	getLower()
  double	getUpper()
  boolean	getWithCentering()
  boolean	getWithScaling()
  DoubleParam	lower() Lower quantile to calculate quantile range, shared by all features Default: 0.25
  DoubleParam	upper() Upper quantile to calculate quantile range, shared by all features Default: 0.75
  StructType	validateAndTransformSchema(StructType schema) Validates and transforms the input schema.
  BooleanParam	withCentering() Whether to center the data with median before scaling.
  BooleanParam	withScaling() Whether to scale the data to quantile range.

     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasInputCol](../../../../../org/apache/spark/ml/param/shared/HasInputCol.html "interface in org.apache.spark.ml.param.shared")  
     `[getInputCol](../../../../../org/apache/spark/ml/param/shared/HasInputCol.html#getInputCol--), [inputCol](../../../../../org/apache/spark/ml/param/shared/HasInputCol.html#inputCol--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasOutputCol](../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html "interface in org.apache.spark.ml.param.shared")  
     `[getOutputCol](../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html#getOutputCol--), [outputCol](../../../../../org/apache/spark/ml/param/shared/HasOutputCol.html#outputCol--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasRelativeError](../../../../../org/apache/spark/ml/param/shared/HasRelativeError.html "interface in org.apache.spark.ml.param.shared")  
     `[getRelativeError](../../../../../org/apache/spark/ml/param/shared/HasRelativeError.html#getRelativeError--), [relativeError](../../../../../org/apache/spark/ml/param/shared/HasRelativeError.html#relativeError--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")  
     `[clear](../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-), [copy](../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-), [copyValues](../../../../../org/apache/spark/ml/param/Params.html#copyValues-T-org.apache.spark.ml.param.ParamMap-), [defaultCopy](../../../../../org/apache/spark/ml/param/Params.html#defaultCopy-org.apache.spark.ml.param.ParamMap-), [defaultParamMap](../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap--), [explainParam](../../../../../org/apache/spark/ml/param/Params.html#explainParam-org.apache.spark.ml.param.Param-), [explainParams](../../../../../org/apache/spark/ml/param/Params.html#explainParams--), [extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap--), [extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap-org.apache.spark.ml.param.ParamMap-), [get](../../../../../org/apache/spark/ml/param/Params.html#get-org.apache.spark.ml.param.Param-), [getDefault](../../../../../org/apache/spark/ml/param/Params.html#getDefault-org.apache.spark.ml.param.Param-), [getOrDefault](../../../../../org/apache/spark/ml/param/Params.html#getOrDefault-org.apache.spark.ml.param.Param-), [getParam](../../../../../org/apache/spark/ml/param/Params.html#getParam-java.lang.String-), [hasDefault](../../../../../org/apache/spark/ml/param/Params.html#hasDefault-org.apache.spark.ml.param.Param-), [hasParam](../../../../../org/apache/spark/ml/param/Params.html#hasParam-java.lang.String-), [isDefined](../../../../../org/apache/spark/ml/param/Params.html#isDefined-org.apache.spark.ml.param.Param-), [isSet](../../../../../org/apache/spark/ml/param/Params.html#isSet-org.apache.spark.ml.param.Param-), [onParamChange](../../../../../org/apache/spark/ml/param/Params.html#onParamChange-org.apache.spark.ml.param.Param-), [paramMap](../../../../../org/apache/spark/ml/param/Params.html#paramMap--), [params](../../../../../org/apache/spark/ml/param/Params.html#params--), [set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.Param-T-), [set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.ParamPair-), [set](../../../../../org/apache/spark/ml/param/Params.html#set-java.lang.String-java.lang.Object-), [setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-org.apache.spark.ml.param.Param-T-), [setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-scala.collection.Seq-), [shouldOwn](../../../../../org/apache/spark/ml/param/Params.html#shouldOwn-org.apache.spark.ml.param.Param-)`  
     * ### Methods inherited from interface org.apache.spark.ml.util.[Identifiable](../../../../../org/apache/spark/ml/util/Identifiable.html "interface in org.apache.spark.ml.util")  
     `[toString](../../../../../org/apache/spark/ml/util/Identifiable.html#toString--), [uid](../../../../../org/apache/spark/ml/util/Identifiable.html#uid--)`

• • Method Detail

     * #### getLower  
     double getLower()  
     * #### getUpper  
     double getUpper()  
     * #### getWithCentering  
     boolean getWithCentering()  
     * #### getWithScaling  
     boolean getWithScaling()  
     * #### lower  
     [DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param") lower()  
     Lower quantile to calculate quantile range, shared by all features Default: 0.25  
     Returns:  
     (undocumented)  
     * #### upper  
     [DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param") upper()  
     Upper quantile to calculate quantile range, shared by all features Default: 0.75  
     Returns:  
     (undocumented)  
     * #### validateAndTransformSchema  
     [StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") validateAndTransformSchema([StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") schema)  
     Validates and transforms the input schema.  
     * #### withCentering  
     [BooleanParam](../../../../../org/apache/spark/ml/param/BooleanParam.html "class in org.apache.spark.ml.param") withCentering()  
     Whether to center the data with median before scaling. It will build a dense output, so take care when applying to sparse input. Default: false  
     Returns:  
     (undocumented)  
     * #### withScaling  
     [BooleanParam](../../../../../org/apache/spark/ml/param/BooleanParam.html "class in org.apache.spark.ml.param") withScaling()  
     Whether to scale the data to quantile range. Default: true  
     Returns:  
     (undocumented)