StringIndexerModel

Companion object StringIndexerModel

class StringIndexerModel extends Model[StringIndexerModel] with StringIndexerBase with MLWritable

Annotations: @Since("1.4.0")
Source: StringIndexer.scala
Note: During transformation, if any input column does not exist, 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.

Linear Supertypes

MLWritable, StringIndexerBase, HasOutputCols, HasInputCols, HasOutputCol, HasInputCol, HasHandleInvalid, Model[StringIndexerModel], Transformer, PipelineStage, Logging, Params, Serializable, Identifiable, AnyRef, Any

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

StringIndexerModel
MLWritable
StringIndexerBase
HasOutputCols
HasInputCols
HasOutputCol
HasInputCol
HasHandleInvalid
Model
Transformer
PipelineStage
Logging
Params
Serializable
Identifiable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new StringIndexerModel(labelsArray: Array[Array[String]])
Annotations
@Since("3.0.0")
new StringIndexerModel(labels: Array[String])
Annotations
@Since("1.5.0")
new StringIndexerModel(uid: String, labels: Array[String])
Annotations
@Since("1.5.0")
new StringIndexerModel(uid: String, labelsArray: Array[Array[String]])
labelsArray
Array of ordered list of labels, corresponding to indices to be assigned for each input column.

Type Members

implicit class LogStringContext extends AnyRef
Definition Classes
Logging

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T
An alias for getOrDefault().
An alias for getOrDefault().
Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def clear(param: Param[_]): StringIndexerModel.this.type
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
Definition Classes
Params
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
def copy(extra: ParamMap): StringIndexerModel
Creates a copy of this instance with the same UID and some extra 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().
Definition Classes
StringIndexerModel → Model → Transformer → PipelineStage → Params
Annotations
@Since("1.4.1")
def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T
Copies param values from this instance to another instance for params shared by them.
Copies param values from this instance to another instance for params shared by them.
This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.
to
the target instance, which should work with the same set of default Params as this source instance
extra
extra params to be copied to the target's paramMap
returns
the target instance with param values copied
Attributes
protected
Definition Classes
Params
final def defaultCopy[T <: Params](extra: ParamMap): T
Default implementation of copy with extra params.
Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.
Attributes
protected
Definition Classes
Params
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def explainParam(param: Param[_]): String
Explains a param.
Explains a param.
param
input param, must belong to this instance.
returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
Definition Classes
Params
def explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See explainParam().
Definition Classes
Params
final def extractParamMap(): ParamMap
extractParamMap with no extra values.
extractParamMap with no extra values.
Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Definition Classes
Params
final def get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
Definition Classes
Params
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
Gets the default value of a parameter.
Definition Classes
Params
final def getHandleInvalid: String
Definition Classes
HasHandleInvalid
final def getInputCol: String
Definition Classes
HasInputCol
final def getInputCols: Array[String]
Definition Classes
HasInputCols
final def getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
Definition Classes
Params
final def getOutputCol: String
Definition Classes
HasOutputCol
final def getOutputCols: Array[String]
Definition Classes
HasOutputCols
def getParam(paramName: String): Param[Any]
Gets a param by its name.
Gets a param by its name.
Definition Classes
Params
def getStringOrderType: String
Definition Classes
StringIndexerBase
Annotations
@Since("2.3.0")
val handleInvalid: Param[String]
Param for how to handle invalid data (unseen labels or NULL values).
Param for how to handle invalid data (unseen labels or NULL values). Options are 'skip' (filter out rows with invalid data), 'error' (throw an error), or 'keep' (put invalid data in a special additional bucket, at index numLabels). Default: "error"
Definition Classes
StringIndexerBase → HasHandleInvalid
Annotations
@Since("1.6.0")
final def hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
Definition Classes
Params
def hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
Definition Classes
Params
def hasParent: Boolean
Indicates whether this Model has a corresponding parent.
Indicates whether this Model has a corresponding parent.
Definition Classes
Model
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
Attributes
protected
Definition Classes
Logging
def initializeLogIfNecessary(isInterpreter: Boolean): Unit
Attributes
protected
Definition Classes
Logging
final val inputCol: Param[String]
Param for input column name.
Param for input column name.
Definition Classes
HasInputCol
final val inputCols: StringArrayParam
Param for input column names.
Param for input column names.
Definition Classes
HasInputCols
final def isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
Definition Classes
Params
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
Definition Classes
Params
def isTraceEnabled(): Boolean
Attributes
protected
Definition Classes
Logging
val labelsArray: Array[Array[String]]
Annotations
@Since("3.0.0")
def log: Logger
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logName: String
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final val outputCol: Param[String]
Param for output column name.
Param for output column name.
Definition Classes
HasOutputCol
final val outputCols: StringArrayParam
Param for output column names.
Param for output column names.
Definition Classes
HasOutputCols
lazy val params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
Definition Classes
Params
Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
var parent: Estimator[StringIndexerModel]
The parent estimator that produced this model.
The parent estimator that produced this model.
Definition Classes
Model
Note
For ensembles' component Models, this value can be null.
def save(path: String): Unit
Saves this ML instance to the input path, a shortcut of write.save(path).
Saves this ML instance to the input path, a shortcut of write.save(path).
Definition Classes
MLWritable
Annotations
@Since("1.6.0") @throws("If the input path already exists but overwrite is not enabled.")
final def set(paramPair: ParamPair[_]): StringIndexerModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): StringIndexerModel.this.type
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): StringIndexerModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Definition Classes
Params
final def setDefault(paramPairs: ParamPair[_]*): StringIndexerModel.this.type
Sets default values for a list of params.
Sets default values for a list of params.
Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.
paramPairs
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.
Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): StringIndexerModel.this.type
Sets a default value for a param.
Sets a default value for a param.
param
param to set the default value. Make sure that this param is initialized before this method gets called.
value
the default value
Attributes
protected[ml]
Definition Classes
Params
def setHandleInvalid(value: String): StringIndexerModel.this.type
Annotations
@Since("1.6.0")
def setInputCol(value: String): StringIndexerModel.this.type
Annotations
@Since("1.4.0")
def setInputCols(value: Array[String]): StringIndexerModel.this.type
Annotations
@Since("3.0.0")
def setOutputCol(value: String): StringIndexerModel.this.type
Annotations
@Since("1.4.0")
def setOutputCols(value: Array[String]): StringIndexerModel.this.type
Annotations
@Since("3.0.0")
def setParent(parent: Estimator[StringIndexerModel]): StringIndexerModel
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
Definition Classes
Model
final val stringOrderType: Param[String]
Param for how to order labels of string column.
Param for how to order labels of string column. The first label after ordering is assigned an index of 0. Options are:
- 'frequencyDesc': descending order by label frequency (most frequent label assigned 0)
- 'frequencyAsc': ascending order by label frequency (least frequent label assigned 0)
- 'alphabetDesc': descending alphabetical order
- 'alphabetAsc': ascending alphabetical order Default is 'frequencyDesc'.
Note: In case of equal frequency when under frequencyDesc/Asc, the strings are further sorted alphabetically.
Definition Classes
StringIndexerBase
Annotations
@Since("2.3.0")
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
StringIndexerModel → Identifiable → AnyRef → Any
Annotations
@Since("3.0.0")
def transform(dataset: Dataset[_]): DataFrame
Transforms the input dataset.
Transforms the input dataset.
Definition Classes
StringIndexerModel → Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
dataset
input dataset
paramMap
additional parameters, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
dataset
input dataset
firstParamPair
the first param pair, overwrite embedded params
otherParamPairs
other param pairs, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0") @varargs()
def transformSchema(schema: StructType): StructType
Check transform validity and derive the output schema from the input schema.
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.
Definition Classes
StringIndexerModel → PipelineStage
Annotations
@Since("1.4.0")
def transformSchema(schema: StructType, logging: Boolean): StructType
Derives the output schema from the input schema and parameters, optionally with logging.
This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.
Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()
val uid: String
An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.
Definition Classes
StringIndexerModel → Identifiable
Annotations
@Since("1.4.0")
def validateAndTransformSchema(schema: StructType, skipNonExistsCol: Boolean = false): StructType
Validates and transforms the input schema.
Validates and transforms the input schema.
Attributes
protected
Definition Classes
StringIndexerBase
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def withLogContext(context: HashMap[String, String])(body: => Unit): Unit
Attributes
protected
Definition Classes
Logging
def write: StringIndexModelWriter
Returns an MLWriter instance for this ML instance.
Returns an MLWriter instance for this ML instance.
Definition Classes
StringIndexerModel → MLWritable
Annotations
@Since("1.6.0")

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
def labels: Array[String]
Annotations
@deprecated @Since("1.5.0")
Deprecated
(Since version 3.0.0) labels is deprecated and will be removed in 3.1.0. Use labelsArray instead.

Inherited from MLWritable

Value Members

def save(path: String): Unit
Saves this ML instance to the input path, a shortcut of write.save(path).
Saves this ML instance to the input path, a shortcut of write.save(path).
Definition Classes
MLWritable
Annotations
@Since("1.6.0") @throws("If the input path already exists but overwrite is not enabled.")

Inherited from StringIndexerBase

Value Members

def getStringOrderType: String
Definition Classes
StringIndexerBase
Annotations
@Since("2.3.0")
val handleInvalid: Param[String]
Param for how to handle invalid data (unseen labels or NULL values).
Param for how to handle invalid data (unseen labels or NULL values). Options are 'skip' (filter out rows with invalid data), 'error' (throw an error), or 'keep' (put invalid data in a special additional bucket, at index numLabels). Default: "error"
Definition Classes
StringIndexerBase → HasHandleInvalid
Annotations
@Since("1.6.0")
final val stringOrderType: Param[String]
Param for how to order labels of string column.
Param for how to order labels of string column. The first label after ordering is assigned an index of 0. Options are:
- 'frequencyDesc': descending order by label frequency (most frequent label assigned 0)
- 'frequencyAsc': ascending order by label frequency (least frequent label assigned 0)
- 'alphabetDesc': descending alphabetical order
- 'alphabetAsc': ascending alphabetical order Default is 'frequencyDesc'.
Note: In case of equal frequency when under frequencyDesc/Asc, the strings are further sorted alphabetically.
Definition Classes
StringIndexerBase
Annotations
@Since("2.3.0")
def validateAndTransformSchema(schema: StructType, skipNonExistsCol: Boolean = false): StructType
Validates and transforms the input schema.
Validates and transforms the input schema.
Attributes
protected
Definition Classes
StringIndexerBase

Inherited from HasOutputCols

Value Members

final def getOutputCols: Array[String]
Definition Classes
HasOutputCols
final val outputCols: StringArrayParam
Param for output column names.
Param for output column names.
Definition Classes
HasOutputCols

Inherited from HasInputCols

Value Members

final def getInputCols: Array[String]
Definition Classes
HasInputCols
final val inputCols: StringArrayParam
Param for input column names.
Param for input column names.
Definition Classes
HasInputCols

Inherited from HasOutputCol

Value Members

final def getOutputCol: String
Definition Classes
HasOutputCol
final val outputCol: Param[String]
Param for output column name.
Param for output column name.
Definition Classes
HasOutputCol

Inherited from HasInputCol

Value Members

final def getInputCol: String
Definition Classes
HasInputCol
final val inputCol: Param[String]
Param for input column name.
Param for input column name.
Definition Classes
HasInputCol

Inherited from HasHandleInvalid

Value Members

final def getHandleInvalid: String
Definition Classes
HasHandleInvalid

Inherited from Model[StringIndexerModel]

Value Members

def hasParent: Boolean
Indicates whether this Model has a corresponding parent.
Indicates whether this Model has a corresponding parent.
Definition Classes
Model
var parent: Estimator[StringIndexerModel]
The parent estimator that produced this model.
The parent estimator that produced this model.
Definition Classes
Model
Note
For ensembles' component Models, this value can be null.
def setParent(parent: Estimator[StringIndexerModel]): StringIndexerModel
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
Definition Classes
Model

Inherited from Transformer

Value Members

def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
dataset
input dataset
paramMap
additional parameters, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
dataset
input dataset
firstParamPair
the first param pair, overwrite embedded params
otherParamPairs
other param pairs, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0") @varargs()

Inherited from PipelineStage

Value Members

def transformSchema(schema: StructType, logging: Boolean): StructType
Derives the output schema from the input schema and parameters, optionally with logging.
This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.
Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()

Inherited from Logging

Value Members

def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
Attributes
protected
Definition Classes
Logging
def initializeLogIfNecessary(isInterpreter: Boolean): Unit
Attributes
protected
Definition Classes
Logging
def isTraceEnabled(): Boolean
Attributes
protected
Definition Classes
Logging
def log: Logger
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logName: String
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def withLogContext(context: HashMap[String, String])(body: => Unit): Unit
Attributes
protected
Definition Classes
Logging

Inherited from Params

Value Members

final def $[T](param: Param[T]): T
An alias for getOrDefault().
An alias for getOrDefault().
Attributes
protected
Definition Classes
Params
final def clear(param: Param[_]): StringIndexerModel.this.type
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
Definition Classes
Params
def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T
Copies param values from this instance to another instance for params shared by them.
Copies param values from this instance to another instance for params shared by them.
This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.
to
the target instance, which should work with the same set of default Params as this source instance
extra
extra params to be copied to the target's paramMap
returns
the target instance with param values copied
Attributes
protected
Definition Classes
Params
final def defaultCopy[T <: Params](extra: ParamMap): T
Default implementation of copy with extra params.
Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.
Attributes
protected
Definition Classes
Params
def explainParam(param: Param[_]): String
Explains a param.
Explains a param.
param
input param, must belong to this instance.
returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
Definition Classes
Params
def explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See explainParam().
Definition Classes
Params
final def extractParamMap(): ParamMap
extractParamMap with no extra values.
extractParamMap with no extra values.
Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Definition Classes
Params
final def get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
Definition Classes
Params
final def getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
Gets the default value of a parameter.
Definition Classes
Params
final def getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
Definition Classes
Params
def getParam(paramName: String): Param[Any]
Gets a param by its name.
Gets a param by its name.
Definition Classes
Params
final def hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
Definition Classes
Params
def hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
Definition Classes
Params
final def isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
Definition Classes
Params
final def isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
Definition Classes
Params
lazy val params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
Definition Classes
Params
Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
final def set(paramPair: ParamPair[_]): StringIndexerModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): StringIndexerModel.this.type
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): StringIndexerModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Definition Classes
Params
final def setDefault(paramPairs: ParamPair[_]*): StringIndexerModel.this.type
Sets default values for a list of params.
Sets default values for a list of params.
Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.
paramPairs
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.
Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): StringIndexerModel.this.type
Sets a default value for a param.
Sets a default value for a param.
param
param to set the default value. Make sure that this param is initialized before this method gets called.
value
the default value
Attributes
protected[ml]
Definition Classes
Params

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

val handleInvalid: Param[String]
Param for how to handle invalid data (unseen labels or NULL values).
Param for how to handle invalid data (unseen labels or NULL values). Options are 'skip' (filter out rows with invalid data), 'error' (throw an error), or 'keep' (put invalid data in a special additional bucket, at index numLabels). Default: "error"
Definition Classes
StringIndexerBase → HasHandleInvalid
Annotations
@Since("1.6.0")
final val inputCol: Param[String]
Param for input column name.
Param for input column name.
Definition Classes
HasInputCol
final val inputCols: StringArrayParam
Param for input column names.
Param for input column names.
Definition Classes
HasInputCols
final val outputCol: Param[String]
Param for output column name.
Param for output column name.
Definition Classes
HasOutputCol
final val outputCols: StringArrayParam
Param for output column names.
Param for output column names.
Definition Classes
HasOutputCols
final val stringOrderType: Param[String]
Param for how to order labels of string column.
Param for how to order labels of string column. The first label after ordering is assigned an index of 0. Options are:
- 'frequencyDesc': descending order by label frequency (most frequent label assigned 0)
- 'frequencyAsc': ascending order by label frequency (least frequent label assigned 0)
- 'alphabetDesc': descending alphabetical order
- 'alphabetAsc': ascending alphabetical order Default is 'frequencyDesc'.
Note: In case of equal frequency when under frequencyDesc/Asc, the strings are further sorted alphabetically.
Definition Classes
StringIndexerBase
Annotations
@Since("2.3.0")

Members

implicit class LogStringContext extends AnyRef
Definition Classes
Logging

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T
An alias for getOrDefault().
An alias for getOrDefault().
Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def clear(param: Param[_]): StringIndexerModel.this.type
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
Definition Classes
Params
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
def copy(extra: ParamMap): StringIndexerModel
Creates a copy of this instance with the same UID and some extra 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().
Definition Classes
StringIndexerModel → Model → Transformer → PipelineStage → Params
Annotations
@Since("1.4.1")
def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T
Copies param values from this instance to another instance for params shared by them.
Copies param values from this instance to another instance for params shared by them.
This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.
to
the target instance, which should work with the same set of default Params as this source instance
extra
extra params to be copied to the target's paramMap
returns
the target instance with param values copied
Attributes
protected
Definition Classes
Params
final def defaultCopy[T <: Params](extra: ParamMap): T
Default implementation of copy with extra params.
Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.
Attributes
protected
Definition Classes
Params
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def explainParam(param: Param[_]): String
Explains a param.
Explains a param.
param
input param, must belong to this instance.
returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
Definition Classes
Params
def explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See explainParam().
Definition Classes
Params
final def extractParamMap(): ParamMap
extractParamMap with no extra values.
extractParamMap with no extra values.
Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Definition Classes
Params
final def get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
Definition Classes
Params
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
Gets the default value of a parameter.
Definition Classes
Params
final def getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
Definition Classes
Params
def getParam(paramName: String): Param[Any]
Gets a param by its name.
Gets a param by its name.
Definition Classes
Params
final def hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
Definition Classes
Params
def hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
Definition Classes
Params
def hasParent: Boolean
Indicates whether this Model has a corresponding parent.
Indicates whether this Model has a corresponding parent.
Definition Classes
Model
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
Attributes
protected
Definition Classes
Logging
def initializeLogIfNecessary(isInterpreter: Boolean): Unit
Attributes
protected
Definition Classes
Logging
final def isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
Definition Classes
Params
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
Definition Classes
Params
def isTraceEnabled(): Boolean
Attributes
protected
Definition Classes
Logging
val labelsArray: Array[Array[String]]
Annotations
@Since("3.0.0")
def log: Logger
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logDebug(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logError(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logError(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logInfo(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logName: String
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logTrace(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry, throwable: Throwable): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(entry: LogEntry): Unit
Attributes
protected
Definition Classes
Logging
def logWarning(msg: => String): Unit
Attributes
protected
Definition Classes
Logging
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
lazy val params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
Definition Classes
Params
Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
var parent: Estimator[StringIndexerModel]
The parent estimator that produced this model.
The parent estimator that produced this model.
Definition Classes
Model
Note
For ensembles' component Models, this value can be null.
def save(path: String): Unit
Saves this ML instance to the input path, a shortcut of write.save(path).
Saves this ML instance to the input path, a shortcut of write.save(path).
Definition Classes
MLWritable
Annotations
@Since("1.6.0") @throws("If the input path already exists but overwrite is not enabled.")
final def set(paramPair: ParamPair[_]): StringIndexerModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): StringIndexerModel.this.type
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): StringIndexerModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Definition Classes
Params
final def setDefault(paramPairs: ParamPair[_]*): StringIndexerModel.this.type
Sets default values for a list of params.
Sets default values for a list of params.
Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.
paramPairs
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.
Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): StringIndexerModel.this.type
Sets a default value for a param.
Sets a default value for a param.
param
param to set the default value. Make sure that this param is initialized before this method gets called.
value
the default value
Attributes
protected[ml]
Definition Classes
Params
def setParent(parent: Estimator[StringIndexerModel]): StringIndexerModel
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
Definition Classes
Model
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
StringIndexerModel → Identifiable → AnyRef → Any
Annotations
@Since("3.0.0")
def transform(dataset: Dataset[_]): DataFrame
Transforms the input dataset.
Transforms the input dataset.
Definition Classes
StringIndexerModel → Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
dataset
input dataset
paramMap
additional parameters, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0")
def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
dataset
input dataset
firstParamPair
the first param pair, overwrite embedded params
otherParamPairs
other param pairs, overwrite embedded params
returns
transformed dataset
Definition Classes
Transformer
Annotations
@Since("2.0.0") @varargs()
def transformSchema(schema: StructType): StructType
Check transform validity and derive the output schema from the input schema.
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.
Definition Classes
StringIndexerModel → PipelineStage
Annotations
@Since("1.4.0")
def transformSchema(schema: StructType, logging: Boolean): StructType
Derives the output schema from the input schema and parameters, optionally with logging.
This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.
Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()
val uid: String
An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.
Definition Classes
StringIndexerModel → Identifiable
Annotations
@Since("1.4.0")
def validateAndTransformSchema(schema: StructType, skipNonExistsCol: Boolean = false): StructType
Validates and transforms the input schema.
Validates and transforms the input schema.
Attributes
protected
Definition Classes
StringIndexerBase
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def withLogContext(context: HashMap[String, String])(body: => Unit): Unit
Attributes
protected
Definition Classes
Logging
def write: StringIndexModelWriter
Returns an MLWriter instance for this ML instance.
Returns an MLWriter instance for this ML instance.
Definition Classes
StringIndexerModel → MLWritable
Annotations
@Since("1.6.0")
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
def labels: Array[String]
Annotations
@deprecated @Since("1.5.0")
Deprecated
(Since version 3.0.0) labels is deprecated and will be removed in 3.1.0. Use labelsArray instead.

Parameter setters

def setHandleInvalid(value: String): StringIndexerModel.this.type
Annotations
@Since("1.6.0")
def setInputCol(value: String): StringIndexerModel.this.type
Annotations
@Since("1.4.0")
def setInputCols(value: Array[String]): StringIndexerModel.this.type
Annotations
@Since("3.0.0")
def setOutputCol(value: String): StringIndexerModel.this.type
Annotations
@Since("1.4.0")
def setOutputCols(value: Array[String]): StringIndexerModel.this.type
Annotations
@Since("3.0.0")

Parameter getters

final def getHandleInvalid: String
Definition Classes
HasHandleInvalid
final def getInputCol: String
Definition Classes
HasInputCol
final def getInputCols: Array[String]
Definition Classes
HasInputCols
final def getOutputCol: String
Definition Classes
HasOutputCol
final def getOutputCols: Array[String]
Definition Classes
HasOutputCols
def getStringOrderType: String
Definition Classes
StringIndexerBase
Annotations
@Since("2.3.0")

Packages

Feature transformers

StringIndexerModel

Companion object StringIndexerModel

class StringIndexerModel extends Model[StringIndexerModel] with StringIndexerBase with MLWritable

Instance Constructors

Type Members

Value Members

Deprecated Value Members

Inherited from MLWritable

Value Members

Inherited from StringIndexerBase

Value Members

Inherited from HasOutputCols

Value Members

Inherited from HasInputCols

Value Members

Inherited from HasOutputCol

Value Members

Inherited from HasInputCol

Value Members

Inherited from HasHandleInvalid

Value Members

Inherited from Model[StringIndexerModel]

Value Members

Inherited from Transformer

Value Members

Inherited from PipelineStage

Value Members

Inherited from Logging

Value Members

Inherited from Params

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Parameters

Members

Parameter setters

Parameter getters

StringIndexerModel