An alias for getOrDefault().

Param for suggested depth for treeAggregate (>= 2).

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.

For ml connect only. Estimate an upper-bound size of the model to be fitted in bytes, based on the parameters and the dataset, e.g., using $(k) and numFeatures to estimate a k-means model size. 1, Both driver side memory usage and distributed objects size (like DataFrame, RDD, Graph, Summary) are counted. 2, Lazy vals are not counted, e.g., an auxiliary object used in prediction. 3, If there is no enough information to get an accurate size, try to estimate the upper-bound size, e.g.

• Given a LogisticRegression estimator, assume the coefficients are dense, even though the actual fitted model might be sparse (by L1 penalty).
• Given a tree model, assume all underlying trees are complete binary trees, even though some branches might be pruned or truncated. 4, For some model such as tree model, estimating model size before training is hard, the estimateModelSize method is not supported.

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 the name of family which is a description of the error distribution to be used in the model. Supported options: "gaussian", "binomial", "poisson", "gamma" and "tweedie". Default is "gaussian".

Param for features column name.

Fits a model to the input data.

Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could override this to optimize multi-model training.

Fits a single model to the input data with provided parameter map.

Fits a single model to the input data with optional parameters.

Param for whether to fit an intercept term.

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.

Tests whether the input param has a default value set.

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

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

Checks whether a param is explicitly set.

Param for label column name.

Param for the name of link function which provides the relationship between the linear predictor and the mean of the distribution function. Supported options: "identity", "log", "inverse", "logit", "probit", "cloglog" and "sqrt". This is used only when family is not "tweedie". The link function for the "tweedie" family must be specified through linkPower.

Param for the index in the power link function. Only applicable to the Tweedie family. Note that link power 0, 1, -1 or 0.5 corresponds to the Log, Identity, Inverse or Sqrt link, respectively. When not set, this value defaults to 1 - variancePower, which matches the R "statmod" package.

Param for link prediction (linear predictor) column name. Default is not set, which means we do not output link prediction.

Param for maximum number of iterations (>= 0).

Param for offset column name. If this is not set or empty, we treat all instance offsets as 0.0. The feature specified as offset has a constant coefficient of 1.0.

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.

Param for prediction column name.

Param for regularization parameter (>= 0).

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 value of param family. Default is "gaussian".

Sets if we should fit the intercept. Default is true.

Sets the value of param link. Used only when family is not "tweedie".

Sets the value of param linkPower. Used only when family is "tweedie".

Sets the link prediction (linear predictor) column name.

Sets the maximum number of iterations (applicable for solver "irls"). Default is 25.

Sets the value of param offsetCol. If this is not set or empty, we treat all instance offsets as 0.0. Default is not set, so all instances have offset 0.0.

Sets the regularization parameter for L2 regularization. The regularization term is

$$ 0.5 * regParam * L2norm(coefficients)^2 $$

Sets the solver algorithm used for optimization. Currently only supports "irls" which is also the default solver.

Sets the convergence tolerance of iterations. Smaller value will lead to higher accuracy with the cost of more iterations. Default is 1E-6.

Sets the value of param variancePower. Used only when family is "tweedie". Default is 0.0, which corresponds to the "gaussian" family.

Sets the value of param weightCol. If this is not set or empty, we treat all instance weights as 1.0. Default is not set, so all instances have weight one. In the Binomial family, weights correspond to number of trials and should be integer. Non-integer weights are rounded to integer in AIC calculation.

The solver algorithm for optimization. Supported options: "irls" (iteratively reweighted least squares). Default: "irls"

Param for the convergence tolerance for iterative algorithms (>= 0).

Train a model using the given dataset and parameters. Developers can implement this instead of fit() to avoid dealing with schema validation and copying parameters into the model.

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.

:: DeveloperApi ::

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.

Validates and transforms the input schema with the provided param map.

Param for the power in the variance function of the Tweedie distribution which provides the relationship between the variance and mean of the distribution. Only applicable to the Tweedie family. (see Tweedie Distribution (Wikipedia)) Supported values: 0 and [1, Inf). Note that variance power 0, 1, or 2 corresponds to the Gaussian, Poisson or Gamma family, respectively.

Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.

Returns an MLWriter instance for this ML instance.