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, StringIndexerBase, Params, HasHandleInvalid, HasInputCol, HasOutputCol, Identifiable, MLWritable

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

Model fitted by StringIndexer.

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

See Also:

Serialized Form

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.

Constructor Summary

Constructors

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

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.
String[]	labels()
static StringIndexerModel	load(String path)
static MLReader<StringIndexerModel>	read()
StringIndexerModel	setHandleInvalid(String value)
StringIndexerModel	setInputCol(String value)
StringIndexerModel	setOutputCol(String value)
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
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 Object

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

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

getStringOrderType, handleInvalid, stringOrderType, 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, inputCol

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

getOutputCol, outputCol

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

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.internal.Logging

initializeLogging, initializeLogIfNecessary, initializeLogIfNecessary, 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 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

:: DeveloperApi ::

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)