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. The default implementation tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance. Subclasses should override this method if the default approach is not sufficient.
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.
the target instance
extra params to be copied
the target instance with param values copied
Param for the ElasticNet mixing parameter, in range [0, 1].
Param for the ElasticNet mixing parameter, in range [0, 1]. For alpha = 0, the penalty is an L2 penalty. For alpha = 1, it is an L1 penalty..
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.
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.
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 < user-supplied values < extra.
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.
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.
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 maximum number of iterations (>= 0).
Param for maximum number of iterations (>= 0).
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.
Note: 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. Note: 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).
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.
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 parent of this model (Java API).
Sets the parent of this model (Java API).
Param for the convergence tolerance for iterative algorithms.
Param for the convergence tolerance for iterative algorithms.
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 ::
Derives the output schema from the input schema.
:: 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
Validates parameter values stored internally.
Validates parameter values stored internally. Raise an exception if any parameter value is invalid.
This only needs to check for interactions between parameters. Parameter value checks which do not depend on other parameters are handled by Param.validate(). This method does not handle input/output column parameters; those are checked during schema validation.
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 LinearRegression.