Class: Rumale::Ensemble::ExtraTreesClassifier

Inherits:
RandomForestClassifier show all
Defined in:
lib/rumale/ensemble/extra_trees_classifier.rb

Overview

ExtraTreesClassifier is a class that implements extremely randomized trees for classification. The algorithm of extremely randomized trees is similar to random forest. The features of the algorithm of extremely randomized trees are not to apply the bagging procedure and to randomly select the threshold for splitting feature space.

Reference

    1. Geurts, D. Ernst, and L. Wehenkel, “Extremely randomized trees,” Machine Learning, vol. 63 (1), pp. 3–42, 2006.

Examples:

estimator =
  Rumale::Ensemble::ExtraTreesClassifier.new(
    n_estimators: 10, criterion: 'gini', max_depth: 3, max_leaf_nodes: 10, min_samples_leaf: 5, random_seed: 1)
estimator.fit(training_samples, traininig_labels)
results = estimator.predict(testing_samples)

Instance Attribute Summary collapse

Attributes included from Base::BaseEstimator

#params

Instance Method Summary collapse

Methods included from Base::Classifier

#score

Constructor Details

#initialize(n_estimators: 10, criterion: 'gini', max_depth: nil, max_leaf_nodes: nil, min_samples_leaf: 1, max_features: nil, n_jobs: nil, random_seed: nil) ⇒ ExtraTreesClassifier

Create a new classifier with extremely randomized trees.

Parameters:

  • n_estimators (Integer) (defaults to: 10) —

    The numeber of trees for contructing extremely randomized trees.

  • criterion (String) (defaults to: 'gini') —

    The function to evalue spliting point. Supported criteria are ‘gini’ and ‘entropy’.

  • max_depth (Integer) (defaults to: nil) —

    The maximum depth of the tree. If nil is given, extra tree grows without concern for depth.

  • max_leaf_nodes (Integer) (defaults to: nil) —

    The maximum number of leaves on extra tree. If nil is given, number of leaves is not limited.

  • min_samples_leaf (Integer) (defaults to: 1) —

    The minimum number of samples at a leaf node.

  • max_features (Integer) (defaults to: nil) —

    The number of features to consider when searching optimal split point. If nil is given, split process considers all features.

  • n_jobs (Integer) (defaults to: nil) —

    The number of jobs for running the fit method in parallel. If nil is given, the method does not execute in parallel. If zero or less is given, it becomes equal to the number of processors. This parameter is ignored if the Parallel gem is not loaded.

  • random_seed (Integer) (defaults to: nil) —

    The seed value using to initialize the random generator. It is used to randomly determine the order of features when deciding spliting point.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 56

def initialize(n_estimators: 10,
               criterion: 'gini', max_depth: nil, max_leaf_nodes: nil, min_samples_leaf: 1,
               max_features: nil, n_jobs: nil, random_seed: nil)
  check_params_type_or_nil(Integer, max_depth: max_depth, max_leaf_nodes: max_leaf_nodes,
                                    max_features: max_features, n_jobs: n_jobs, random_seed: random_seed)
  check_params_integer(n_estimators: n_estimators, min_samples_leaf: min_samples_leaf)
  check_params_string(criterion: criterion)
  check_params_positive(n_estimators: n_estimators, max_depth: max_depth,
                        max_leaf_nodes: max_leaf_nodes, min_samples_leaf: min_samples_leaf,
                        max_features: max_features)
  super
end

Instance Attribute Details

#classes ⇒ Numo::Int32 (readonly)

Return the class labels.

Returns:

  • (Numo::Int32) —

    (size: n_classes)



29
30
31
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 29

def classes
  @classes
end

#estimators ⇒ Array<ExtraTreeClassifier> (readonly)

Return the set of estimators.

Returns:

  • (Array<ExtraTreeClassifier>) 


25
26
27
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 25

def estimators
  @estimators
end

#feature_importances ⇒ Numo::DFloat (readonly)

Return the importance for each feature.

Returns:

  • (Numo::DFloat) —

    (size: n_features)



33
34
35
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 33

def feature_importances
  @feature_importances
end

#rng ⇒ Random (readonly)

Return the random generator for random selection of feature index.

Returns:

  • (Random) 


37
38
39
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 37

def rng
  @rng
end

Instance Method Details

#apply(x) ⇒ Numo::Int32

Return the index of the leaf that each sample reached.

Parameters:

  • x (Numo::DFloat) —

    (shape: [n_samples, n_features]) The samples to predict the labels.

Returns:

  • (Numo::Int32) —

    (shape: [n_samples, n_estimators]) Leaf index for sample.



123
124
125
126
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 123

def apply(x)
  check_sample_array(x)
  super
end

#fit(x, y) ⇒ ExtraTreesClassifier

Fit the model with given training data.

Parameters:

  • x (Numo::DFloat) —

    (shape: [n_samples, n_features]) The training data to be used for fitting the model.

  • y (Numo::Int32) —

    (shape: [n_samples]) The labels to be used for fitting the model.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 74

def fit(x, y)
  check_sample_array(x)
  check_label_array(y)
  check_sample_label_size(x, y)
  # Initialize some variables.
  n_features = x.shape[1]
  @params[:max_features] = Math.sqrt(n_features).to_i unless @params[:max_features].is_a?(Integer)
  @params[:max_features] = [[1, @params[:max_features]].max, n_features].min
  @classes = Numo::Int32.asarray(y.to_a.uniq.sort)
  sub_rng = @rng.dup
  # Construct trees.
  rng_seeds = Array.new(@params[:n_estimators]) { sub_rng.rand(Rumale::Values.int_max) }
  @estimators = if enable_parallel?
                  parallel_map(@params[:n_estimators]) { |n| plant_tree(rng_seeds[n]).fit(x, y) }
                else
                  Array.new(@params[:n_estimators]) { |n| plant_tree(rng_seeds[n]).fit(x, y) }
                end
  @feature_importances =
    if enable_parallel?
      parallel_map(@params[:n_estimators]) { |n| @estimators[n].feature_importances }.reduce(&:+)
    else
      @estimators.map(&:feature_importances).reduce(&:+)
    end
  @feature_importances /= @feature_importances.sum
  self
end

#marshal_dump ⇒ Hash

Dump marshal data.

Returns:

  • (Hash) —

    The marshal data about ExtraTreesClassifier.



130
131
132
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 130

def marshal_dump
  super
end

#marshal_load(obj) ⇒ nil

Load marshal data.

Returns:

  • (nil) 


136
137
138
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 136

def marshal_load(obj)
  super
end

#predict(x) ⇒ Numo::Int32

Predict class labels for samples.

Parameters:

  • x (Numo::DFloat) —

    (shape: [n_samples, n_features]) The samples to predict the labels.

Returns:

  • (Numo::Int32) —

    (shape: [n_samples]) Predicted class label per sample.



105
106
107
108
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 105

def predict(x)
  check_sample_array(x)
  super
end

#predict_proba(x) ⇒ Numo::DFloat

Predict probability for samples.

Parameters:

  • x (Numo::DFloat) —

    (shape: [n_samples, n_features]) The samples to predict the probailities.

Returns:

  • (Numo::DFloat) —

    (shape: [n_samples, n_classes]) Predicted probability of each class per sample.



114
115
116
117
 
# File 'lib/rumale/ensemble/extra_trees_classifier.rb', line 114

def predict_proba(x)
  check_sample_array(x)
  super
end