Package org.apache.spark.ml.feature

Class TargetEncoderModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.Model<TargetEncoderModel>

org.apache.spark.ml.feature.TargetEncoderModel

All Implemented Interfaces:

Serializable, org.apache.spark.internal.Logging, TargetEncoderBase, Params, HasHandleInvalid, HasInputCol, HasInputCols, HasLabelCol, HasOutputCol, HasOutputCols, Identifiable, MLWritable

public class TargetEncoderModel
extends Model<TargetEncoderModel>
implements TargetEncoderBase, MLWritable

param: stats Array of statistics for each input feature. Array( Map( category, (counter, stat) ) )

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.spark.internal.Logging

org.apache.spark.internal.Logging.LogStringContext, org.apache.spark.internal.Logging.SparkShellLoggingFilter

Method Summary

Modifier and Type	Method	Description
TargetEncoderModel	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 during transform().
final Param<String>	inputCol()	Param for input column name.
final StringArrayParam	inputCols()	Param for input column names.
final Param<String>	labelCol()	Param for label column name.
static TargetEncoderModel	load(String path)
final Param<String>	outputCol()	Param for output column name.
final StringArrayParam	outputCols()	Param for output column names.
static MLReader<TargetEncoderModel>	read()
TargetEncoderModel	setHandleInvalid(String value)
TargetEncoderModel	setInputCol(String value)
TargetEncoderModel	setInputCols(String[] values)
TargetEncoderModel	setOutputCol(String value)
TargetEncoderModel	setOutputCols(String[] values)
TargetEncoderModel	setSmoothing(double value)
DoubleParam	smoothing()
Param<String>	targetType()
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.
MLWriter	write()	Returns an MLWriter instance for this ML instance.

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

hasParent, parent, setParent

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

transform, transform, transform

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

params

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.param.shared.HasHandleInvalid

getHandleInvalid

Methods inherited from interface org.apache.spark.ml.param.shared.HasInputCol

getInputCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasInputCols

getInputCols

Methods inherited from interface org.apache.spark.ml.param.shared.HasLabelCol

getLabelCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasOutputCol

getOutputCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasOutputCols

getOutputCols

Methods inherited from interface org.apache.spark.internal.Logging

initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, isTraceEnabled, log, logDebug, logDebug, logDebug, logDebug, logError, logError, logError, logError, logInfo, logInfo, logInfo, logInfo, logName, LogStringContext, logTrace, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, logWarning, org$apache$spark$internal$Logging$$log_, org$apache$spark$internal$Logging$$log__$eq, withLogContext

Methods inherited from interface org.apache.spark.ml.util.MLWritable

save

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, onParamChange, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

Methods inherited from interface org.apache.spark.ml.feature.TargetEncoderBase

getSmoothing, getTargetType, inputFeatures, outputFeatures, validateSchema

Method Details

read

public static MLReader<TargetEncoderModel> read()

load

public static TargetEncoderModel load(String path)

handleInvalid

public Param<String> handleInvalid()

Description copied from interface: TargetEncoderBase

Param for how to handle invalid data during transform(). Options are 'keep' (invalid data presented as an extra categorical feature) or 'error' (throw an error). Note that this Param is only used during transform; during fitting, invalid data will result in an error. Default: "error"

Specified by:

handleInvalid in interface HasHandleInvalid

Specified by:

handleInvalid in interface TargetEncoderBase

Returns:

(undocumented)

targetType

public Param<String> targetType()

Specified by:

targetType in interface TargetEncoderBase

smoothing

public DoubleParam smoothing()

Specified by:

smoothing in interface TargetEncoderBase

outputCols

public final StringArrayParam outputCols()

Description copied from interface: HasOutputCols

Param for output column names.

Specified by:

outputCols in interface HasOutputCols

Returns:

(undocumented)

outputCol

public final Param<String> outputCol()

Description copied from interface: HasOutputCol

Param for output column name.

Specified by:

outputCol in interface HasOutputCol

Returns:

(undocumented)

inputCols

public final StringArrayParam inputCols()

Description copied from interface: HasInputCols

Param for input column names.

Specified by:

inputCols in interface HasInputCols

Returns:

(undocumented)

inputCol

public final Param<String> inputCol()

Description copied from interface: HasInputCol

Param for input column name.

Specified by:

inputCol in interface HasInputCol

Returns:

(undocumented)

labelCol

public final Param<String> labelCol()

Description copied from interface: HasLabelCol

Param for label column name.

Specified by:

labelCol in interface HasLabelCol

Returns:

(undocumented)

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

setInputCol

public TargetEncoderModel setInputCol(String value)

setOutputCol

public TargetEncoderModel setOutputCol(String value)

setInputCols

public TargetEncoderModel setInputCols(String[] values)

setOutputCols

public TargetEncoderModel setOutputCols(String[] values)

setHandleInvalid

public TargetEncoderModel setHandleInvalid(String value)

setSmoothing

public TargetEncoderModel setSmoothing(double value)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

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.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

transform

public Dataset<Row> transform(Dataset<?> dataset)

Description copied from class: Transformer

Transforms the input dataset.

Specified by:

transform in class Transformer

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

copy

public TargetEncoderModel 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. See defaultCopy().

Specified by:

copy in interface Params

Specified by:

copy in class Model<TargetEncoderModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

write

public MLWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)

toString

public String toString()

Specified by:

toString in interface Identifiable

Overrides:

toString in class Object