org.apache.spark.ml.classification
An alias for getOrDefault().
An alias for getOrDefault().
If false, the algorithm will pass trees to executors to match instances with nodes.
If false, the algorithm will pass trees to executors to match instances with nodes. If true, the algorithm will cache node IDs for each instance. Caching can speed up training of deeper trees. (default = false)
Specifies how often to checkpoint the cached node IDs.
Specifies how often to checkpoint the cached node IDs. E.g. 10 means that the cache will get checkpointed every 10 iterations. This is only used if cacheNodeIds is true and if the checkpoint directory is set in org.apache.spark.SparkContext. Must be >= 1. (default = 10)
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
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()
Extract labelCol and featuresCol from the given dataset, and put it in an RDD with strong types.
Extract labelCol and featuresCol from the given dataset, and put it in an RDD with strong types.
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.
The number of features to consider for splits at each tree node.
The number of features to consider for splits at each tree node. Supported options:
These various settings are based on the following references:
Param for features column name.
Param for features column name.
Fits a model to the input data.
Fits multiple models to the input data with multiple sets of parameters.
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.
input dataset
An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap.
fitted models, matching the input parameter maps
Fits a single model to the input data with provided parameter map.
Fits a single model to the input data with provided parameter map.
input dataset
Parameter map. These values override any specified in this Estimator's embedded ParamMap.
fitted model
Fits a single model to the input data with optional parameters.
Fits a single model to the input data with optional parameters.
input dataset
the first param pair, overrides embedded params
other param pairs. These values override any specified in this Estimator's embedded ParamMap.
fitted model
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.
Criterion used for information gain calculation (case-insensitive).
Criterion used for information gain calculation (case-insensitive). Supported: "entropy" and "gini". (default = gini)
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.
Maximum number of bins used for discretizing continuous features and for choosing how to split on features at each node.
Maximum number of bins used for discretizing continuous features and for choosing how to split on features at each node. More bins give higher granularity. Must be >= 2 and >= number of categories in any categorical feature. (default = 32)
Maximum depth of the tree (>= 0).
Maximum depth of the tree (>= 0). E.g., depth 0 means 1 leaf node; depth 1 means 1 internal node + 2 leaf nodes. (default = 5)
Maximum memory in MB allocated to histogram aggregation.
Maximum memory in MB allocated to histogram aggregation. (default = 256 MB)
Minimum information gain for a split to be considered at a tree node.
Minimum information gain for a split to be considered at a tree node. (default = 0.0)
Minimum number of instances each child must have after split.
Minimum number of instances each child must have after split. If a split causes the left or right child to have fewer than minInstancesPerNode, the split will be discarded as invalid. Should be >= 1. (default = 1)
Number of trees to train (>= 1).
Number of trees to train (>= 1). If 1, then no bootstrapping is used. If > 1, then bootstrapping is done. TODO: Change to always do bootstrapping (simpler). SPARK-7130 (default = 20)
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.
Param for prediction column name.
Param for prediction column name.
Param for random seed.
Param for random seed.
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
Fraction of the training data used for learning each decision tree, in range (0, 1].
Fraction of the training data used for learning each decision tree, in range (0, 1]. (default = 1.0)
Train a model using the given dataset and parameters.
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.
Training dataset
Fitted model
:: 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.
A list of advanced, expert-only (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.
:: Experimental :: Random Forest learning algorithm for classification. It supports both binary and multiclass labels, as well as both continuous and categorical features.