Bucketizer (Spark 2.2.1 JavaDoc)

Object
- org.apache.spark.ml.PipelineStage
- - org.apache.spark.ml.Transformer
  - - org.apache.spark.ml.Model<Bucketizer>
    - - org.apache.spark.ml.feature.Bucketizer

All Implemented Interfaces:

java.io.Serializable, Logging, Params, DefaultParamsWritable, Identifiable, MLWritable
```
public final class Bucketizer
extends Model<Bucketizer>
implements DefaultParamsWritable
```
Bucketizer maps a column of continuous features to a column of feature buckets.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Bucketizer()

Bucketizer(String uid)

Constructors
Constructor and Description
`Bucketizer()`
`Bucketizer(String uid)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Params`	`clear(Param<?> param)`
`Bucketizer`	`copy(ParamMap extra)` Creates a copy of this instance with the same UID and some extra params.
`static String`	`explainParam(Param<?> param)`
`static String`	`explainParams()`
`static ParamMap`	`extractParamMap()`
`static ParamMap`	`extractParamMap(ParamMap extra)`
`static <T> scala.Option<T>`	`get(Param<T> param)`
`static <T> scala.Option<T>`	`getDefault(Param<T> param)`
`String`	`getHandleInvalid()`
`static String`	`getInputCol()`
`static <T> T`	`getOrDefault(Param<T> param)`
`static String`	`getOutputCol()`
`static Param<Object>`	`getParam(String paramName)`
`double[]`	`getSplits()`
`Param<String>`	`handleInvalid()` Param for how to handle invalid entries.
`static <T> boolean`	`hasDefault(Param<T> param)`
`static boolean`	`hasParam(String paramName)`
`static boolean`	`hasParent()`
`static Param<String>`	`inputCol()`
`static boolean`	`isDefined(Param<?> param)`
`static boolean`	`isSet(Param<?> param)`
`static Bucketizer`	`load(String path)`
`static Param<String>`	`outputCol()`
`static Param<?>[]`	`params()`
`static void`	`parent_$eq(Estimator<M> x$1)`
`static Estimator<M>`	`parent()`
`static void`	`save(String path)`
`static <T> Params`	`set(Param<T> param, T value)`
`Bucketizer`	`setHandleInvalid(String value)`
`Bucketizer`	`setInputCol(String value)`
`Bucketizer`	`setOutputCol(String value)`
`static M`	`setParent(Estimator<M> parent)`
`Bucketizer`	`setSplits(double[] value)`
`DoubleArrayParam`	`splits()` Parameter for mapping continuous features into buckets.
`static String`	`toString()`
`Dataset<Row>`	`transform(Dataset<?> dataset)` Transforms the input dataset.
`StructType`	`transformSchema(StructType schema)` :: DeveloperApi ::
`String`	`uid()` An immutable unique ID for the object and its derivatives.
`static MLWriter`	`write()`

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 Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.util.DefaultParamsWritable
write

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

Methods inherited from interface org.apache.spark.ml.util.Identifiable
toString

Methods inherited from interface org.apache.spark.internal.Logging
initializeLogging, initializeLogIfNecessary, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

- Constructor Detail
  - Bucketizer
```
public Bucketizer(String uid)
```
  - Bucketizer
```
public Bucketizer()
```
- Method Detail
  - load
```
public static Bucketizer load(String path)
```
  - toString
```
public static String toString()
```
  - params
```
public static Param<?>[] params()
```
  - explainParam
```
public static String explainParam(Param<?> param)
```
  - explainParams
```
public static String explainParams()
```
  - isSet
```
public static final boolean isSet(Param<?> param)
```
  - isDefined
```
public static final boolean isDefined(Param<?> param)
```
  - hasParam
```
public static boolean hasParam(String paramName)
```
  - getParam
```
public static Param<Object> getParam(String paramName)
```
  - set
```
public static final <T> Params set(Param<T> param,
                                   T value)
```
  - get
```
public static final <T> scala.Option<T> get(Param<T> param)
```
  - clear
```
public static final Params clear(Param<?> param)
```
  - getOrDefault
```
public static final <T> T getOrDefault(Param<T> param)
```
  - getDefault
```
public static final <T> scala.Option<T> getDefault(Param<T> param)
```
  - hasDefault
```
public static final <T> boolean hasDefault(Param<T> param)
```
  - extractParamMap
```
public static final ParamMap extractParamMap(ParamMap extra)
```
  - extractParamMap
```
public static final ParamMap extractParamMap()
```
  - parent
```
public static Estimator<M> parent()
```
  - parent_$eq
```
public static void parent_$eq(Estimator<M> x$1)
```
  - setParent
```
public static M setParent(Estimator<M> parent)
```
  - hasParent
```
public static boolean hasParent()
```
  - inputCol
```
public static final Param<String> inputCol()
```
  - getInputCol
```
public static final String getInputCol()
```
  - outputCol
```
public static final Param<String> outputCol()
```
  - getOutputCol
```
public static final String getOutputCol()
```
  - save
```
public static void save(String path)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - write
```
public static MLWriter write()
```
  - 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)
  - splits
```
public DoubleArrayParam splits()
```
    Parameter for mapping continuous features into buckets. With n+1 splits, there are n buckets. A bucket defined by splits x,y holds values in the range [x,y) except the last bucket, which also includes y. Splits should be of length greater than or equal to 3 and strictly increasing. Values at -inf, inf must be explicitly provided to cover all Double values; otherwise, values outside the splits specified will be treated as errors.
    See also handleInvalid, which can optionally create an additional bucket for NaN values.
    
    Returns:
    
    (undocumented)
  - getSplits
```
public double[] getSplits()
```
  - setSplits
```
public Bucketizer setSplits(double[] value)
```
  - setInputCol
```
public Bucketizer setInputCol(String value)
```
  - setOutputCol
```
public Bucketizer setOutputCol(String value)
```
  - handleInvalid
```
public Param<String> handleInvalid()
```
    Param for how to handle invalid entries. Options are 'skip' (filter out rows with invalid values), 'error' (throw an error), or 'keep' (keep invalid values in a special additional bucket). Default: "error"
    
    Returns:
    
    (undocumented)
  - getHandleInvalid
```
public String getHandleInvalid()
```
  - setHandleInvalid
```
public Bucketizer setHandleInvalid(String value)
```
  - 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)
  - transformSchema
```
public StructType transformSchema(StructType schema)
```
    Description copied from class: PipelineStage
    
    :: DeveloperApi ::
    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)
  - copy
```
public Bucketizer 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<Bucketizer>
    
    Parameters:
    
    extra - (undocumented)
    
    Returns:
    
    (undocumented)

Class Bucketizer

Constructor Summary

Method Summary

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

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

Methods inherited from class Object

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

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

Methods inherited from interface org.apache.spark.ml.param.Params

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

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

Constructor Detail

Bucketizer

Bucketizer

Method Detail

load

toString

params

explainParam

explainParams

isSet

isDefined

hasParam

getParam

set

get

clear

getOrDefault

getDefault

hasDefault

extractParamMap

extractParamMap

parent

parent_$eq

setParent

hasParent

inputCol

getInputCol

outputCol

getOutputCol

save

write

uid

splits

getSplits

setSplits

setInputCol

setOutputCol

handleInvalid

getHandleInvalid

setHandleInvalid

transform

transformSchema

copy