RandomForest (Smile Core 1.0.4 API)

java.lang.Object
- smile.regression.RandomForest

All Implemented Interfaces:

Regression<double[]>
```
public class RandomForest
extends Object
implements Regression<double[]>
```
Random forest for regression. Random forest is an ensemble method that consists of many regression trees and outputs the average of individual trees. The method combines bagging idea and the random selection of features.
Each tree is constructed using the following algorithm:
1. If the number of cases in the training set is N, randomly sample N cases with replacement from the original data. This sample will be the training set for growing the tree.
2. If there are M input variables, a number m << M is specified such that at each node, m variables are selected at random out of the M and the best split on these m is used to split the node. The value of m is held constant during the forest growing.
3. Each tree is grown to the largest extent possible. There is no pruning.
The advantages of random forest are:
- For many data sets, it produces a highly accurate model.
- It runs efficiently on large data sets.
- It can handle thousands of input variables without variable deletion.
- It gives estimates of what variables are important in the classification.
- It generates an internal unbiased estimate of the generalization error as the forest building progresses.
- It has an effective method for estimating missing data and maintains accuracy when a large proportion of the data are missing.
The disadvantages are
- Random forests are prone to over-fitting for some datasets. This is even more pronounced in noisy classification/regression tasks.
- For data including categorical variables with different number of levels, random forests are biased in favor of those attributes with more levels. Therefore, the variable importance scores from random forest are not reliable for this type of data.
Author:

Haifeng Li

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RandomForest.Trainer
Trainer for random forest.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RandomForest.Trainer` Trainer for random forest.

Constructor Summary

Constructors
Constructor and Description
`RandomForest(Attribute[] attributes, double[][] x, double[] y, int T)` Constructor.
`RandomForest(Attribute[] attributes, double[][] x, double[] y, int T, int M, int S)` Constructor.
`RandomForest(double[][] x, double[] y, int T)` Constructor.
`RandomForest(double[][] x, double[] y, int T, int M, int S)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`error()` Returns the out-of-bag estimation of RMSE.
`double[]`	`importance()` Returns the variable importance.
`double`	`predict(double[] x)` Predicts the dependent variable of an instance.
`int`	`size()` Returns the number of trees in the model.
`double[]`	`test(double[][] x, double[] y)` Test the model on a validation dataset.
`double[][]`	`test(double[][] x, double[] y, RegressionMeasure[] measures)` Test the model on a validation dataset.
`void`	`trim(int T)` Trims the tree model set to a smaller size in case of over-fitting.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RandomForest
```
public RandomForest(double[][] x,
                    double[] y,
                    int T)
```
    Constructor. Learns a random forest for regression.
    
    Parameters:
    
    x - the training instances.
    
    y - the response variable.
    
    T - the number of trees.
  - RandomForest
```
public RandomForest(double[][] x,
                    double[] y,
                    int T,
                    int M,
                    int S)
```
    Constructor. Learns a random forest for regression.
    
    Parameters:
    
    x - the training instances.
    
    y - the response variable.
    
    T - the number of trees.
    
    M - the number of input variables to be used to determine the decision at a node of the tree. dim/3 seems to give generally good performance, where dim is the number of variables.
    
    S - the number of instances in a node below which the tree will not split, setting S = 5 generally gives good results.
  - RandomForest
```
public RandomForest(Attribute[] attributes,
                    double[][] x,
                    double[] y,
                    int T)
```
    Constructor. Learns a random forest for regression.
    
    Parameters:
    
    attributes - the attribute properties.
    
    x - the training instances.
    
    y - the response variable.
    
    T - the number of trees.
  - RandomForest
```
public RandomForest(Attribute[] attributes,
                    double[][] x,
                    double[] y,
                    int T,
                    int M,
                    int S)
```
    Constructor. Learns a random forest for regression.
    
    Parameters:
    
    attributes - the attribute properties.
    
    x - the training instances.
    
    y - the response variable.
    
    T - the number of trees.
    
    M - the number of input variables to be used to determine the decision at a node of the tree. dim/3 seems to give generally good performance, where dim is the number of variables.
    
    S - the number of instances in a node below which the tree will not split, setting S = 5 generally gives good results.
- Method Detail
  - error
```
public double error()
```
    Returns the out-of-bag estimation of RMSE. The OOB estimate is quite accurate given that enough trees have been grown. Otherwise the OOB estimate can bias upward.
    
    Returns:
    
    the out-of-bag estimation of RMSE
  - importance
```
public double[] importance()
```
    Returns the variable importance. Every time a split of a node is made on variable the impurity criterion for the two descendent nodes is less than the parent node. Adding up the decreases for each individual variable over all trees in the forest gives a fast measure of variable importance that is often very consistent with the permutation importance measure.
    
    Returns:
    
    the variable importance
  - size
```
public int size()
```
    Returns the number of trees in the model.
    
    Returns:
    
    the number of trees in the model
  - trim
```
public void trim(int T)
```
    Trims the tree model set to a smaller size in case of over-fitting. Or if extra decision trees in the model don't improve the performance, we may remove them to reduce the model size and also improve the speed of prediction.
    
    Parameters:
    
    T - the new (smaller) size of tree model set.
  - predict
```
public double predict(double[] x)
```
    Description copied from interface: Regression
    
    Predicts the dependent variable of an instance.
    
    Specified by:
    
    predict in interface Regression<double[]>
    
    Parameters:
    
    x - the instance.
    
    Returns:
    
    the predicted value of dependent variable.
  - test
```
public double[] test(double[][] x,
                     double[] y)
```
    Test the model on a validation dataset.
    
    Parameters:
    
    x - the test data set.
    
    y - the test data response values.
    
    Returns:
    
    RMSEs with first 1, 2, ..., regression trees.
  - test
```
public double[][] test(double[][] x,
                       double[] y,
                       RegressionMeasure[] measures)
```
    Test the model on a validation dataset.
    
    Parameters:
    
    x - the test data set.
    
    y - the test data labels.
    
    measures - the performance measures of regression.
    
    Returns:
    
    performance measures with first 1, 2, ..., regression trees.

Class RandomForest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RandomForest

RandomForest

RandomForest

RandomForest

Method Detail

error

importance

size

trim

predict

test

test