Package org.apache.spark.ml.feature
Class Binarizer
Object
org.apache.spark.ml.PipelineStage
org.apache.spark.ml.Transformer
org.apache.spark.ml.feature.Binarizer
- All Implemented Interfaces:
Serializable
,org.apache.spark.internal.Logging
,Params
,HasInputCol
,HasInputCols
,HasOutputCol
,HasOutputCols
,HasThreshold
,HasThresholds
,DefaultParamsWritable
,Identifiable
,MLWritable
,scala.Serializable
public final class Binarizer
extends Transformer
implements HasThreshold, HasThresholds, HasInputCol, HasOutputCol, HasInputCols, HasOutputCols, DefaultParamsWritable
Binarize a column of continuous features given a threshold.
Since 3.0.0,
Binarize
can map multiple columns at once by setting the inputCols
parameter. Note that
when both the inputCol
and inputCols
parameters are set, an Exception will be thrown. The
threshold
parameter is used for single column usage, and thresholds
is for multiple
columns.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.spark.internal.Logging
org.apache.spark.internal.Logging.SparkShellLoggingFilter
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionCreates a copy of this instance with the same UID and some extra params.inputCol()
Param for input column name.final StringArrayParam
Param for input column names.static Binarizer
Param for output column name.final StringArrayParam
Param for output column names.static MLReader<T>
read()
setInputCol
(String value) setInputCols
(String[] value) setOutputCol
(String value) setOutputCols
(String[] value) setThreshold
(double value) setThresholds
(double[] value) Param for threshold used to binarize continuous features.Array of threshold used to binarize continuous features.toString()
Transforms the input dataset.transformSchema
(StructType schema) Check transform validity and derive the output schema from the input schema.uid()
An immutable unique ID for the object and its derivatives.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.util.DefaultParamsWritable
write
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.HasOutputCol
getOutputCol
Methods inherited from interface org.apache.spark.ml.param.shared.HasOutputCols
getOutputCols
Methods inherited from interface org.apache.spark.ml.param.shared.HasThreshold
getThreshold
Methods inherited from interface org.apache.spark.ml.param.shared.HasThresholds
getThresholds
Methods inherited from interface org.apache.spark.internal.Logging
initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log_, org$apache$spark$internal$Logging$$log__$eq
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
-
Constructor Details
-
Binarizer
-
Binarizer
public Binarizer()
-
-
Method Details
-
load
-
read
-
outputCols
Description copied from interface:HasOutputCols
Param for output column names.- Specified by:
outputCols
in interfaceHasOutputCols
- Returns:
- (undocumented)
-
inputCols
Description copied from interface:HasInputCols
Param for input column names.- Specified by:
inputCols
in interfaceHasInputCols
- Returns:
- (undocumented)
-
outputCol
Description copied from interface:HasOutputCol
Param for output column name.- Specified by:
outputCol
in interfaceHasOutputCol
- Returns:
- (undocumented)
-
inputCol
Description copied from interface:HasInputCol
Param for input column name.- Specified by:
inputCol
in interfaceHasInputCol
- Returns:
- (undocumented)
-
uid
Description copied from interface:Identifiable
An immutable unique ID for the object and its derivatives.- Specified by:
uid
in interfaceIdentifiable
- Returns:
- (undocumented)
-
threshold
Param for threshold used to binarize continuous features. The features greater than the threshold, will be binarized to 1.0. The features equal to or less than the threshold, will be binarized to 0.0. Default: 0.0- Specified by:
threshold
in interfaceHasThreshold
- Returns:
- (undocumented)
-
setThreshold
-
thresholds
Array of threshold used to binarize continuous features. This is for multiple columns input. If transforming multiple columns and thresholds is not set, but threshold is set, then threshold will be applied across all columns.- Specified by:
thresholds
in interfaceHasThresholds
- Returns:
- (undocumented)
-
setThresholds
-
setInputCol
-
setOutputCol
-
setInputCols
-
setOutputCols
-
transform
Description copied from class:Transformer
Transforms the input dataset.- Specified by:
transform
in classTransformer
- Parameters:
dataset
- (undocumented)- Returns:
- (undocumented)
-
transformSchema
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 byParam.validate()
.Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.
- Specified by:
transformSchema
in classPipelineStage
- Parameters:
schema
- (undocumented)- Returns:
- (undocumented)
-
copy
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. SeedefaultCopy()
.- Specified by:
copy
in interfaceParams
- Specified by:
copy
in classTransformer
- Parameters:
extra
- (undocumented)- Returns:
- (undocumented)
-
toString
- Specified by:
toString
in interfaceIdentifiable
- Overrides:
toString
in classObject
-