public class StringIndexerModel extends Model<StringIndexerModel> implements StringIndexerBase, MLWritable
StringIndexer
.
param: labelsArray Array of ordered list of labels, corresponding to indices to be assigned for each input column.
StringIndexerModel.transform
would skip the input column.
If all input columns do not exist, it returns the input dataset unmodified.
This is a temporary fix for the case when target labels do not exist during prediction.Constructor and Description |
---|
StringIndexerModel(String[] labels) |
StringIndexerModel(String[][] labelsArray) |
StringIndexerModel(String uid,
String[] labels) |
StringIndexerModel(String uid,
String[][] labelsArray) |
Modifier and Type | Method and Description |
---|---|
StringIndexerModel |
copy(ParamMap extra)
Creates a copy of this instance with the same UID and some extra params.
|
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.
|
String[] |
labels()
Deprecated.
`labels` is deprecated and will be removed in 3.1.0. Use `labelsArray` instead. Since 3.0.0.
|
String[][] |
labelsArray() |
static StringIndexerModel |
load(String path) |
Param<String> |
outputCol()
Param for output column name.
|
StringArrayParam |
outputCols()
Param for output column names.
|
static MLReader<StringIndexerModel> |
read() |
StringIndexerModel |
setHandleInvalid(String value) |
StringIndexerModel |
setInputCol(String value) |
StringIndexerModel |
setInputCols(String[] value) |
StringIndexerModel |
setOutputCol(String value) |
StringIndexerModel |
setOutputCols(String[] value) |
Param<String> |
stringOrderType()
Param for how to order labels of string column.
|
String |
toString() |
Dataset<Row> |
transform(Dataset<?> dataset)
Transforms the input dataset.
|
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.
|
org.apache.spark.ml.feature.StringIndexerModel.StringIndexModelWriter |
write()
Returns an
MLWriter instance for this ML instance. |
transform, transform, transform
params
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
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 StringIndexerModel(String uid, String[][] labelsArray)
public StringIndexerModel(String uid, String[] labels)
public StringIndexerModel(String[] labels)
public StringIndexerModel(String[][] labelsArray)
public static MLReader<StringIndexerModel> read()
public static StringIndexerModel load(String path)
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 String[][] labelsArray()
public String[] labels()
public StringIndexerModel setHandleInvalid(String value)
public StringIndexerModel setInputCol(String value)
public StringIndexerModel setOutputCol(String value)
public StringIndexerModel setInputCols(String[] value)
public StringIndexerModel setOutputCols(String[] value)
public Dataset<Row> transform(Dataset<?> dataset)
Transformer
transform
in class Transformer
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 StringIndexerModel copy(ParamMap extra)
Params
defaultCopy()
.copy
in interface Params
copy
in class Model<StringIndexerModel>
extra
- (undocumented)public org.apache.spark.ml.feature.StringIndexerModel.StringIndexModelWriter write()
MLWritable
MLWriter
instance for this ML instance.write
in interface MLWritable
public String toString()
toString
in interface Identifiable
toString
in class Object