org.apache.spark.ml.feature

Interface StringIndexerBase

All Superinterfaces:

HasHandleInvalid, HasInputCol, HasInputCols, HasOutputCol, HasOutputCols, Identifiable, Params, java.io.Serializable

All Known Implementing Classes:

StringIndexer, StringIndexerModel

public interface StringIndexerBase
extends Params, HasHandleInvalid, HasInputCol, HasOutputCol, HasInputCols, HasOutputCols

Base trait for StringIndexer and StringIndexerModel.

Method Summary

Modifier and Type	Method and Description
scala.Tuple2<String[],String[]>	getInOutCols() Returns the input and output column names corresponding in pair.
String	getStringOrderType()
Param<String>	handleInvalid() Param for how to handle invalid data (unseen labels or NULL values).
Param<String>	stringOrderType() Param for how to order labels of string column.
StructField	validateAndTransformField(StructType schema, String inputColName, String outputColName)
StructType	validateAndTransformSchema(StructType schema, boolean skipNonExistsCol) Validates and transforms the input schema.

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

getHandleInvalid

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

getInputCol, inputCol

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

getOutputCol, outputCol

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

getInputCols, inputCols

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

getOutputCols, outputCols

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

clear, copy, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, onParamChange, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

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

toString, uid

Method Detail

getInOutCols

scala.Tuple2<String[],String[]> getInOutCols()

Returns the input and output column names corresponding in pair.

getStringOrderType

String getStringOrderType()

handleInvalid

Param<String> handleInvalid()

Param for how to handle invalid data (unseen labels or NULL values). Options are 'skip' (filter out rows with invalid data), 'error' (throw an error), or 'keep' (put invalid data in a special additional bucket, at index numLabels). Default: "error"

Specified by:

handleInvalid in interface HasHandleInvalid

Returns:

(undocumented)

stringOrderType

Param<String> stringOrderType()

Param for how to order labels of string column. The first label after ordering is assigned an index of 0. Options are: - 'frequencyDesc': descending order by label frequency (most frequent label assigned 0) - 'frequencyAsc': ascending order by label frequency (least frequent label assigned 0) - 'alphabetDesc': descending alphabetical order - 'alphabetAsc': ascending alphabetical order Default is 'frequencyDesc'.

Note: In case of equal frequency when under frequencyDesc/Asc, the strings are further sorted alphabetically.

Returns:

(undocumented)

validateAndTransformField

StructField validateAndTransformField(StructType schema,
                                      String inputColName,
                                      String outputColName)

validateAndTransformSchema

StructType validateAndTransformSchema(StructType schema,
                                      boolean skipNonExistsCol)

Validates and transforms the input schema.