public class StringIndexer extends Estimator<StringIndexerModel> implements StringIndexerBase, DefaultParamsWritable
stringOrderType
.
IndexToString
for the inverse transformation,
Serialized FormConstructor and Description |
---|
StringIndexer() |
StringIndexer(String uid) |
Modifier and Type | Method and Description |
---|---|
StringIndexer |
copy(ParamMap extra)
Creates a copy of this instance with the same UID and some extra params.
|
StringIndexerModel |
fit(Dataset<?> dataset)
Fits a model to the input data.
|
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.
|
static StringIndexer |
load(String path) |
Param<String> |
outputCol()
Param for output column name.
|
StringArrayParam |
outputCols()
Param for output column names.
|
static MLReader<T> |
read() |
StringIndexer |
setHandleInvalid(String value) |
StringIndexer |
setInputCol(String value) |
StringIndexer |
setInputCols(String[] value) |
StringIndexer |
setOutputCol(String value) |
StringIndexer |
setOutputCols(String[] value) |
StringIndexer |
setStringOrderType(String value) |
Param<String> |
stringOrderType()
Param for how to order labels of string column.
|
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.
|
params
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getInOutCols, getStringOrderType, validateAndTransformField, validateAndTransformSchema
getHandleInvalid
getInputCol
getOutputCol
getInputCols
getOutputCols
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
toString
write
save
$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
public StringIndexer(String uid)
public StringIndexer()
public static StringIndexer load(String path)
public static MLReader<T> read()
public Param<String> handleInvalid()
StringIndexerBase
handleInvalid
in interface StringIndexerBase
handleInvalid
in interface HasHandleInvalid
public final Param<String> stringOrderType()
StringIndexerBase
Note: In case of equal frequency when under frequencyDesc/Asc, the strings are further sorted alphabetically.
stringOrderType
in interface StringIndexerBase
public final StringArrayParam outputCols()
HasOutputCols
outputCols
in interface HasOutputCols
public final StringArrayParam inputCols()
HasInputCols
inputCols
in interface HasInputCols
public final Param<String> outputCol()
HasOutputCol
outputCol
in interface HasOutputCol
public final Param<String> inputCol()
HasInputCol
inputCol
in interface HasInputCol
public String uid()
Identifiable
uid
in interface Identifiable
public StringIndexer setHandleInvalid(String value)
public StringIndexer setStringOrderType(String value)
public StringIndexer setInputCol(String value)
public StringIndexer setOutputCol(String value)
public StringIndexer setInputCols(String[] value)
public StringIndexer setOutputCols(String[] value)
public StringIndexerModel fit(Dataset<?> dataset)
Estimator
fit
in class Estimator<StringIndexerModel>
dataset
- (undocumented)public StructType transformSchema(StructType schema)
PipelineStage
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 PipelineStage
schema
- (undocumented)public StringIndexer copy(ParamMap extra)
Params
defaultCopy()
.copy
in interface Params
copy
in class Estimator<StringIndexerModel>
extra
- (undocumented)