An alias for getOrDefault().

Clears the user-supplied value for the input param.

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().

Copies param values from this instance to another instance for params shared by them.

This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

Explains a param.

Explains all params of this instance. See explainParam().

extractParamMap with no extra 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 less than user-supplied values less than extra.

Param for features column name.

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.

R formula parameter. The formula is provided in string form.

Optionally returns the user-supplied value of a param.

Gets the default value of a parameter.

Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

Gets a param by its name.

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"

Tests whether the input param has a default value set.

Tests whether this instance contains a param with a given name.

Indicates whether this Model has a corresponding parent.

Checks whether a param is explicitly set or has a default value.

Checks whether a param is explicitly set.

Param for label column name.

Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

The parent estimator that produced this model.

Saves this ML instance to the input path, a shortcut of write.save(path).

Sets a parameter in the embedded param map.

Sets a parameter (by name) in the embedded param map.

Sets a parameter in the embedded param map.

Sets default values for a list of params.

Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

Sets a default value for a param.

Sets the parent of this model (Java API).

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.

Transforms the input dataset.

Transforms the dataset with provided parameter map as additional parameters.

Transforms the dataset with optional parameters

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.

Derives the output schema from the input schema and parameters, optionally with logging.

This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

An immutable unique ID for the object and its derivatives.

Returns an MLWriter instance for this ML instance.