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, Logging, Params, Identifiable, MLWritable

public class StringIndexerModel
extends Model<StringIndexerModel>
implements MLWritable

:: Experimental :: Model fitted by StringIndexer.

NOTE: During transformation, if the input column does not exist, StringIndexerModel.transform would return the input dataset unmodified. This is a temporary fix for the case when target labels do not exist during prediction.

param: labels Ordered list of labels, corresponding to indices to be assigned.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
StringIndexerModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
String	getHandleInvalid()
String	getInputCol()
String	getOutputCol()
Param<String>	handleInvalid() Param for how to handle invalid entries.
Param<String>	inputCol() Param for input column name.
String[]	labels()
static StringIndexerModel	load(String path)
Param<String>	outputCol() Param for output column name.
static MLReader<StringIndexerModel>	read()
StringIndexerModel	setHandleInvalid(String value)
StringIndexerModel	setInputCol(String value)
StringIndexerModel	setOutputCol(String value)
DataFrame	transform(DataFrame dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
StructType	validateAndTransformSchema(StructType schema) Validates and transforms the input schema.
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 Object

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

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, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

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

toString

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

save

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

StringIndexerModel

public StringIndexerModel(String uid,
                  String[] labels)

StringIndexerModel

public StringIndexerModel(String[] labels)

Method Detail

read

public static MLReader<StringIndexerModel> read()

load

public static StringIndexerModel load(String path)

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)

labels

public String[] labels()

setHandleInvalid

public StringIndexerModel setHandleInvalid(String value)

setInputCol

public StringIndexerModel setInputCol(String value)

setOutputCol

public StringIndexerModel setOutputCol(String value)

transform

public DataFrame transform(DataFrame 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

:: DeveloperApi ::

Derives the output schema from the input schema.

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.

Specified by:

copy in interface Params

Specified by:

copy in class Model<StringIndexerModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

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)

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema)

Validates and transforms the input schema.

inputCol

public Param<String> inputCol()

Param for input column name.

Returns:

(undocumented)

getInputCol

public String getInputCol()

outputCol

public Param<String> outputCol()

Param for output column name.

Returns:

(undocumented)

getOutputCol

public String getOutputCol()

handleInvalid

public Param<String> handleInvalid()

Param for how to handle invalid entries. Options are skip (which will filter out rows with bad values), or error (which will throw an errror). More options may be added later..

Returns:

(undocumented)

getHandleInvalid

public String getHandleInvalid()