Experimental

org.apache.spark.ml.feature

Class IndexToString

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.feature.IndexToString

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class IndexToString
extends Transformer

A Transformer that maps a column of string indices back to a new column of corresponding string values using either the ML attributes of the input column, or if provided using the labels supplied by the user. All original columns are kept during transformation.

See Also:

StringIndexer} for converting strings into indices, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexToString()

Method Summary

Methods

Modifier and Type	Method and Description
IndexToString	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
java.lang.String[]	getLabels() Optional labels to be provided by the user, if not supplied column metadata is read for labels.
StringArrayParam	labels() Param for array of labels.
IndexToString	setInputCol(java.lang.String value)
IndexToString	setLabels(java.lang.String[] value) Optional labels to be provided by the user, if not supplied column metadata is read for labels.
IndexToString	setOutputCol(java.lang.String value)
DataFrame	transform(DataFrame dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) Transform the schema for the inverse transformation
java.lang.String	uid() An immutable unique ID for the object and its derivatives.

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

transform, transform, transform

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

transformSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, 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.Logging

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

Constructor Detail

IndexToString

public IndexToString()

Method Detail

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Returns:

(undocumented)

setInputCol

public IndexToString setInputCol(java.lang.String value)

setOutputCol

public IndexToString setOutputCol(java.lang.String value)

setLabels

public IndexToString setLabels(java.lang.String[] value)

Optional labels to be provided by the user, if not supplied column metadata is read for labels. The default value is an empty array, but the empty array is ignored and column metadata used instead.

Parameters:

value - (undocumented)

Returns:

(undocumented)

labels

public final StringArrayParam labels()

Param for array of labels. Optional labels to be provided by the user. Default: Empty array, in which case column metadata is used for labels.

Returns:

(undocumented)

getLabels

public final java.lang.String[] getLabels()

Optional labels to be provided by the user, if not supplied column metadata is read for labels.

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Transform the schema for the inverse transformation

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

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)

copy

public IndexToString 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 Transformer

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()