org.apache.spark.ml.regression
An alias for getOrDefault().
An alias for getOrDefault().
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
Creates a copy of this instance with the same UID and some extra 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().
Copies param values from this instance to another instance for params shared by them.
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.
the target instance, which should work with the same set of default Params as this source instance
extra params to be copied to the target's paramMap
the target instance with param values copied
Default implementation of copy with extra 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.
Evaluate the model on the given dataset, returning a summary of the results.
Evaluate the model on the given dataset, returning a summary of the results.
Explains a param.
Explains a param.
input param, must belong to this instance.
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
Explains all params of this instance.
Explains all params of this instance. See explainParam().
extractParamMap with no extra values.
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.
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.
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" and "gamma". Default is "gaussian".
Param for features column name.
Param for features column name.
Returns the SQL DataType corresponding to the FeaturesType type parameter.
Returns the SQL DataType corresponding to the FeaturesType type parameter.
This is used by validateAndTransformSchema(). This workaround is needed since SQL has different APIs for Scala and Java.
The default value is VectorUDT, but it may be overridden if FeaturesType is not Vector.
Param for whether to fit an intercept term.
Param for whether to fit an intercept term.
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
Gets the default value of a parameter.
Gets the default value of a parameter.
Gets the value of a param in the embedded param map or its default value.
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.
Gets a param by its name.
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
Indicates whether this Model has a corresponding parent.
Indicates if summary is available.
Indicates if summary is available.
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
Param for label column name.
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.
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".
Param for link prediction (linear predictor) column name.
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 maximum number of iterations (>= 0).
Returns the number of features the model was trained on.
Returns the number of features the model was trained on. If unknown, returns -1
Returns all params sorted by their names.
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.
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
The parent estimator that produced this model.
The parent estimator that produced this model.
For ensembles' component Models, this value can be null.
Predict label for the given features.
Predict label for the given features. This internal method is used to implement transform() and output predictionCol.
Param for prediction column name.
Param for prediction column name.
Param for regularization parameter (>= 0).
Param for regularization parameter (>= 0).
Saves this ML instance to the input path, a shortcut of write.save(path).
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 in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
Sets default values for a list of params.
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.
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.
Sets a default value for a param.
Sets a default value for a param.
param to set the default value. Make sure that this param is initialized before this method gets called.
the default value
Sets the link prediction (linear predictor) column name.
Sets the link prediction (linear predictor) column name.
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
Param for the solver algorithm for optimization.
Param for the solver algorithm for optimization. If this is not set or empty, default value is 'auto'.
Gets R-like summary of model on training set.
Gets R-like summary of model on training set. An exception is thrown if there is no summary available.
Param for the convergence tolerance for iterative algorithms (>= 0).
Param for the convergence tolerance for iterative algorithms (>= 0).
Transforms dataset by reading from featuresCol, calling predict, and storing
the predictions as a new column predictionCol.
Transforms dataset by reading from featuresCol, calling predict, and storing
the predictions as a new column predictionCol.
input dataset
transformed dataset with predictionCol of type Double
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
input dataset
additional parameters, overwrite embedded params
transformed dataset
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
input dataset
the first param pair, overwrite embedded params
other param pairs, overwrite embedded params
transformed dataset
:: DeveloperApi ::
:: 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.
:: DeveloperApi ::
:: 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.
An immutable unique ID for the object and its derivatives.
Validates and transforms the input schema with the provided param map.
Validates and transforms the input schema with the provided param map.
input schema
whether this is in fitting
SQL DataType for FeaturesType. E.g., org.apache.spark.mllib.linalg.VectorUDT for vector features.
output schema
Param for weight column name.
Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.
Returns a org.apache.spark.ml.util.MLWriter instance for this ML instance.
Returns a org.apache.spark.ml.util.MLWriter instance for this ML instance.
For GeneralizedLinearRegressionModel, this does NOT currently save the training summary. An option to save summary may be added in the future.
A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.
:: Experimental :: Model produced by GeneralizedLinearRegression.