org.apache.spark.ml.param

Interface Params

All Superinterfaces:

Identifiable, java.io.Serializable

All Known Subinterfaces:

ALSParams, ClassifierParams, CrossValidatorParams, HasFeaturesCol, HasInputCol, HasLabelCol, HasMaxIter, HasOutputCol, HasPredictionCol, HasProbabilityCol, HasRawPredictionCol, HasRegParam, HasThreshold, LinearRegressionParams, LogisticRegressionParams, PredictorParams, ProbabilisticClassifierParams, RegressorParams, StandardScalerParams

All Known Implementing Classes:

ALS, ALSModel, BinaryClassificationEvaluator, ClassificationModel, Classifier, CrossValidator, CrossValidatorModel, Estimator, HashingTF, LinearRegression, LinearRegressionModel, LogisticRegression, LogisticRegressionModel, Model, Pipeline, PipelineModel, PredictionModel, Predictor, ProbabilisticClassificationModel, ProbabilisticClassifier, RegressionModel, Regressor, StandardScaler, StandardScalerModel, Tokenizer, Transformer, UnaryTransformer

public interface Params
extends Identifiable, scala.Serializable

:: AlphaComponent :: Trait for components that take parameters. This also provides an internal param map to store parameter values attached to the instance.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.spark.sql.types.StructType	addOutputColumn(org.apache.spark.sql.types.StructType schema, String colName, org.apache.spark.sql.types.DataType dataType)
void	checkInputColumn(org.apache.spark.sql.types.StructType schema, String colName, org.apache.spark.sql.types.DataType dataType) Check whether the given schema contains an input column.
String	explainParams() Returns the documentation of all params.
<T> T	get(Param<T> param) Gets the value of a parameter in the embedded param map.
Param<Object>	getParam(String paramName) Gets a param by its name.
boolean	isSet(Param<?> param) Checks whether a param is explicitly set.
ParamMap	paramMap() Internal param map.
Param<?>[]	params() Returns all params.
<T> Params	set(Param<T> param, T value) Sets a parameter in the embedded param map.
Params	set(String param, Object value) Sets a parameter (by name) in the embedded param map.
void	validate() Validates parameter values stored internally.
void	validate(ParamMap paramMap) Validates parameter values stored internally plus the input parameter map.

Methods inherited from interface org.apache.spark.ml.Identifiable

uid

Method Detail

params

Param<?>[] params()

Returns all params.

validate

void validate(ParamMap paramMap)

Validates parameter values stored internally plus the input parameter map. Raises an exception if any parameter is invalid.

validate

void validate()

Validates parameter values stored internally. Raise an exception if any parameter value is invalid.

explainParams

String explainParams()

Returns the documentation of all params.

isSet

boolean isSet(Param<?> param)

Checks whether a param is explicitly set.

getParam

Param<Object> getParam(String paramName)

Gets a param by its name.

set

<T> Params set(Param<T> param,
             T value)

Sets a parameter in the embedded param map.

set

Params set(String param,
         Object value)

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

get

<T> T get(Param<T> param)

Gets the value of a parameter in the embedded param map.

paramMap

ParamMap paramMap()

Internal param map.

checkInputColumn

void checkInputColumn(org.apache.spark.sql.types.StructType schema,
                    String colName,
                    org.apache.spark.sql.types.DataType dataType)

Check whether the given schema contains an input column.

Parameters:

colName - Parameter name for the input column.

dataType - SQL DataType of the input column.

addOutputColumn

org.apache.spark.sql.types.StructType addOutputColumn(org.apache.spark.sql.types.StructType schema,
                                                    String colName,
                                                    org.apache.spark.sql.types.DataType dataType)