serial_tree_learner.cpp 34.8 KB
Newer Older
1
2
3
4
/*!
 * Copyright (c) 2016 Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
Guolin Ke's avatar
Guolin Ke committed
5
6
#include "serial_tree_learner.h"

7
8
#include <LightGBM/network.h>
#include <LightGBM/objective_function.h>
Guolin Ke's avatar
Guolin Ke committed
9
#include <LightGBM/utils/array_args.h>
10
#include <LightGBM/utils/common.h>
Guolin Ke's avatar
Guolin Ke committed
11

Guolin Ke's avatar
Guolin Ke committed
12
#include <algorithm>
13
#include <queue>
14
15
#include <unordered_map>
#include <utility>
Guolin Ke's avatar
Guolin Ke committed
16

17
18
#include "cost_effective_gradient_boosting.hpp"

Guolin Ke's avatar
Guolin Ke committed
19
20
namespace LightGBM {

Guolin Ke's avatar
Guolin Ke committed
21
22
23
SerialTreeLearner::SerialTreeLearner(const Config* config)
  :config_(config) {
  random_ = Random(config_->feature_fraction_seed);
Guolin Ke's avatar
Guolin Ke committed
24
25
26
27
28
}

SerialTreeLearner::~SerialTreeLearner() {
}

29
void SerialTreeLearner::Init(const Dataset* train_data, bool is_constant_hessian) {
Guolin Ke's avatar
Guolin Ke committed
30
31
32
  train_data_ = train_data;
  num_data_ = train_data_->num_data();
  num_features_ = train_data_->num_features();
33
  is_constant_hessian_ = is_constant_hessian;
34
35
  int max_cache_size = 0;
  // Get the max size of pool
Guolin Ke's avatar
Guolin Ke committed
36
37
  if (config_->histogram_pool_size <= 0) {
    max_cache_size = config_->num_leaves;
38
39
40
  } else {
    size_t total_histogram_size = 0;
    for (int i = 0; i < train_data_->num_features(); ++i) {
41
      total_histogram_size += kHistEntrySize * train_data_->FeatureNumBin(i);
42
    }
Guolin Ke's avatar
Guolin Ke committed
43
    max_cache_size = static_cast<int>(config_->histogram_pool_size * 1024 * 1024 / total_histogram_size);
44
45
  }
  // at least need 2 leaves
Guolin Ke's avatar
Guolin Ke committed
46
  max_cache_size = std::max(2, max_cache_size);
Guolin Ke's avatar
Guolin Ke committed
47
  max_cache_size = std::min(max_cache_size, config_->num_leaves);
Guolin Ke's avatar
Guolin Ke committed
48

Guolin Ke's avatar
Guolin Ke committed
49
  // push split information for all leaves
Guolin Ke's avatar
Guolin Ke committed
50
  best_split_per_leaf_.resize(config_->num_leaves);
51
  constraints_.reset(new LeafConstraints<ConstraintEntry>(config_->num_leaves));
Guolin Ke's avatar
Guolin Ke committed
52

wxchan's avatar
wxchan committed
53
  // initialize splits for leaf
Guolin Ke's avatar
Guolin Ke committed
54
55
  smaller_leaf_splits_.reset(new LeafSplits(train_data_->num_data()));
  larger_leaf_splits_.reset(new LeafSplits(train_data_->num_data()));
Guolin Ke's avatar
Guolin Ke committed
56
57

  // initialize data partition
Guolin Ke's avatar
Guolin Ke committed
58
  data_partition_.reset(new DataPartition(num_data_, config_->num_leaves));
Guolin Ke's avatar
Guolin Ke committed
59
  is_feature_used_.resize(num_features_);
60
  valid_feature_indices_ = train_data_->ValidFeatureIndices();
Guolin Ke's avatar
Guolin Ke committed
61
  // initialize ordered gradients and hessians
Guolin Ke's avatar
Guolin Ke committed
62
63
  ordered_gradients_.resize(num_data_);
  ordered_hessians_.resize(num_data_);
64
65
66
67

  GetMultiValBin(train_data_, true);

  histogram_pool_.DynamicChangeSize(train_data_, is_hist_colwise_, config_, max_cache_size, config_->num_leaves);
68
  Log::Info("Number of data points in the train set: %d, number of used features: %d", num_data_, num_features_);
69
70
71
  if (CostEfficientGradientBoosting::IsEnable(config_)) {
    cegb_.reset(new CostEfficientGradientBoosting(this));
    cegb_->Init();
72
  }
Guolin Ke's avatar
Guolin Ke committed
73
74
}

75
76
77
void SerialTreeLearner::GetMultiValBin(const Dataset* dataset, bool is_first_time) {
  if (is_first_time) {
    auto used_feature = GetUsedFeatures(true);
78
    temp_state_.reset(dataset->TestMultiThreadingMethod(
Nikita Titov's avatar
Nikita Titov committed
79
      ordered_gradients_.data(), ordered_hessians_.data(), used_feature,
80
81
82
      is_constant_hessian_, config_->force_col_wise, config_->force_row_wise, &is_hist_colwise_));
  } else {
    // cannot change is_hist_col_wise during training
83
    temp_state_.reset(dataset->TestMultiThreadingMethod(
Nikita Titov's avatar
Nikita Titov committed
84
      ordered_gradients_.data(), ordered_hessians_.data(), is_feature_used_,
85
86
87
88
      is_constant_hessian_, is_hist_colwise_, !is_hist_colwise_, &is_hist_colwise_));
  }
}

89
// Todo: optimized bagging for multi-val bin
Guolin Ke's avatar
Guolin Ke committed
90
91
92
void SerialTreeLearner::ResetTrainingData(const Dataset* train_data) {
  train_data_ = train_data;
  num_data_ = train_data_->num_data();
93
  CHECK_EQ(num_features_, train_data_->num_features());
Guolin Ke's avatar
Guolin Ke committed
94
95
96
97
98
99
100
101

  // initialize splits for leaf
  smaller_leaf_splits_->ResetNumData(num_data_);
  larger_leaf_splits_->ResetNumData(num_data_);

  // initialize data partition
  data_partition_->ResetNumData(num_data_);

102
103
  GetMultiValBin(train_data_, false);

Guolin Ke's avatar
Guolin Ke committed
104
105
106
  // initialize ordered gradients and hessians
  ordered_gradients_.resize(num_data_);
  ordered_hessians_.resize(num_data_);
107

108
109
110
  if (cegb_ != nullptr) {
    cegb_->Init();
  }
Guolin Ke's avatar
Guolin Ke committed
111
}
Guolin Ke's avatar
Guolin Ke committed
112

Guolin Ke's avatar
Guolin Ke committed
113
114
115
void SerialTreeLearner::ResetConfig(const Config* config) {
  if (config_->num_leaves != config->num_leaves) {
    config_ = config;
Guolin Ke's avatar
Guolin Ke committed
116
117
    int max_cache_size = 0;
    // Get the max size of pool
Guolin Ke's avatar
Guolin Ke committed
118
119
    if (config->histogram_pool_size <= 0) {
      max_cache_size = config_->num_leaves;
Guolin Ke's avatar
Guolin Ke committed
120
121
122
    } else {
      size_t total_histogram_size = 0;
      for (int i = 0; i < train_data_->num_features(); ++i) {
123
        total_histogram_size += kHistEntrySize * train_data_->FeatureNumBin(i);
Guolin Ke's avatar
Guolin Ke committed
124
      }
Guolin Ke's avatar
Guolin Ke committed
125
      max_cache_size = static_cast<int>(config_->histogram_pool_size * 1024 * 1024 / total_histogram_size);
Guolin Ke's avatar
Guolin Ke committed
126
127
128
    }
    // at least need 2 leaves
    max_cache_size = std::max(2, max_cache_size);
Guolin Ke's avatar
Guolin Ke committed
129
    max_cache_size = std::min(max_cache_size, config_->num_leaves);
130
    histogram_pool_.DynamicChangeSize(train_data_, is_hist_colwise_, config_, max_cache_size, config_->num_leaves);
Guolin Ke's avatar
Guolin Ke committed
131
132

    // push split information for all leaves
Guolin Ke's avatar
Guolin Ke committed
133
134
    best_split_per_leaf_.resize(config_->num_leaves);
    data_partition_->ResetLeaves(config_->num_leaves);
Guolin Ke's avatar
Guolin Ke committed
135
  } else {
Guolin Ke's avatar
Guolin Ke committed
136
    config_ = config;
Guolin Ke's avatar
Guolin Ke committed
137
  }
138
  histogram_pool_.ResetConfig(train_data_, config_);
139
140
141
142
  if (CostEfficientGradientBoosting::IsEnable(config_)) {
    cegb_.reset(new CostEfficientGradientBoosting(this));
    cegb_->Init();
  }
Guolin Ke's avatar
Guolin Ke committed
143
144
}

Guolin Ke's avatar
Guolin Ke committed
145
Tree* SerialTreeLearner::Train(const score_t* gradients, const score_t *hessians, bool is_constant_hessian, const Json& forced_split_json) {
146
  Common::FunctionTimer fun_timer("SerialTreeLearner::Train", global_timer);
Guolin Ke's avatar
Guolin Ke committed
147
148
  gradients_ = gradients;
  hessians_ = hessians;
149
  is_constant_hessian_ = is_constant_hessian;
150

Guolin Ke's avatar
Guolin Ke committed
151
152
  // some initial works before training
  BeforeTrain();
Guolin Ke's avatar
Guolin Ke committed
153

Guolin Ke's avatar
Guolin Ke committed
154
  auto tree = std::unique_ptr<Tree>(new Tree(config_->num_leaves));
Guolin Ke's avatar
Guolin Ke committed
155
156
  // root leaf
  int left_leaf = 0;
157
  int cur_depth = 1;
Guolin Ke's avatar
Guolin Ke committed
158
159
  // only root leaf can be splitted on first time
  int right_leaf = -1;
160
161
162
163
164
165
166
167

  int init_splits = 0;
  bool aborted_last_force_split = false;
  if (!forced_split_json.is_null()) {
    init_splits = ForceSplits(tree.get(), forced_split_json, &left_leaf,
                              &right_leaf, &cur_depth, &aborted_last_force_split);
  }

Guolin Ke's avatar
Guolin Ke committed
168
  for (int split = init_splits; split < config_->num_leaves - 1; ++split) {
Guolin Ke's avatar
Guolin Ke committed
169
    // some initial works before finding best split
170
    if (!aborted_last_force_split && BeforeFindBestSplit(tree.get(), left_leaf, right_leaf)) {
Guolin Ke's avatar
Guolin Ke committed
171
      // find best threshold for every feature
Guolin Ke's avatar
Guolin Ke committed
172
      FindBestSplits();
173
174
    } else if (aborted_last_force_split) {
      aborted_last_force_split = false;
Guolin Ke's avatar
Guolin Ke committed
175
    }
176

Guolin Ke's avatar
Guolin Ke committed
177
178
179
180
181
182
    // Get a leaf with max split gain
    int best_leaf = static_cast<int>(ArrayArgs<SplitInfo>::ArgMax(best_split_per_leaf_));
    // Get split information for best leaf
    const SplitInfo& best_leaf_SplitInfo = best_split_per_leaf_[best_leaf];
    // cannot split, quit
    if (best_leaf_SplitInfo.gain <= 0.0) {
Guolin Ke's avatar
Guolin Ke committed
183
      Log::Warning("No further splits with positive gain, best gain: %f", best_leaf_SplitInfo.gain);
Guolin Ke's avatar
Guolin Ke committed
184
185
186
      break;
    }
    // split tree with best leaf
Guolin Ke's avatar
Guolin Ke committed
187
    Split(tree.get(), best_leaf, &left_leaf, &right_leaf);
188
    cur_depth = std::max(cur_depth, tree->leaf_depth(left_leaf));
Guolin Ke's avatar
Guolin Ke committed
189
  }
190
  Log::Debug("Trained a tree with leaves = %d and max_depth = %d", tree->num_leaves(), cur_depth);
Guolin Ke's avatar
Guolin Ke committed
191
  return tree.release();
Guolin Ke's avatar
Guolin Ke committed
192
193
}

194
Tree* SerialTreeLearner::FitByExistingTree(const Tree* old_tree, const score_t* gradients, const score_t *hessians) const {
Guolin Ke's avatar
Guolin Ke committed
195
196
  auto tree = std::unique_ptr<Tree>(new Tree(*old_tree));
  CHECK(data_partition_->num_leaves() >= tree->num_leaves());
197
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
198
  #pragma omp parallel for schedule(static)
199
  for (int i = 0; i < tree->num_leaves(); ++i) {
200
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
201
202
203
    data_size_t cnt_leaf_data = 0;
    auto tmp_idx = data_partition_->GetIndexOnLeaf(i, &cnt_leaf_data);
    double sum_grad = 0.0f;
204
    double sum_hess = kEpsilon;
Guolin Ke's avatar
Guolin Ke committed
205
206
207
208
209
210
    for (data_size_t j = 0; j < cnt_leaf_data; ++j) {
      auto idx = tmp_idx[j];
      sum_grad += gradients[idx];
      sum_hess += hessians[idx];
    }
    double output = FeatureHistogram::CalculateSplittedLeafOutput(sum_grad, sum_hess,
Guolin Ke's avatar
Guolin Ke committed
211
                                                                  config_->lambda_l1, config_->lambda_l2, config_->max_delta_step);
Guolin Ke's avatar
Guolin Ke committed
212
213
214
    auto old_leaf_output = tree->LeafOutput(i);
    auto new_leaf_output = output * tree->shrinkage();
    tree->SetLeafOutput(i, config_->refit_decay_rate * old_leaf_output + (1.0 - config_->refit_decay_rate) * new_leaf_output);
215
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
216
  }
217
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
218
219
220
  return tree.release();
}

221
222
223
224
225
Tree* SerialTreeLearner::FitByExistingTree(const Tree* old_tree, const std::vector<int>& leaf_pred, const score_t* gradients, const score_t *hessians) {
  data_partition_->ResetByLeafPred(leaf_pred, old_tree->num_leaves());
  return FitByExistingTree(old_tree, gradients, hessians);
}

226
std::vector<int8_t> SerialTreeLearner::GetUsedFeatures(bool is_tree_level) {
227
  std::vector<int8_t> ret(num_features_, 1);
228
229
230
231
  if (config_->feature_fraction >= 1.0f && is_tree_level) {
    return ret;
  }
  if (config_->feature_fraction_bynode >= 1.0f && !is_tree_level) {
232
233
234
    return ret;
  }
  std::memset(ret.data(), 0, sizeof(int8_t) * num_features_);
235
  const int min_used_features = std::min(2, static_cast<int>(valid_feature_indices_.size()));
236
  if (is_tree_level) {
237
238
    int used_feature_cnt = static_cast<int>(std::round(valid_feature_indices_.size() * config_->feature_fraction));
    used_feature_cnt = std::max(used_feature_cnt, min_used_features);
239
240
241
242
243
244
    used_feature_indices_ = random_.Sample(static_cast<int>(valid_feature_indices_.size()), used_feature_cnt);
    int omp_loop_size = static_cast<int>(used_feature_indices_.size());
    #pragma omp parallel for schedule(static, 512) if (omp_loop_size >= 1024)
    for (int i = 0; i < omp_loop_size; ++i) {
      int used_feature = valid_feature_indices_[used_feature_indices_[i]];
      int inner_feature_index = train_data_->InnerFeatureIndex(used_feature);
245
      CHECK_GE(inner_feature_index, 0);
246
247
      ret[inner_feature_index] = 1;
    }
Guolin Ke's avatar
Guolin Ke committed
248
  } else if (used_feature_indices_.size() <= 0) {
249
250
    int used_feature_cnt = static_cast<int>(std::round(valid_feature_indices_.size() * config_->feature_fraction_bynode));
    used_feature_cnt = std::max(used_feature_cnt, min_used_features);
251
252
253
254
255
256
    auto sampled_indices = random_.Sample(static_cast<int>(valid_feature_indices_.size()), used_feature_cnt);
    int omp_loop_size = static_cast<int>(sampled_indices.size());
    #pragma omp parallel for schedule(static, 512) if (omp_loop_size >= 1024)
    for (int i = 0; i < omp_loop_size; ++i) {
      int used_feature = valid_feature_indices_[sampled_indices[i]];
      int inner_feature_index = train_data_->InnerFeatureIndex(used_feature);
257
      CHECK_GE(inner_feature_index, 0);
258
259
260
      ret[inner_feature_index] = 1;
    }
  } else {
261
262
    int used_feature_cnt = static_cast<int>(std::round(used_feature_indices_.size() * config_->feature_fraction_bynode));
    used_feature_cnt = std::max(used_feature_cnt, min_used_features);
263
264
265
266
267
268
    auto sampled_indices = random_.Sample(static_cast<int>(used_feature_indices_.size()), used_feature_cnt);
    int omp_loop_size = static_cast<int>(sampled_indices.size());
    #pragma omp parallel for schedule(static, 512) if (omp_loop_size >= 1024)
    for (int i = 0; i < omp_loop_size; ++i) {
      int used_feature = valid_feature_indices_[used_feature_indices_[sampled_indices[i]]];
      int inner_feature_index = train_data_->InnerFeatureIndex(used_feature);
269
      CHECK_GE(inner_feature_index, 0);
270
271
      ret[inner_feature_index] = 1;
    }
272
273
274
275
  }
  return ret;
}

Guolin Ke's avatar
Guolin Ke committed
276
void SerialTreeLearner::BeforeTrain() {
277
  Common::FunctionTimer fun_timer("SerialTreeLearner::BeforeTrain", global_timer);
278
279
  // reset histogram pool
  histogram_pool_.ResetMap();
Guolin Ke's avatar
Guolin Ke committed
280

281
282
  if (config_->feature_fraction < 1.0f) {
    is_feature_used_ = GetUsedFeatures(true);
Guolin Ke's avatar
Guolin Ke committed
283
  } else {
Guolin Ke's avatar
Guolin Ke committed
284
    #pragma omp parallel for schedule(static, 512) if (num_features_ >= 1024)
Guolin Ke's avatar
Guolin Ke committed
285
286
287
    for (int i = 0; i < num_features_; ++i) {
      is_feature_used_[i] = 1;
    }
Guolin Ke's avatar
Guolin Ke committed
288
  }
289
  train_data_->InitTrain(is_feature_used_, is_hist_colwise_, temp_state_.get());
Guolin Ke's avatar
Guolin Ke committed
290
291
292
  // initialize data partition
  data_partition_->Init();

293
294
  constraints_->Reset();

Guolin Ke's avatar
Guolin Ke committed
295
  // reset the splits for leaves
Guolin Ke's avatar
Guolin Ke committed
296
  for (int i = 0; i < config_->num_leaves; ++i) {
Guolin Ke's avatar
Guolin Ke committed
297
298
299
300
301
302
303
    best_split_per_leaf_[i].Reset();
  }

  // Sumup for root
  if (data_partition_->leaf_count(0) == num_data_) {
    // use all data
    smaller_leaf_splits_->Init(gradients_, hessians_);
Guolin Ke's avatar
Guolin Ke committed
304

Guolin Ke's avatar
Guolin Ke committed
305
306
  } else {
    // use bagging, only use part of data
Guolin Ke's avatar
Guolin Ke committed
307
    smaller_leaf_splits_->Init(0, data_partition_.get(), gradients_, hessians_);
Guolin Ke's avatar
Guolin Ke committed
308
309
310
311
312
  }

  larger_leaf_splits_->Init();
}

Guolin Ke's avatar
Guolin Ke committed
313
bool SerialTreeLearner::BeforeFindBestSplit(const Tree* tree, int left_leaf, int right_leaf) {
314
  Common::FunctionTimer fun_timer("SerialTreeLearner::BeforeFindBestSplit", global_timer);
Guolin Ke's avatar
Guolin Ke committed
315
  // check depth of current leaf
Guolin Ke's avatar
Guolin Ke committed
316
  if (config_->max_depth > 0) {
Guolin Ke's avatar
Guolin Ke committed
317
    // only need to check left leaf, since right leaf is in same level of left leaf
Guolin Ke's avatar
Guolin Ke committed
318
    if (tree->leaf_depth(left_leaf) >= config_->max_depth) {
Guolin Ke's avatar
Guolin Ke committed
319
320
321
322
323
324
325
      best_split_per_leaf_[left_leaf].gain = kMinScore;
      if (right_leaf >= 0) {
        best_split_per_leaf_[right_leaf].gain = kMinScore;
      }
      return false;
    }
  }
Guolin Ke's avatar
Guolin Ke committed
326
327
328
  data_size_t num_data_in_left_child = GetGlobalDataCountInLeaf(left_leaf);
  data_size_t num_data_in_right_child = GetGlobalDataCountInLeaf(right_leaf);
  // no enough data to continue
Guolin Ke's avatar
Guolin Ke committed
329
330
  if (num_data_in_right_child < static_cast<data_size_t>(config_->min_data_in_leaf * 2)
      && num_data_in_left_child < static_cast<data_size_t>(config_->min_data_in_leaf * 2)) {
Guolin Ke's avatar
Guolin Ke committed
331
332
333
334
335
336
    best_split_per_leaf_[left_leaf].gain = kMinScore;
    if (right_leaf >= 0) {
      best_split_per_leaf_[right_leaf].gain = kMinScore;
    }
    return false;
  }
337
  parent_leaf_histogram_array_ = nullptr;
Guolin Ke's avatar
Guolin Ke committed
338
339
  // only have root
  if (right_leaf < 0) {
340
    histogram_pool_.Get(left_leaf, &smaller_leaf_histogram_array_);
Guolin Ke's avatar
Guolin Ke committed
341
342
    larger_leaf_histogram_array_ = nullptr;
  } else if (num_data_in_left_child < num_data_in_right_child) {
Hui Xue's avatar
Hui Xue committed
343
    // put parent(left) leaf's histograms into larger leaf's histograms
344
345
346
    if (histogram_pool_.Get(left_leaf, &larger_leaf_histogram_array_)) { parent_leaf_histogram_array_ = larger_leaf_histogram_array_; }
    histogram_pool_.Move(left_leaf, right_leaf);
    histogram_pool_.Get(left_leaf, &smaller_leaf_histogram_array_);
Guolin Ke's avatar
Guolin Ke committed
347
  } else {
Hui Xue's avatar
Hui Xue committed
348
    // put parent(left) leaf's histograms to larger leaf's histograms
349
350
    if (histogram_pool_.Get(left_leaf, &larger_leaf_histogram_array_)) { parent_leaf_histogram_array_ = larger_leaf_histogram_array_; }
    histogram_pool_.Get(right_leaf, &smaller_leaf_histogram_array_);
Guolin Ke's avatar
Guolin Ke committed
351
352
353
354
  }
  return true;
}

Guolin Ke's avatar
Guolin Ke committed
355
356
void SerialTreeLearner::FindBestSplits() {
  std::vector<int8_t> is_feature_used(num_features_, 0);
357
  #pragma omp parallel for schedule(static, 1024) if (num_features_ >= 2048)
Guolin Ke's avatar
Guolin Ke committed
358
359
360
361
362
363
364
365
366
367
368
369
370
371
  for (int feature_index = 0; feature_index < num_features_; ++feature_index) {
    if (!is_feature_used_[feature_index]) continue;
    if (parent_leaf_histogram_array_ != nullptr
        && !parent_leaf_histogram_array_[feature_index].is_splittable()) {
      smaller_leaf_histogram_array_[feature_index].set_is_splittable(false);
      continue;
    }
    is_feature_used[feature_index] = 1;
  }
  bool use_subtract = parent_leaf_histogram_array_ != nullptr;
  ConstructHistograms(is_feature_used, use_subtract);
  FindBestSplitsFromHistograms(is_feature_used, use_subtract);
}

372
void SerialTreeLearner::ConstructHistograms(const std::vector<int8_t>& is_feature_used, bool use_subtract) {
373
  Common::FunctionTimer fun_timer("SerialTreeLearner::ConstructHistograms", global_timer);
Guolin Ke's avatar
Guolin Ke committed
374
  // construct smaller leaf
375
  hist_t* ptr_smaller_leaf_hist_data = smaller_leaf_histogram_array_[0].RawData() - kHistOffset;
376
377
378
379
380
  train_data_->ConstructHistograms(
      is_feature_used, smaller_leaf_splits_->data_indices(),
      smaller_leaf_splits_->num_data_in_leaf(), gradients_, hessians_,
      ordered_gradients_.data(), ordered_hessians_.data(), is_constant_hessian_,
      is_hist_colwise_, temp_state_.get(), ptr_smaller_leaf_hist_data);
Guolin Ke's avatar
Guolin Ke committed
381
382
383

  if (larger_leaf_histogram_array_ != nullptr && !use_subtract) {
    // construct larger leaf
384
    hist_t* ptr_larger_leaf_hist_data = larger_leaf_histogram_array_[0].RawData() - kHistOffset;
385
386
387
388
389
390
    train_data_->ConstructHistograms(
        is_feature_used, larger_leaf_splits_->data_indices(),
        larger_leaf_splits_->num_data_in_leaf(), gradients_, hessians_,
        ordered_gradients_.data(), ordered_hessians_.data(),
        is_constant_hessian_, is_hist_colwise_, temp_state_.get(),
        ptr_larger_leaf_hist_data);
Guolin Ke's avatar
Guolin Ke committed
391
  }
392
393
}

Guolin Ke's avatar
Guolin Ke committed
394
395
396
397
void SerialTreeLearner::FindBestSplitsFromHistograms(
    const std::vector<int8_t>& is_feature_used, bool use_subtract) {
  Common::FunctionTimer fun_timer(
      "SerialTreeLearner::FindBestSplitsFromHistograms", global_timer);
398
399
400
  int num_threads = OMP_NUM_THREADS();
  std::vector<SplitInfo> smaller_best(num_threads);
  std::vector<SplitInfo> larger_best(num_threads);
401
402
  std::vector<int8_t> smaller_node_used_features(num_features_, 1);
  std::vector<int8_t> larger_node_used_features(num_features_, 1);
403
404
405
  if (config_->feature_fraction_bynode < 1.0f) {
    smaller_node_used_features = GetUsedFeatures(false);
    larger_node_used_features = GetUsedFeatures(false);
406
  }
407
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
408
409
// find splits
#pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
410
  for (int feature_index = 0; feature_index < num_features_; ++feature_index) {
411
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
412
413
414
    if (!is_feature_used[feature_index]) {
      continue;
    }
Guolin Ke's avatar
Guolin Ke committed
415
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
416
417
418
419
    train_data_->FixHistogram(
        feature_index, smaller_leaf_splits_->sum_gradients(),
        smaller_leaf_splits_->sum_hessians(),
        smaller_leaf_histogram_array_[feature_index].RawData());
420
    int real_fidx = train_data_->RealFeatureIndex(feature_index);
421
422
423
424
425
426
427

    ComputeBestSplitForFeature(smaller_leaf_histogram_array_, feature_index,
                               real_fidx,
                               smaller_node_used_features[feature_index],
                               smaller_leaf_splits_->num_data_in_leaf(),
                               smaller_leaf_splits_.get(), &smaller_best[tid]);

Guolin Ke's avatar
Guolin Ke committed
428
    // only has root leaf
Guolin Ke's avatar
Guolin Ke committed
429
430
431
432
    if (larger_leaf_splits_ == nullptr ||
        larger_leaf_splits_->leaf_index() < 0) {
      continue;
    }
Guolin Ke's avatar
Guolin Ke committed
433

Guolin Ke's avatar
Guolin Ke committed
434
    if (use_subtract) {
Guolin Ke's avatar
Guolin Ke committed
435
436
      larger_leaf_histogram_array_[feature_index].Subtract(
          smaller_leaf_histogram_array_[feature_index]);
437
    } else {
Guolin Ke's avatar
Guolin Ke committed
438
439
440
441
      train_data_->FixHistogram(
          feature_index, larger_leaf_splits_->sum_gradients(),
          larger_leaf_splits_->sum_hessians(),
          larger_leaf_histogram_array_[feature_index].RawData());
442
    }
443
444
445
446
447

    ComputeBestSplitForFeature(larger_leaf_histogram_array_, feature_index,
                               real_fidx,
                               larger_node_used_features[feature_index],
                               larger_leaf_splits_->num_data_in_leaf(),
Guolin Ke's avatar
Guolin Ke committed
448
                               larger_leaf_splits_.get(), &larger_best[tid]);
449

450
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
451
  }
452
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
453
  auto smaller_best_idx = ArrayArgs<SplitInfo>::ArgMax(smaller_best);
454
  int leaf = smaller_leaf_splits_->leaf_index();
Guolin Ke's avatar
Guolin Ke committed
455
456
  best_split_per_leaf_[leaf] = smaller_best[smaller_best_idx];

Guolin Ke's avatar
Guolin Ke committed
457
458
  if (larger_leaf_splits_ != nullptr &&
      larger_leaf_splits_->leaf_index() >= 0) {
459
    leaf = larger_leaf_splits_->leaf_index();
Guolin Ke's avatar
Guolin Ke committed
460
461
462
463
464
    auto larger_best_idx = ArrayArgs<SplitInfo>::ArgMax(larger_best);
    best_split_per_leaf_[leaf] = larger_best[larger_best_idx];
  }
}

Guolin Ke's avatar
Guolin Ke committed
465
int32_t SerialTreeLearner::ForceSplits(Tree* tree, const Json& forced_split_json, int* left_leaf,
466
                                       int* right_leaf, int *cur_depth,
467
468
469
470
471
472
473
474
475
476
                                       bool *aborted_last_force_split) {
  int32_t result_count = 0;
  // start at root leaf
  *left_leaf = 0;
  std::queue<std::pair<Json, int>> q;
  Json left = forced_split_json;
  Json right;
  bool left_smaller = true;
  std::unordered_map<int, SplitInfo> forceSplitMap;
  q.push(std::make_pair(forced_split_json, *left_leaf));
477
  while (!q.empty()) {
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
    // before processing next node from queue, store info for current left/right leaf
    // store "best split" for left and right, even if they might be overwritten by forced split
    if (BeforeFindBestSplit(tree, *left_leaf, *right_leaf)) {
      FindBestSplits();
    }
    // then, compute own splits
    SplitInfo left_split;
    SplitInfo right_split;

    if (!left.is_null()) {
      const int left_feature = left["feature"].int_value();
      const double left_threshold_double = left["threshold"].number_value();
      const int left_inner_feature_index = train_data_->InnerFeatureIndex(left_feature);
      const uint32_t left_threshold = train_data_->BinThreshold(
              left_inner_feature_index, left_threshold_double);
      auto leaf_histogram_array = (left_smaller) ? smaller_leaf_histogram_array_ : larger_leaf_histogram_array_;
      auto left_leaf_splits = (left_smaller) ? smaller_leaf_splits_.get() : larger_leaf_splits_.get();
      leaf_histogram_array[left_inner_feature_index].GatherInfoForThreshold(
              left_leaf_splits->sum_gradients(),
              left_leaf_splits->sum_hessians(),
              left_threshold,
              left_leaf_splits->num_data_in_leaf(),
              &left_split);
      left_split.feature = left_feature;
      forceSplitMap[*left_leaf] = left_split;
      if (left_split.gain < 0) {
        forceSplitMap.erase(*left_leaf);
      }
    }

    if (!right.is_null()) {
      const int right_feature = right["feature"].int_value();
      const double right_threshold_double = right["threshold"].number_value();
      const int right_inner_feature_index = train_data_->InnerFeatureIndex(right_feature);
      const uint32_t right_threshold = train_data_->BinThreshold(
              right_inner_feature_index, right_threshold_double);
      auto leaf_histogram_array = (left_smaller) ? larger_leaf_histogram_array_ : smaller_leaf_histogram_array_;
      auto right_leaf_splits = (left_smaller) ? larger_leaf_splits_.get() : smaller_leaf_splits_.get();
      leaf_histogram_array[right_inner_feature_index].GatherInfoForThreshold(
        right_leaf_splits->sum_gradients(),
        right_leaf_splits->sum_hessians(),
        right_threshold,
        right_leaf_splits->num_data_in_leaf(),
        &right_split);
      right_split.feature = right_feature;
      forceSplitMap[*right_leaf] = right_split;
      if (right_split.gain < 0) {
        forceSplitMap.erase(*right_leaf);
      }
    }

    std::pair<Json, int> pair = q.front();
    q.pop();
    int current_leaf = pair.second;
    // split info should exist because searching in bfs fashion - should have added from parent
    if (forceSplitMap.find(current_leaf) == forceSplitMap.end()) {
        *aborted_last_force_split = true;
        break;
    }
    SplitInfo current_split_info = forceSplitMap[current_leaf];
    const int inner_feature_index = train_data_->InnerFeatureIndex(
            current_split_info.feature);
    auto threshold_double = train_data_->RealThreshold(
            inner_feature_index, current_split_info.threshold);

    // split tree, will return right leaf
    *left_leaf = current_leaf;
Guolin Ke's avatar
Guolin Ke committed
545
    auto next_leaf_id = tree->NextLeafId();
546
    if (train_data_->FeatureBinMapper(inner_feature_index)->bin_type() == BinType::NumericalBin) {
Guolin Ke's avatar
Guolin Ke committed
547
548
549
550
551
      data_partition_->Split(current_leaf, train_data_, inner_feature_index,
                             &current_split_info.threshold, 1,
                             current_split_info.default_left, next_leaf_id);
      current_split_info.left_count = data_partition_->leaf_count(*left_leaf);
      current_split_info.right_count = data_partition_->leaf_count(next_leaf_id);
552
553
554
555
556
557
558
559
560
      *right_leaf = tree->Split(current_leaf,
                                inner_feature_index,
                                current_split_info.feature,
                                current_split_info.threshold,
                                threshold_double,
                                static_cast<double>(current_split_info.left_output),
                                static_cast<double>(current_split_info.right_output),
                                static_cast<data_size_t>(current_split_info.left_count),
                                static_cast<data_size_t>(current_split_info.right_count),
561
562
                                static_cast<double>(current_split_info.left_sum_hessian),
                                static_cast<double>(current_split_info.right_sum_hessian),
563
564
565
566
567
568
569
570
571
572
573
574
575
                                static_cast<float>(current_split_info.gain),
                                train_data_->FeatureBinMapper(inner_feature_index)->missing_type(),
                                current_split_info.default_left);
    } else {
      std::vector<uint32_t> cat_bitset_inner = Common::ConstructBitset(
              current_split_info.cat_threshold.data(), current_split_info.num_cat_threshold);
      std::vector<int> threshold_int(current_split_info.num_cat_threshold);
      for (int i = 0; i < current_split_info.num_cat_threshold; ++i) {
        threshold_int[i] = static_cast<int>(train_data_->RealThreshold(
                    inner_feature_index, current_split_info.cat_threshold[i]));
      }
      std::vector<uint32_t> cat_bitset = Common::ConstructBitset(
              threshold_int.data(), current_split_info.num_cat_threshold);
Guolin Ke's avatar
Guolin Ke committed
576
577
578
579
580
      data_partition_->Split(current_leaf, train_data_, inner_feature_index,
                             cat_bitset_inner.data(), static_cast<int>(cat_bitset_inner.size()),
                             current_split_info.default_left, next_leaf_id);
      current_split_info.left_count = data_partition_->leaf_count(*left_leaf);
      current_split_info.right_count = data_partition_->leaf_count(next_leaf_id);
581
582
583
584
585
586
587
588
589
590
591
      *right_leaf = tree->SplitCategorical(current_leaf,
                                           inner_feature_index,
                                           current_split_info.feature,
                                           cat_bitset_inner.data(),
                                           static_cast<int>(cat_bitset_inner.size()),
                                           cat_bitset.data(),
                                           static_cast<int>(cat_bitset.size()),
                                           static_cast<double>(current_split_info.left_output),
                                           static_cast<double>(current_split_info.right_output),
                                           static_cast<data_size_t>(current_split_info.left_count),
                                           static_cast<data_size_t>(current_split_info.right_count),
592
593
                                           static_cast<double>(current_split_info.left_sum_hessian),
                                           static_cast<double>(current_split_info.right_sum_hessian),
594
595
596
                                           static_cast<float>(current_split_info.gain),
                                           train_data_->FeatureBinMapper(inner_feature_index)->missing_type());
    }
Guolin Ke's avatar
Guolin Ke committed
597
598
599
    #ifdef DEBUG
    CHECK(*right_leaf == next_leaf_id);
    #endif
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
    if (current_split_info.left_count < current_split_info.right_count) {
      left_smaller = true;
      smaller_leaf_splits_->Init(*left_leaf, data_partition_.get(),
                                 current_split_info.left_sum_gradient,
                                 current_split_info.left_sum_hessian);
      larger_leaf_splits_->Init(*right_leaf, data_partition_.get(),
                                current_split_info.right_sum_gradient,
                                current_split_info.right_sum_hessian);
    } else {
      left_smaller = false;
      smaller_leaf_splits_->Init(*right_leaf, data_partition_.get(),
                                 current_split_info.right_sum_gradient, current_split_info.right_sum_hessian);
      larger_leaf_splits_->Init(*left_leaf, data_partition_.get(),
                                current_split_info.left_sum_gradient, current_split_info.left_sum_hessian);
    }

    left = Json();
    right = Json();
    if ((pair.first).object_items().count("left") > 0) {
      left = (pair.first)["left"];
620
621
622
      if (left.object_items().count("feature") > 0 && left.object_items().count("threshold") > 0) {
        q.push(std::make_pair(left, *left_leaf));
      }
623
624
625
    }
    if ((pair.first).object_items().count("right") > 0) {
      right = (pair.first)["right"];
626
627
628
      if (right.object_items().count("feature") > 0 && right.object_items().count("threshold") > 0) {
        q.push(std::make_pair(right, *right_leaf));
      }
629
630
631
632
633
634
    }
    result_count++;
    *(cur_depth) = std::max(*(cur_depth), tree->leaf_depth(*left_leaf));
  }
  return result_count;
}
Guolin Ke's avatar
Guolin Ke committed
635

636
void SerialTreeLearner::Split(Tree* tree, int best_leaf, int* left_leaf, int* right_leaf) {
637
638
  Common::FunctionTimer fun_timer("SerialTreeLearner::Split", global_timer);
  SplitInfo& best_split_info = best_split_per_leaf_[best_leaf];
Guolin Ke's avatar
Guolin Ke committed
639
  const int inner_feature_index = train_data_->InnerFeatureIndex(best_split_info.feature);
640
641
  if (cegb_ != nullptr) {
    cegb_->UpdateLeafBestSplits(tree, best_leaf, &best_split_info, &best_split_per_leaf_);
642
  }
643
  *left_leaf = best_leaf;
644
645
  auto next_leaf_id = tree->NextLeafId();

Guolin Ke's avatar
Guolin Ke committed
646
647
  bool is_numerical_split = train_data_->FeatureBinMapper(inner_feature_index)->bin_type() == BinType::NumericalBin;
  if (is_numerical_split) {
648
    auto threshold_double = train_data_->RealThreshold(inner_feature_index, best_split_info.threshold);
649
650
651
652
    data_partition_->Split(best_leaf, train_data_, inner_feature_index,
      &best_split_info.threshold, 1, best_split_info.default_left, next_leaf_id);
    best_split_info.left_count = data_partition_->leaf_count(*left_leaf);
    best_split_info.right_count = data_partition_->leaf_count(next_leaf_id);
653
654
    // split tree, will return right leaf
    *right_leaf = tree->Split(best_leaf,
655
656
657
658
659
660
661
662
663
664
665
666
667
      inner_feature_index,
      best_split_info.feature,
      best_split_info.threshold,
      threshold_double,
      static_cast<double>(best_split_info.left_output),
      static_cast<double>(best_split_info.right_output),
      static_cast<data_size_t>(best_split_info.left_count),
      static_cast<data_size_t>(best_split_info.right_count),
      static_cast<double>(best_split_info.left_sum_hessian),
      static_cast<double>(best_split_info.right_sum_hessian),
      static_cast<float>(best_split_info.gain),
      train_data_->FeatureBinMapper(inner_feature_index)->missing_type(),
      best_split_info.default_left);
668
  } else {
669
670
671
672
673
674
    std::vector<uint32_t> cat_bitset_inner = Common::ConstructBitset(best_split_info.cat_threshold.data(), best_split_info.num_cat_threshold);
    std::vector<int> threshold_int(best_split_info.num_cat_threshold);
    for (int i = 0; i < best_split_info.num_cat_threshold; ++i) {
      threshold_int[i] = static_cast<int>(train_data_->RealThreshold(inner_feature_index, best_split_info.cat_threshold[i]));
    }
    std::vector<uint32_t> cat_bitset = Common::ConstructBitset(threshold_int.data(), best_split_info.num_cat_threshold);
675

676
    data_partition_->Split(best_leaf, train_data_, inner_feature_index,
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
      cat_bitset_inner.data(), static_cast<int>(cat_bitset_inner.size()), best_split_info.default_left, next_leaf_id);

    best_split_info.left_count = data_partition_->leaf_count(*left_leaf);
    best_split_info.right_count = data_partition_->leaf_count(next_leaf_id);

    *right_leaf = tree->SplitCategorical(best_leaf,
      inner_feature_index,
      best_split_info.feature,
      cat_bitset_inner.data(),
      static_cast<int>(cat_bitset_inner.size()),
      cat_bitset.data(),
      static_cast<int>(cat_bitset.size()),
      static_cast<double>(best_split_info.left_output),
      static_cast<double>(best_split_info.right_output),
      static_cast<data_size_t>(best_split_info.left_count),
      static_cast<data_size_t>(best_split_info.right_count),
      static_cast<double>(best_split_info.left_sum_hessian),
      static_cast<double>(best_split_info.right_sum_hessian),
      static_cast<float>(best_split_info.gain),
      train_data_->FeatureBinMapper(inner_feature_index)->missing_type());
  }
698
699

  #ifdef DEBUG
700
  CHECK(*right_leaf == next_leaf_id);
701
  #endif
702

Guolin Ke's avatar
Guolin Ke committed
703
704
  // init the leaves that used on next iteration
  if (best_split_info.left_count < best_split_info.right_count) {
705
    CHECK_GT(best_split_info.left_count, 0);
Guolin Ke's avatar
Guolin Ke committed
706
707
    smaller_leaf_splits_->Init(*left_leaf, data_partition_.get(), best_split_info.left_sum_gradient, best_split_info.left_sum_hessian);
    larger_leaf_splits_->Init(*right_leaf, data_partition_.get(), best_split_info.right_sum_gradient, best_split_info.right_sum_hessian);
Guolin Ke's avatar
Guolin Ke committed
708
  } else {
709
    CHECK_GT(best_split_info.right_count, 0);
Guolin Ke's avatar
Guolin Ke committed
710
711
    smaller_leaf_splits_->Init(*right_leaf, data_partition_.get(), best_split_info.right_sum_gradient, best_split_info.right_sum_hessian);
    larger_leaf_splits_->Init(*left_leaf, data_partition_.get(), best_split_info.left_sum_gradient, best_split_info.left_sum_hessian);
Guolin Ke's avatar
Guolin Ke committed
712
  }
713
714
715
716
  constraints_->UpdateConstraints(
      is_numerical_split, *left_leaf, *right_leaf,
      best_split_info.monotone_type, best_split_info.right_output,
      best_split_info.left_output);
Guolin Ke's avatar
Guolin Ke committed
717
718
}

Guolin Ke's avatar
Guolin Ke committed
719

720
void SerialTreeLearner::RenewTreeOutput(Tree* tree, const ObjectiveFunction* obj, std::function<double(const label_t*, int)> residual_getter,
721
722
723
724
725
                                        data_size_t total_num_data, const data_size_t* bag_indices, data_size_t bag_cnt) const {
  if (obj != nullptr && obj->IsRenewTreeOutput()) {
    CHECK(tree->num_leaves() <= data_partition_->num_leaves());
    const data_size_t* bag_mapper = nullptr;
    if (total_num_data != num_data_) {
726
      CHECK_EQ(bag_cnt, num_data_);
727
728
      bag_mapper = bag_indices;
    }
Guolin Ke's avatar
Guolin Ke committed
729
    std::vector<int> n_nozeroworker_perleaf(tree->num_leaves(), 1);
730
    int num_machines = Network::num_machines();
731
732
733
734
735
    #pragma omp parallel for schedule(static)
    for (int i = 0; i < tree->num_leaves(); ++i) {
      const double output = static_cast<double>(tree->LeafOutput(i));
      data_size_t cnt_leaf_data = 0;
      auto index_mapper = data_partition_->GetIndexOnLeaf(i, &cnt_leaf_data);
Guolin Ke's avatar
Guolin Ke committed
736
737
      if (cnt_leaf_data > 0) {
        // bag_mapper[index_mapper[i]]
738
        const double new_output = obj->RenewTreeOutput(output, residual_getter, index_mapper, bag_mapper, cnt_leaf_data);
Guolin Ke's avatar
Guolin Ke committed
739
740
        tree->SetLeafOutput(i, new_output);
      } else {
741
        CHECK_GT(num_machines, 1);
Guolin Ke's avatar
Guolin Ke committed
742
743
744
745
746
747
748
749
750
        tree->SetLeafOutput(i, 0.0);
        n_nozeroworker_perleaf[i] = 0;
      }
    }
    if (num_machines > 1) {
      std::vector<double> outputs(tree->num_leaves());
      for (int i = 0; i < tree->num_leaves(); ++i) {
        outputs[i] = static_cast<double>(tree->LeafOutput(i));
      }
Guolin Ke's avatar
Guolin Ke committed
751
752
      outputs = Network::GlobalSum(&outputs);
      n_nozeroworker_perleaf = Network::GlobalSum(&n_nozeroworker_perleaf);
Guolin Ke's avatar
Guolin Ke committed
753
754
755
756
757
758
759
      for (int i = 0; i < tree->num_leaves(); ++i) {
        tree->SetLeafOutput(i, outputs[i] / n_nozeroworker_perleaf[i]);
      }
    }
  }
}

760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
void SerialTreeLearner::ComputeBestSplitForFeature(
    FeatureHistogram* histogram_array_, int feature_index, int real_fidx,
    bool is_feature_used, int num_data, const LeafSplits* leaf_splits,
    SplitInfo* best_split) {
  if (!is_feature_used) {
    return;
  }
  SplitInfo new_split;
  histogram_array_[feature_index].FindBestThreshold(
      leaf_splits->sum_gradients(), leaf_splits->sum_hessians(), num_data,
      constraints_->Get(leaf_splits->leaf_index()), &new_split);
  new_split.feature = real_fidx;
  if (cegb_ != nullptr) {
    new_split.gain -=
        cegb_->DetlaGain(feature_index, real_fidx, leaf_splits->leaf_index(),
                         num_data, new_split);
  }
  if (new_split > *best_split) {
    *best_split = new_split;
  }
}

Guolin Ke's avatar
Guolin Ke committed
782
}  // namespace LightGBM