OneHotEncoderBase (Spark 3.5.5 JavaDoc) (original) (raw)

• All Superinterfaces:
  HasHandleInvalid, HasInputCol, HasInputCols, HasOutputCol, HasOutputCols, Identifiable, Params, java.io.Serializable
  All Known Implementing Classes:
  OneHotEncoder, OneHotEncoderModel

public interface OneHotEncoderBase
extends Params, HasHandleInvalid, HasInputCol, HasInputCols, HasOutputCol, HasOutputCols
Private trait for params and common methods for OneHotEncoder and OneHotEncoderModel

• • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method and Description
  BooleanParam	dropLast() Whether to drop the last category in the encoded vector (default: true)
  boolean	getDropLast()
  scala.Tuple2<String[],String[]>	getInOutCols() Returns the input and output column names corresponding in pair.
  Param	handleInvalid() Param for how to handle invalid data during transform().
  StructType	validateAndTransformSchema(StructType schema, boolean dropLast, boolean keepInvalid)

     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasHandleInvalid](../../../../../org/apache/spark/ml/param/shared/HasHandleInvalid.html "interface in org.apache.spark.ml.param.shared")  
     `[getHandleInvalid](../../../../../org/apache/spark/ml/param/shared/HasHandleInvalid.html#getHandleInvalid--)`  
     * ### 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.[HasInputCols](../../../../../org/apache/spark/ml/param/shared/HasInputCols.html "interface in org.apache.spark.ml.param.shared")  
     `[getInputCols](../../../../../org/apache/spark/ml/param/shared/HasInputCols.html#getInputCols--), [inputCols](../../../../../org/apache/spark/ml/param/shared/HasInputCols.html#inputCols--)`  
     * ### 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.[HasOutputCols](../../../../../org/apache/spark/ml/param/shared/HasOutputCols.html "interface in org.apache.spark.ml.param.shared")  
     `[getOutputCols](../../../../../org/apache/spark/ml/param/shared/HasOutputCols.html#getOutputCols--), [outputCols](../../../../../org/apache/spark/ml/param/shared/HasOutputCols.html#outputCols--)`  
     * ### 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

     * #### dropLast  
     [BooleanParam](../../../../../org/apache/spark/ml/param/BooleanParam.html "class in org.apache.spark.ml.param") dropLast()  
     Whether to drop the last category in the encoded vector (default: true)  
     Returns:  
     (undocumented)  
     * #### getDropLast  
     boolean getDropLast()  
     * #### getInOutCols  
     scala.Tuple2<String[],String[]> getInOutCols()  
     Returns the input and output column names corresponding in pair.  
     * #### handleInvalid  
     [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String> handleInvalid()  
     Param for how to handle invalid data during transform(). Options are 'keep' (invalid data presented as an extra categorical feature) or 'error' (throw an error). Note that this Param is only used during transform; during fitting, invalid data will result in an error. Default: "error"  
     Specified by:  
     `[handleInvalid](../../../../../org/apache/spark/ml/param/shared/HasHandleInvalid.html#handleInvalid--)` in interface `[HasHandleInvalid](../../../../../org/apache/spark/ml/param/shared/HasHandleInvalid.html "interface in org.apache.spark.ml.param.shared")`  
     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,  
                                           boolean dropLast,  
                                           boolean keepInvalid)