Maps a column of continuous features to a column of feature buckets. Since 3.0.0, Bucketizer
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 splits
parameter is only used for single column usage, and splitsArray
is for multiple columns.
New in version 1.4.0.
Examples
>>> values = [(0.1, 0.0), (0.4, 1.0), (1.2, 1.3), (1.5, float("nan")), ... (float("nan"), 1.0), (float("nan"), 0.0)] >>> df = spark.createDataFrame(values, ["values1", "values2"]) >>> bucketizer = Bucketizer() >>> bucketizer.setSplits([-float("inf"), 0.5, 1.4, float("inf")]) Bucketizer... >>> bucketizer.setInputCol("values1") Bucketizer... >>> bucketizer.setOutputCol("buckets") Bucketizer... >>> bucketed = bucketizer.setHandleInvalid("keep").transform(df).collect() >>> bucketed = bucketizer.setHandleInvalid("keep").transform(df.select("values1")) >>> bucketed.show(truncate=False) +-------+-------+ |values1|buckets| +-------+-------+ |0.1 |0.0 | |0.4 |0.0 | |1.2 |1.0 | |1.5 |2.0 | |NaN |3.0 | |NaN |3.0 | +-------+-------+ ... >>> bucketizer.setParams(outputCol="b").transform(df).head().b 0.0 >>> bucketizerPath = temp_path + "/bucketizer" >>> bucketizer.save(bucketizerPath) >>> loadedBucketizer = Bucketizer.load(bucketizerPath) >>> loadedBucketizer.getSplits() == bucketizer.getSplits() True >>> loadedBucketizer.transform(df).take(1) == bucketizer.transform(df).take(1) True >>> bucketed = bucketizer.setHandleInvalid("skip").transform(df).collect() >>> len(bucketed) 4 >>> bucketizer2 = Bucketizer(splitsArray= ... [[-float("inf"), 0.5, 1.4, float("inf")], [-float("inf"), 0.5, float("inf")]], ... inputCols=["values1", "values2"], outputCols=["buckets1", "buckets2"]) >>> bucketed2 = bucketizer2.setHandleInvalid("keep").transform(df) >>> bucketed2.show(truncate=False) +-------+-------+--------+--------+ |values1|values2|buckets1|buckets2| +-------+-------+--------+--------+ |0.1 |0.0 |0.0 |0.0 | |0.4 |1.0 |0.0 |1.0 | |1.2 |1.3 |1.0 |1.0 | |1.5 |NaN |2.0 |2.0 | |NaN |1.0 |3.0 |1.0 | |NaN |0.0 |3.0 |0.0 | +-------+-------+--------+--------+ ...
Methods
clear
(param)
Clears a param from the param map if it has been explicitly set.
copy
([extra])
Creates a copy of this instance with the same uid and some extra params.
explainParam
(param)
Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.
Returns the documentation of all params with their optionally default values and user-supplied values.
extractParamMap
([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 < user-supplied values < extra.
Gets the value of handleInvalid or its default value.
Gets the value of inputCol or its default value.
Gets the value of inputCols or its default value.
getOrDefault
(param)
Gets the value of a param in the user-supplied param map or its default value.
Gets the value of outputCol or its default value.
Gets the value of outputCols or its default value.
getParam
(paramName)
Gets a param by its name.
Gets the value of threshold or its default value.
Gets the array of split points or its default value.
hasDefault
(param)
Checks whether a param has a default value.
hasParam
(paramName)
Tests whether this instance contains a param with a given (string) name.
isDefined
(param)
Checks whether a param is explicitly set by user or has a default value.
isSet
(param)
Checks whether a param is explicitly set by user.
load
(path)
Reads an ML instance from the input path, a shortcut of read().load(path).
read
()
Returns an MLReader instance for this class.
save
(path)
Save this ML instance to the given path, a shortcut of 'write().save(path)'.
set
(param, value)
Sets a parameter in the embedded param map.
setHandleInvalid
(value)
Sets the value of handleInvalid
.
setInputCol
(value)
Sets the value of inputCol
.
setInputCols
(value)
Sets the value of inputCols
.
setOutputCol
(value)
Sets the value of outputCol
.
setOutputCols
(value)
Sets the value of outputCols
.
setParams
(self, \*[, splits, inputCol, ...])
Sets params for this Bucketizer.
setSplits
(value)
Sets the value of splits
.
setSplitsArray
(value)
Sets the value of splitsArray
.
transform
(dataset[, params])
Transforms the input dataset with optional parameters.
write
()
Returns an MLWriter instance for this ML instance.
Attributes
Methods Documentation
Clears a param from the param map if it has been explicitly set.
Creates a copy of this instance with the same uid and some extra params. This implementation first calls Params.copy and then make a copy of the companion Java pipeline component with extra params. So both the Python wrapper and the Java pipeline component get copied.
Extra parameters to copy to the new instance
JavaParams
Copy of this instance
Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.
Returns the documentation of all params with their optionally default values and user-supplied values.
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 < user-supplied values < extra.
extra param values
merged param map
Gets the value of handleInvalid or its default value.
Gets the value of inputCol or its default value.
Gets the value of inputCols or its default value.
Gets the value of a param in the user-supplied param map or its default value. Raises an error if neither is set.
Gets the value of outputCol or its default value.
Gets the value of outputCols or its default value.
Gets a param by its name.
Gets the value of threshold or its default value.
New in version 1.4.0.
Gets the array of split points or its default value.
New in version 3.0.0.
Checks whether a param has a default value.
Tests whether this instance contains a param with a given (string) name.
Checks whether a param is explicitly set by user or has a default value.
Checks whether a param is explicitly set by user.
Reads an ML instance from the input path, a shortcut of read().load(path).
Returns an MLReader instance for this class.
Save this ML instance to the given path, a shortcut of âwrite().save(path)â.
Sets a parameter in the embedded param map.
Sets the value of handleInvalid
.
Sets the value of inputCol
.
Sets the value of inputCols
.
New in version 3.0.0.
Sets the value of outputCol
.
Sets the value of outputCols
.
New in version 3.0.0.
Sets params for this Bucketizer.
New in version 1.4.0.
Sets the value of splits
.
New in version 1.4.0.
Sets the value of splitsArray
.
New in version 3.0.0.
Transforms the input dataset with optional parameters.
New in version 1.3.0.
pyspark.sql.DataFrame
input dataset
an optional param map that overrides embedded params.
pyspark.sql.DataFrame
transformed dataset
Returns an MLWriter instance for this ML instance.
Attributes Documentation
Returns all params ordered by name. The default implementation uses dir()
to get all attributes of type Param
.
A unique id for the object.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4