RFormulaModel (Spark 2.3.2 JavaDoc)

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

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable, MLWritable
```
public class RFormulaModel
extends Model<RFormulaModel>
implements MLWritable
```
:: Experimental :: Model fitted by RFormula. Fitting is required to determine the factor levels of formula terms.
param: resolvedFormula the fitted R formula. param: pipelineModel the fitted feature model, including factor to index mappings.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static Params`	`clear(Param<?> param)`
`RFormulaModel`	`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 Param<String>`	`featuresCol()`
`static BooleanParam`	`forceIndexLabel()`
`BooleanParam`	`forceIndexLabel()` Force to index label whether it is numeric or string type.
`static Param<String>`	`formula()`
`Param<String>`	`formula()` R formula parameter.
`static <T> scala.Option<T>`	`get(Param<T> param)`
`static <T> scala.Option<T>`	`getDefault(Param<T> param)`
`static String`	`getFeaturesCol()`
`static boolean`	`getForceIndexLabel()`
`boolean`	`getForceIndexLabel()`
`static String`	`getFormula()`
`String`	`getFormula()`
`static String`	`getHandleInvalid()`
`static String`	`getLabelCol()`
`static <T> T`	`getOrDefault(Param<T> param)`
`static Param<Object>`	`getParam(String paramName)`
`static String`	`getStringIndexerOrderType()`
`String`	`getStringIndexerOrderType()`
`static Param<String>`	`handleInvalid()`
`Param<String>`	`handleInvalid()` Param for how to handle invalid data (unseen or NULL values) in features and label column of string type.
`static <T> boolean`	`hasDefault(Param<T> param)`
`boolean`	`hasLabelCol(StructType schema)`
`static boolean`	`hasParam(String paramName)`
`static boolean`	`hasParent()`
`static boolean`	`isDefined(Param<?> param)`
`static boolean`	`isSet(Param<?> param)`
`static Param<String>`	`labelCol()`
`static RFormulaModel`	`load(String path)`
`static Param<?>[]`	`params()`
`static void`	`parent_$eq(Estimator<M> x$1)`
`static Estimator<M>`	`parent()`
`static MLReader<RFormulaModel>`	`read()`
`static void`	`save(String path)`
`static <T> Params`	`set(Param<T> param, T value)`
`static M`	`setParent(Estimator<M> parent)`
`static Param<String>`	`stringIndexerOrderType()`
`Param<String>`	`stringIndexerOrderType()` Param for how to order categories of a string FEATURE column used by `StringIndexer`.
`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.
`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 Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.param.shared.HasFeaturesCol
featuresCol, getFeaturesCol

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

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

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.MLWritable
save

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

- Method Detail
  - read
```
public static MLReader<RFormulaModel> read()
```
  - load
```
public static RFormulaModel load(String path)
```
  - 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()
```
  - featuresCol
```
public static final Param<String> featuresCol()
```
  - getFeaturesCol
```
public static final String getFeaturesCol()
```
  - labelCol
```
public static final Param<String> labelCol()
```
  - getLabelCol
```
public static final String getLabelCol()
```
  - getHandleInvalid
```
public static final String getHandleInvalid()
```
  - formula
```
public static Param<String> formula()
```
  - getFormula
```
public static String getFormula()
```
  - forceIndexLabel
```
public static BooleanParam forceIndexLabel()
```
  - getForceIndexLabel
```
public static boolean getForceIndexLabel()
```
  - handleInvalid
```
public static Param<String> handleInvalid()
```
  - stringIndexerOrderType
```
public static final Param<String> stringIndexerOrderType()
```
  - getStringIndexerOrderType
```
public static String getStringIndexerOrderType()
```
  - save
```
public static void save(String path)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - 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)
  - 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 RFormulaModel 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<RFormulaModel>
    
    Parameters:
    
    extra - (undocumented)
    
    Returns:
    
    (undocumented)
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Identifiable
    
    Overrides:
    
    toString in class Object
  - 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)
  - formula
```
public Param<String> formula()
```
    R formula parameter. The formula is provided in string form.
    
    Returns:
    
    (undocumented)
  - getFormula
```
public String getFormula()
```
  - forceIndexLabel
```
public BooleanParam forceIndexLabel()
```
    Force to index label whether it is numeric or string type. Usually we index label only when it is string type. If the formula was used by classification algorithms, we can force to index label even it is numeric type by setting this param with true. Default: false.
    
    Returns:
    
    (undocumented)
  - getForceIndexLabel
```
public boolean getForceIndexLabel()
```
  - handleInvalid
```
public Param<String> handleInvalid()
```
    Param for how to handle invalid data (unseen or NULL values) in features and label column of string type. 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"
    
    Specified by:
    
    handleInvalid in interface HasHandleInvalid
    
    Returns:
    
    (undocumented)
  - stringIndexerOrderType
```
public Param<String> stringIndexerOrderType()
```
    Param for how to order categories of a string FEATURE column used by StringIndexer. The last category after ordering is dropped when encoding strings. Supported options: 'frequencyDesc', 'frequencyAsc', 'alphabetDesc', 'alphabetAsc'. The default value is 'frequencyDesc'. When the ordering is set to 'alphabetDesc', RFormula drops the same category as R when encoding strings.
    The options are explained using an example 'b', 'a', 'b', 'a', 'c', 'b':
```
 +-----------------+---------------------------------------+----------------------------------+
 |      Option     | Category mapped to 0 by StringIndexer |  Category dropped by RFormula    |
 +-----------------+---------------------------------------+----------------------------------+
 | 'frequencyDesc' | most frequent category ('b')          | least frequent category ('c')    |
 | 'frequencyAsc'  | least frequent category ('c')         | most frequent category ('b')     |
 | 'alphabetDesc'  | last alphabetical category ('c')      | first alphabetical category ('a')|
 | 'alphabetAsc'   | first alphabetical category ('a')     | last alphabetical category ('c') |
 +-----------------+---------------------------------------+----------------------------------+
 
```
    Note that this ordering option is NOT used for the label column. When the label column is indexed, it uses the default descending frequency ordering in StringIndexer.
    Returns:
    
    (undocumented)
  - getStringIndexerOrderType
```
public String getStringIndexerOrderType()
```
  - hasLabelCol
```
public boolean hasLabelCol(StructType schema)
```

Class RFormulaModel

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.param.shared.HasFeaturesCol

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

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

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

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

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

Method Detail

read

load

params

explainParam

explainParams

isSet

isDefined

hasParam

getParam

set

get

clear

getOrDefault

getDefault

hasDefault

extractParamMap

extractParamMap

parent

parent_$eq

setParent

hasParent

featuresCol

getFeaturesCol

labelCol

getLabelCol

getHandleInvalid

formula

getFormula

forceIndexLabel

getForceIndexLabel

handleInvalid

stringIndexerOrderType

getStringIndexerOrderType

save

uid

transform

transformSchema

copy

toString

write

formula

getFormula

forceIndexLabel

getForceIndexLabel

handleInvalid

stringIndexerOrderType

getStringIndexerOrderType

hasLabelCol