public class IndexToString extends Transformer implements HasInputCol, HasOutputCol, DefaultParamsWritable
Transformer that maps a column of indices back to a new column of corresponding
string values.
The index-string mapping is either from the ML attributes of the input column,
or from user-supplied labels (which take precedence over ML attributes).
StringIndexer for converting strings into indices,
Serialized Form| Constructor and Description |
|---|
IndexToString() |
IndexToString(String uid) |
| Modifier and Type | Method and Description |
|---|---|
IndexToString |
copy(ParamMap extra)
Creates a copy of this instance with the same UID and some extra params.
|
String[] |
getLabels() |
StringArrayParam |
labels()
Optional param for array of labels specifying index-string mapping.
|
static IndexToString |
load(String path) |
static MLReader<T> |
read() |
IndexToString |
setInputCol(String value) |
IndexToString |
setLabels(String[] value) |
IndexToString |
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.
|
transform, transform, transformequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetInputCol, inputColgetOutputCol, outputColclear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwntoStringwritesaveinitializeLogging, initializeLogIfNecessary, initializeLogIfNecessary, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarningpublic IndexToString(String uid)
public IndexToString()
public static IndexToString load(String path)
public static MLReader<T> read()
public String uid()
Identifiableuid in interface Identifiablepublic IndexToString setInputCol(String value)
public IndexToString setOutputCol(String value)
public IndexToString setLabels(String[] value)
public final StringArrayParam labels()
Default: Not specified, in which case inputCol metadata is used for labels.
public final String[] getLabels()
public StructType transformSchema(StructType schema)
PipelineStageCheck 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.
transformSchema in class PipelineStageschema - (undocumented)public Dataset<Row> transform(Dataset<?> dataset)
Transformertransform in class Transformerdataset - (undocumented)public IndexToString copy(ParamMap extra)
ParamsdefaultCopy().copy in interface Paramscopy in class Transformerextra - (undocumented)