org.apache.spark.ml.feature

Class StringIndexerModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.Model<StringIndexerModel>

org.apache.spark.ml.feature.StringIndexerModel

All Implemented Interfaces:

java.io.Serializable, org.apache.spark.internal.Logging, StringIndexerBase, Params, HasHandleInvalid, HasInputCol, HasInputCols, HasOutputCol, HasOutputCols, Identifiable, MLWritable

public class StringIndexerModel
extends Model<StringIndexerModel>
implements StringIndexerBase, MLWritable

Model fitted by StringIndexer.

param: labelsArray Array of ordered list of labels, corresponding to indices to be assigned for each input column.

See Also:

Serialized Form

Note:

During transformation, if any input column does not exist, StringIndexerModel.transform would skip the input column. If all input columns do not exist, it returns the input dataset unmodified. This is a temporary fix for the case when target labels do not exist during prediction.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.spark.internal.Logging

org.apache.spark.internal.Logging.SparkShellLoggingFilter

Constructor Summary

Constructors

Constructor and Description
StringIndexerModel(String[] labels)
StringIndexerModel(String[][] labelsArray)
StringIndexerModel(String uid, String[] labels)
StringIndexerModel(String uid, String[][] labelsArray)

Method Summary

Modifier and Type	Method and Description
StringIndexerModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
Param<String>	handleInvalid() Param for how to handle invalid data (unseen labels or NULL values).
Param<String>	inputCol() Param for input column name.
StringArrayParam	inputCols() Param for input column names.
String[]	labels() Deprecated. `labels` is deprecated and will be removed in 3.1.0. Use `labelsArray` instead. Since 3.0.0.
String[][]	labelsArray()
static StringIndexerModel	load(String path)
Param<String>	outputCol() Param for output column name.
StringArrayParam	outputCols() Param for output column names.
static MLReader<StringIndexerModel>	read()
StringIndexerModel	setHandleInvalid(String value)
StringIndexerModel	setInputCol(String value)
StringIndexerModel	setInputCols(String[] value)
StringIndexerModel	setOutputCol(String value)
StringIndexerModel	setOutputCols(String[] value)
Param<String>	stringOrderType() Param for how to order labels of string column.
String	toString()
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) Check transform validity and derive the output schema from the input schema.
String	uid() An immutable unique ID for the object and its derivatives.
org.apache.spark.ml.feature.StringIndexerModel.StringIndexModelWriter	write() Returns an MLWriter instance for this ML instance.

Methods inherited from class org.apache.spark.ml.Model

hasParent, parent, setParent

Methods inherited from class org.apache.spark.ml.Transformer

transform, transform, transform

Methods inherited from class org.apache.spark.ml.PipelineStage

params

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.feature.StringIndexerBase

getInOutCols, getStringOrderType, validateAndTransformField, validateAndTransformSchema

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

getHandleInvalid

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

getInputCol

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

getOutputCol

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

getInputCols

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

getOutputCols

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

clear, 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.MLWritable

save

Methods inherited from interface org.apache.spark.internal.Logging

$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize

Constructor Detail

StringIndexerModel

public StringIndexerModel(String uid,
                          String[][] labelsArray)

StringIndexerModel

public StringIndexerModel(String uid,
                          String[] labels)

StringIndexerModel

public StringIndexerModel(String[] labels)

StringIndexerModel

public StringIndexerModel(String[][] labelsArray)

Method Detail

read

public static MLReader<StringIndexerModel> read()

load

public static StringIndexerModel load(String path)

handleInvalid

public Param<String> handleInvalid()

Description copied from interface: StringIndexerBase

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 StringIndexerBase

Specified by:

handleInvalid in interface HasHandleInvalid

Returns:

(undocumented)

stringOrderType

public final Param<String> stringOrderType()

Description copied from interface: StringIndexerBase

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.

Specified by:

stringOrderType in interface StringIndexerBase

Returns:

(undocumented)

outputCols

public final StringArrayParam outputCols()

Description copied from interface: HasOutputCols

Param for output column names.

Specified by:

outputCols in interface HasOutputCols

Returns:

(undocumented)

inputCols

public final StringArrayParam inputCols()

Description copied from interface: HasInputCols

Param for input column names.

Specified by:

inputCols in interface HasInputCols

Returns:

(undocumented)

outputCol

public final Param<String> outputCol()

Description copied from interface: HasOutputCol

Param for output column name.

Specified by:

outputCol in interface HasOutputCol

Returns:

(undocumented)

inputCol

public final Param<String> inputCol()

Description copied from interface: HasInputCol

Param for input column name.

Specified by:

inputCol in interface HasInputCol

Returns:

(undocumented)

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

labelsArray

public String[][] labelsArray()

labels

public String[] labels()

Deprecated. `labels` is deprecated and will be removed in 3.1.0. Use `labelsArray` instead. Since 3.0.0.

setHandleInvalid

public StringIndexerModel setHandleInvalid(String value)

setInputCol

public StringIndexerModel setInputCol(String value)

setOutputCol

public StringIndexerModel setOutputCol(String value)

setInputCols

public StringIndexerModel setInputCols(String[] value)

setOutputCols

public StringIndexerModel setOutputCols(String[] value)

transform

public Dataset<Row> transform(Dataset<?> dataset)

Description copied from class: Transformer

Transforms the input dataset.

Specified by:

transform in class Transformer

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

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.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

copy

public StringIndexerModel copy(ParamMap extra)

Description copied from interface: 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().

Specified by:

copy in interface Params

Specified by:

copy in class Model<StringIndexerModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

write

public org.apache.spark.ml.feature.StringIndexerModel.StringIndexModelWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)

toString

public String toString()

Specified by:

toString in interface Identifiable

Overrides:

toString in class Object