gbdt.cpp 26.7 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
#include "gbdt.h"

3
#include <LightGBM/utils/openmp_wrapper.h>
4

Guolin Ke's avatar
Guolin Ke committed
5
6
7
#include <LightGBM/utils/common.h>
#include <LightGBM/objective_function.h>
#include <LightGBM/metric.h>
cbecker's avatar
cbecker committed
8
#include <LightGBM/prediction_early_stop.h>
Guolin Ke's avatar
Guolin Ke committed
9
#include <LightGBM/network.h>
Guolin Ke's avatar
Guolin Ke committed
10
11
12
13
14
15
16

#include <ctime>

#include <sstream>
#include <chrono>
#include <string>
#include <vector>
17
#include <utility>
Guolin Ke's avatar
Guolin Ke committed
18
19
20

namespace LightGBM {

Guolin Ke's avatar
Guolin Ke committed
21

Guolin Ke's avatar
Guolin Ke committed
22
GBDT::GBDT() : iter_(0),
Guolin Ke's avatar
Guolin Ke committed
23
24
25
26
27
28
29
30
31
32
train_data_(nullptr),
objective_function_(nullptr),
early_stopping_round_(0),
max_feature_idx_(0),
num_tree_per_iteration_(1),
num_class_(1),
num_iteration_for_pred_(0),
shrinkage_rate_(0.1f),
num_init_iteration_(0),
need_re_bagging_(false) {
Guolin Ke's avatar
Guolin Ke committed
33

Guolin Ke's avatar
Guolin Ke committed
34
35
  #pragma omp parallel
  #pragma omp master
Guolin Ke's avatar
Guolin Ke committed
36
37
38
39
  {
    num_threads_ = omp_get_num_threads();
  }
  average_output_ = false;
Guolin Ke's avatar
Guolin Ke committed
40
  tree_learner_ = nullptr;
Guolin Ke's avatar
Guolin Ke committed
41
42
43
}

GBDT::~GBDT() {
44

Guolin Ke's avatar
Guolin Ke committed
45
46
}

Guolin Ke's avatar
Guolin Ke committed
47
void GBDT::Init(const Config* config, const Dataset* train_data, const ObjectiveFunction* objective_function,
48
                const std::vector<const Metric*>& training_metrics) {
Guolin Ke's avatar
Guolin Ke committed
49
  CHECK(train_data != nullptr);
50
  train_data_ = train_data;
51
  iter_ = 0;
wxchan's avatar
wxchan committed
52
  num_iteration_for_pred_ = 0;
53
  max_feature_idx_ = 0;
wxchan's avatar
wxchan committed
54
  num_class_ = config->num_class;
Guolin Ke's avatar
Guolin Ke committed
55
56
57
  config_ = std::unique_ptr<Config>(new Config(*config));
  early_stopping_round_ = config_->early_stopping_round;
  shrinkage_rate_ = config_->learning_rate;
58

59
60
61
62
63
64
65
66
67
68
  std::string forced_splits_path = config->forcedsplits_filename;
  //load forced_splits file
  if (forced_splits_path != "") {
      std::ifstream forced_splits_file(forced_splits_path.c_str());
      std::stringstream buffer;
      buffer << forced_splits_file.rdbuf();
      std::string err;
      forced_splits_json_ = Json::parse(buffer.str(), err);
  }

69
70
71
72
  objective_function_ = objective_function;
  num_tree_per_iteration_ = num_class_;
  if (objective_function_ != nullptr) {
    is_constant_hessian_ = objective_function_->IsConstantHessian();
Guolin Ke's avatar
Guolin Ke committed
73
    num_tree_per_iteration_ = objective_function_->NumModelPerIteration();
74
75
76
77
  } else {
    is_constant_hessian_ = false;
  }

Guolin Ke's avatar
Guolin Ke committed
78
  tree_learner_ = std::unique_ptr<TreeLearner>(TreeLearner::CreateTreeLearner(config_->tree_learner, config_->device_type, config_.get()));
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

  // init tree learner
  tree_learner_->Init(train_data_, is_constant_hessian_);

  // push training metrics
  training_metrics_.clear();
  for (const auto& metric : training_metrics) {
    training_metrics_.push_back(metric);
  }
  training_metrics_.shrink_to_fit();

  train_score_updater_.reset(new ScoreUpdater(train_data_, num_tree_per_iteration_));

  num_data_ = train_data_->num_data();
  // create buffer for gradients and hessians
  if (objective_function_ != nullptr) {
    size_t total_size = static_cast<size_t>(num_data_) * num_tree_per_iteration_;
    gradients_.resize(total_size);
    hessians_.resize(total_size);
  }
  // get max feature index
  max_feature_idx_ = train_data_->num_total_features() - 1;
  // get label index
  label_idx_ = train_data_->label_idx();
  // get feature names
  feature_names_ = train_data_->feature_names();
  feature_infos_ = train_data_->feature_infos();

  // if need bagging, create buffer
Guolin Ke's avatar
Guolin Ke committed
108
  ResetBaggingConfig(config_.get(), true);
109
110
111
112

  class_need_train_ = std::vector<bool>(num_tree_per_iteration_, true);
  if (objective_function_ != nullptr && objective_function_->SkipEmptyClass()) {
    CHECK(num_tree_per_iteration_ == num_class_);
113
114
    for (int i = 0; i < num_class_; ++i) {
      class_need_train_[i] = objective_function_->ClassNeedTrain(i);
115
116
    }
  }
wxchan's avatar
wxchan committed
117
118
119
}

void GBDT::AddValidDataset(const Dataset* valid_data,
120
                           const std::vector<const Metric*>& valid_metrics) {
wxchan's avatar
wxchan committed
121
  if (!train_data_->CheckAlign(*valid_data)) {
122
    Log::Fatal("Cannot add validation data, since it has different bin mappers with training data");
123
  }
Guolin Ke's avatar
Guolin Ke committed
124
  // for a validation dataset, we need its score and metric
125
  auto new_score_updater = std::unique_ptr<ScoreUpdater>(new ScoreUpdater(valid_data, num_tree_per_iteration_));
wxchan's avatar
wxchan committed
126
127
  // update score
  for (int i = 0; i < iter_; ++i) {
128
129
130
    for (int cur_tree_id = 0; cur_tree_id < num_tree_per_iteration_; ++cur_tree_id) {
      auto curr_tree = (i + num_init_iteration_) * num_tree_per_iteration_ + cur_tree_id;
      new_score_updater->AddScore(models_[curr_tree].get(), cur_tree_id);
wxchan's avatar
wxchan committed
131
132
    }
  }
Guolin Ke's avatar
Guolin Ke committed
133
  valid_score_updater_.push_back(std::move(new_score_updater));
Guolin Ke's avatar
Guolin Ke committed
134
  valid_metrics_.emplace_back();
135
136
137
  if (early_stopping_round_ > 0) {
    best_iter_.emplace_back();
    best_score_.emplace_back();
Guolin Ke's avatar
Guolin Ke committed
138
    best_msg_.emplace_back();
139
  }
Guolin Ke's avatar
Guolin Ke committed
140
141
  for (const auto& metric : valid_metrics) {
    valid_metrics_.back().push_back(metric);
142
143
144
    if (early_stopping_round_ > 0) {
      best_iter_.back().push_back(0);
      best_score_.back().push_back(kMinScore);
Guolin Ke's avatar
Guolin Ke committed
145
      best_msg_.back().emplace_back();
146
    }
Guolin Ke's avatar
Guolin Ke committed
147
  }
Guolin Ke's avatar
Guolin Ke committed
148
  valid_metrics_.back().shrink_to_fit();
Guolin Ke's avatar
Guolin Ke committed
149
150
}

Guolin Ke's avatar
Guolin Ke committed
151
152
153
154
155
156
157
158
159
160
void GBDT::Boosting() {
  if (objective_function_ == nullptr) {
    Log::Fatal("No object function provided");
  }
  // objective function will calculate gradients and hessians
  int64_t num_score = 0;
  objective_function_->
    GetGradients(GetTrainingScore(&num_score), gradients_.data(), hessians_.data());
}

161
data_size_t GBDT::BaggingHelper(Random& cur_rand, data_size_t start, data_size_t cnt, data_size_t* buffer) {
162
163
164
  if (cnt <= 0) {
    return 0;
  }
Guolin Ke's avatar
Guolin Ke committed
165
  data_size_t bag_data_cnt = static_cast<data_size_t>(config_->bagging_fraction * cnt);
166
167
  data_size_t cur_left_cnt = 0;
  data_size_t cur_right_cnt = 0;
Guolin Ke's avatar
Guolin Ke committed
168
  auto right_buffer = buffer + bag_data_cnt;
169
170
  // random bagging, minimal unit is one record
  for (data_size_t i = 0; i < cnt; ++i) {
Guolin Ke's avatar
Guolin Ke committed
171
    float prob = (bag_data_cnt - cur_left_cnt) / static_cast<float>(cnt - i);
Guolin Ke's avatar
Guolin Ke committed
172
    if (cur_rand.NextFloat() < prob) {
173
174
      buffer[cur_left_cnt++] = start + i;
    } else {
Guolin Ke's avatar
Guolin Ke committed
175
      right_buffer[cur_right_cnt++] = start + i;
176
177
178
179
180
    }
  }
  CHECK(cur_left_cnt == bag_data_cnt);
  return cur_left_cnt;
}
Guolin Ke's avatar
Guolin Ke committed
181

182
void GBDT::Bagging(int iter) {
Guolin Ke's avatar
Guolin Ke committed
183
  // if need bagging
Guolin Ke's avatar
Guolin Ke committed
184
  if ((bag_data_cnt_ < num_data_ && iter % config_->bagging_freq == 0)
Guolin Ke's avatar
Guolin Ke committed
185
      || need_re_bagging_) {
Guolin Ke's avatar
Guolin Ke committed
186
    need_re_bagging_ = false;
Guolin Ke's avatar
Guolin Ke committed
187
    const data_size_t min_inner_size = 1000;
188
189
    data_size_t inner_size = (num_data_ + num_threads_ - 1) / num_threads_;
    if (inner_size < min_inner_size) { inner_size = min_inner_size; }
190
    OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
191
    #pragma omp parallel for schedule(static,1)
192
    for (int i = 0; i < num_threads_; ++i) {
193
      OMP_LOOP_EX_BEGIN();
194
195
196
197
198
199
      left_cnts_buf_[i] = 0;
      right_cnts_buf_[i] = 0;
      data_size_t cur_start = i * inner_size;
      if (cur_start > num_data_) { continue; }
      data_size_t cur_cnt = inner_size;
      if (cur_start + cur_cnt > num_data_) { cur_cnt = num_data_ - cur_start; }
Guolin Ke's avatar
Guolin Ke committed
200
      Random cur_rand(config_->bagging_seed + iter * num_threads_ + i);
Guolin Ke's avatar
Guolin Ke committed
201
      data_size_t cur_left_count = BaggingHelper(cur_rand, cur_start, cur_cnt, tmp_indices_.data() + cur_start);
202
203
204
      offsets_buf_[i] = cur_start;
      left_cnts_buf_[i] = cur_left_count;
      right_cnts_buf_[i] = cur_cnt - cur_left_count;
205
      OMP_LOOP_EX_END();
206
    }
207
    OMP_THROW_EX();
208
209
210
211
212
213
214
215
216
    data_size_t left_cnt = 0;
    left_write_pos_buf_[0] = 0;
    right_write_pos_buf_[0] = 0;
    for (int i = 1; i < num_threads_; ++i) {
      left_write_pos_buf_[i] = left_write_pos_buf_[i - 1] + left_cnts_buf_[i - 1];
      right_write_pos_buf_[i] = right_write_pos_buf_[i - 1] + right_cnts_buf_[i - 1];
    }
    left_cnt = left_write_pos_buf_[num_threads_ - 1] + left_cnts_buf_[num_threads_ - 1];

Guolin Ke's avatar
Guolin Ke committed
217
    #pragma omp parallel for schedule(static, 1)
218
    for (int i = 0; i < num_threads_; ++i) {
219
      OMP_LOOP_EX_BEGIN();
220
221
      if (left_cnts_buf_[i] > 0) {
        std::memcpy(bag_data_indices_.data() + left_write_pos_buf_[i],
222
                    tmp_indices_.data() + offsets_buf_[i], left_cnts_buf_[i] * sizeof(data_size_t));
Guolin Ke's avatar
Guolin Ke committed
223
      }
224
225
      if (right_cnts_buf_[i] > 0) {
        std::memcpy(bag_data_indices_.data() + left_cnt + right_write_pos_buf_[i],
226
                    tmp_indices_.data() + offsets_buf_[i] + left_cnts_buf_[i], right_cnts_buf_[i] * sizeof(data_size_t));
Guolin Ke's avatar
Guolin Ke committed
227
      }
228
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
229
    }
230
    OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
231
    bag_data_cnt_ = left_cnt;
Guolin Ke's avatar
Guolin Ke committed
232
    Log::Debug("Re-bagging, using %d data to train", bag_data_cnt_);
Guolin Ke's avatar
Guolin Ke committed
233
    // set bagging data to tree learner
Guolin Ke's avatar
Guolin Ke committed
234
235
236
237
    if (!is_use_subset_) {
      tree_learner_->SetBaggingData(bag_data_indices_.data(), bag_data_cnt_);
    } else {
      // get subset
Guolin Ke's avatar
Guolin Ke committed
238
239
      tmp_subset_->ReSize(bag_data_cnt_);
      tmp_subset_->CopySubset(train_data_, bag_data_indices_.data(), bag_data_cnt_, false);
Guolin Ke's avatar
Guolin Ke committed
240
241
      tree_learner_->ResetTrainingData(tmp_subset_.get());
    }
Guolin Ke's avatar
Guolin Ke committed
242
243
244
  }
}

Guolin Ke's avatar
Guolin Ke committed
245
246
247
void GBDT::Train(int snapshot_freq, const std::string& model_output_path) {
  bool is_finished = false;
  auto start_time = std::chrono::steady_clock::now();
Guolin Ke's avatar
Guolin Ke committed
248
  for (int iter = 0; iter < config_->num_iterations && !is_finished; ++iter) {
Guolin Ke's avatar
Guolin Ke committed
249
250
251
252
    is_finished = TrainOneIter(nullptr, nullptr);
    if (!is_finished) {
      is_finished = EvalAndCheckEarlyStopping();
    }
Guolin Ke's avatar
Guolin Ke committed
253
254
255
256
257
258
259
    auto end_time = std::chrono::steady_clock::now();
    // output used time per iteration
    Log::Info("%f seconds elapsed, finished iteration %d", std::chrono::duration<double,
              std::milli>(end_time - start_time) * 1e-3, iter + 1);
    if (snapshot_freq > 0
        && (iter + 1) % snapshot_freq == 0) {
      std::string snapshot_out = model_output_path + ".snapshot_iter_" + std::to_string(iter + 1);
260
      SaveModelToFile(0, -1, snapshot_out.c_str());
Guolin Ke's avatar
Guolin Ke committed
261
262
263
264
    }
  }
}

265
266
267
268
269
270
271
272
273
274
275
276
277
void GBDT::RefitTree(const std::vector<std::vector<int>>& tree_leaf_prediction) {
  CHECK(tree_leaf_prediction.size() > 0);
  CHECK(static_cast<size_t>(num_data_) == tree_leaf_prediction.size());
  CHECK(static_cast<size_t>(models_.size()) == tree_leaf_prediction[0].size());
  int num_iterations = static_cast<int>(models_.size() / num_tree_per_iteration_);
  std::vector<int> leaf_pred(num_data_);
  for (int iter = 0; iter < num_iterations; ++iter) {
    Boosting();
    for (int tree_id = 0; tree_id < num_tree_per_iteration_; ++tree_id) {
      int model_index = iter * num_tree_per_iteration_ + tree_id;
      #pragma omp parallel for schedule(static)
      for (int i = 0; i < num_data_; ++i) {
        leaf_pred[i] = tree_leaf_prediction[i][model_index];
Guolin Ke's avatar
Guolin Ke committed
278
        CHECK(leaf_pred[i] < models_[model_index]->num_leaves());
279
280
281
282
283
284
285
286
287
288
289
      }
      size_t bias = static_cast<size_t>(tree_id) * num_data_;
      auto grad = gradients_.data() + bias;
      auto hess = hessians_.data() + bias;
      auto new_tree = tree_learner_->FitByExistingTree(models_[model_index].get(), leaf_pred, grad, hess);
      train_score_updater_->AddScore(tree_learner_.get(), new_tree, tree_id);
      models_[model_index].reset(new_tree);
    }
  }
}

290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
/* If the custom "average" is implemented it will be used inplace of the label average (if enabled)
*
* An improvement to this is to have options to explicitly choose
* (i) standard average
* (ii) custom average if available
* (iii) any user defined scalar bias (e.g. using a new option "init_score" that overrides (i) and (ii) )
*
* (i) and (ii) could be selected as say "auto_init_score" = 0 or 1 etc..
*
*/
double ObtainAutomaticInitialScore(const ObjectiveFunction* fobj, int class_id) {
  double init_score = 0.0;
  if (fobj != nullptr) {
    init_score = fobj->BoostFromScore(class_id);
  }
  if (Network::num_machines() > 1) {
    init_score = Network::GlobalSyncUpByMean(init_score);
  }
  return init_score;
}

double GBDT::BoostFromAverage(int class_id) {
312
  // boosting from average label; or customized "average" if implemented for the current objective
313
314
315
  if (models_.empty() && !train_score_updater_->has_init_score() && objective_function_ != nullptr) {
    if (config_->boost_from_average || (train_data_ != nullptr && train_data_->num_features() == 0)) {
      double init_score = ObtainAutomaticInitialScore(objective_function_, class_id);
316
      if (std::fabs(init_score) > kEpsilon) {
317
        train_score_updater_->AddScore(init_score, class_id);
318
        for (auto& score_updater : valid_score_updater_) {
319
          score_updater->AddScore(init_score, class_id);
320
321
322
        }
        Log::Info("Start training from score %lf", init_score);
        return init_score;
Guolin Ke's avatar
Guolin Ke committed
323
      }
324
325
326
    } else if (std::string(objective_function_->GetName()) == std::string("regression_l1")
               || std::string(objective_function_->GetName()) == std::string("quantile")
               || std::string(objective_function_->GetName()) == std::string("mape")) {
327
      Log::Warning("Disabling boost_from_average in %s may cause the slow convergence", objective_function_->GetName());
328
    }
329
  }
Guolin Ke's avatar
Guolin Ke committed
330
331
  return 0.0f;
}
Guolin Ke's avatar
Guolin Ke committed
332

Guolin Ke's avatar
Guolin Ke committed
333
bool GBDT::TrainOneIter(const score_t* gradients, const score_t* hessians) {
334
  std::vector<double> init_scores(num_tree_per_iteration_, 0.0);
Guolin Ke's avatar
Guolin Ke committed
335
  // boosting first
Guolin Ke's avatar
Guolin Ke committed
336
  if (gradients == nullptr || hessians == nullptr) {
337
338
339
    for (int cur_tree_id = 0; cur_tree_id < num_tree_per_iteration_; ++cur_tree_id) {
      init_scores[cur_tree_id] = BoostFromAverage(cur_tree_id);
    }
Guolin Ke's avatar
Guolin Ke committed
340
    Boosting();
Guolin Ke's avatar
Guolin Ke committed
341
342
    gradients = gradients_.data();
    hessians = hessians_.data();
Guolin Ke's avatar
Guolin Ke committed
343
  }
344
345
  // bagging logic
  Bagging(iter_);
Guolin Ke's avatar
Guolin Ke committed
346

Guolin Ke's avatar
Guolin Ke committed
347
  bool should_continue = false;
348
  for (int cur_tree_id = 0; cur_tree_id < num_tree_per_iteration_; ++cur_tree_id) {
349
    const size_t bias = static_cast<size_t>(cur_tree_id) * num_data_;
350
    std::unique_ptr<Tree> new_tree(new Tree(2));
351
    if (class_need_train_[cur_tree_id] && train_data_->num_features() > 0) {
Guolin Ke's avatar
Guolin Ke committed
352
353
354
355
356
357
358
359
360
361
362
      auto grad = gradients + bias;
      auto hess = hessians + bias;
      // need to copy gradients for bagging subset.
      if (is_use_subset_ && bag_data_cnt_ < num_data_) {
        for (int i = 0; i < bag_data_cnt_; ++i) {
          gradients_[bias + i] = grad[bag_data_indices_[i]];
          hessians_[bias + i] = hess[bag_data_indices_[i]];
        }
        grad = gradients_.data() + bias;
        hess = hessians_.data() + bias;
      }
363
      new_tree.reset(tree_learner_->Train(grad, hess, is_constant_hessian_, forced_splits_json_));
364
    }
Guolin Ke's avatar
Guolin Ke committed
365

Guolin Ke's avatar
Guolin Ke committed
366
    if (new_tree->num_leaves() > 1) {
Guolin Ke's avatar
Guolin Ke committed
367
      should_continue = true;
368
369
      tree_learner_->RenewTreeOutput(new_tree.get(), objective_function_, train_score_updater_->score() + bias,
                                     num_data_, bag_data_indices_.data(), bag_data_cnt_);
Guolin Ke's avatar
Guolin Ke committed
370
371
372
      // shrinkage by learning rate
      new_tree->Shrinkage(shrinkage_rate_);
      // update score
373
      UpdateScore(new_tree.get(), cur_tree_id);
374
375
      if (std::fabs(init_scores[cur_tree_id]) > kEpsilon) {
        new_tree->AddBias(init_scores[cur_tree_id]);
Guolin Ke's avatar
Guolin Ke committed
376
      }
377
378
    } else {
      // only add default score one-time
379
380
381
382
383
384
385
386
387
      if (models_.size() < static_cast<size_t>(num_tree_per_iteration_)) {
        double output = 0.0;
        if (!class_need_train_[cur_tree_id]) {
          if (objective_function_ != nullptr) {
            output = objective_function_->BoostFromScore(cur_tree_id);
          }
        } else {
          output = init_scores[cur_tree_id];
        }
388
        new_tree->AsConstantTree(output);
Guolin Ke's avatar
Guolin Ke committed
389
        // updates scores
390
        train_score_updater_->AddScore(output, cur_tree_id);
391
        for (auto& score_updater : valid_score_updater_) {
392
          score_updater->AddScore(output, cur_tree_id);
393
394
395
        }
      }
    }
Guolin Ke's avatar
Guolin Ke committed
396
397
398
    // add model
    models_.push_back(std::move(new_tree));
  }
Guolin Ke's avatar
Guolin Ke committed
399

Guolin Ke's avatar
Guolin Ke committed
400
  if (!should_continue) {
401
    Log::Warning("Stopped training because there are no more leaves that meet the split requirements");
402
403
404
405
    if (models_.size() > static_cast<size_t>(num_tree_per_iteration_)) {
      for (int cur_tree_id = 0; cur_tree_id < num_tree_per_iteration_; ++cur_tree_id) {
        models_.pop_back();
      }
Guolin Ke's avatar
Guolin Ke committed
406
407
408
    }
    return true;
  }
409

Guolin Ke's avatar
Guolin Ke committed
410
411
  ++iter_;
  return false;
Guolin Ke's avatar
Guolin Ke committed
412
}
413

wxchan's avatar
wxchan committed
414
void GBDT::RollbackOneIter() {
415
  if (iter_ <= 0) { return; }
wxchan's avatar
wxchan committed
416
  // reset score
417
  for (int cur_tree_id = 0; cur_tree_id < num_tree_per_iteration_; ++cur_tree_id) {
Guolin Ke's avatar
Guolin Ke committed
418
    auto curr_tree = models_.size() - num_tree_per_iteration_ + cur_tree_id;
wxchan's avatar
wxchan committed
419
    models_[curr_tree]->Shrinkage(-1.0);
420
    train_score_updater_->AddScore(models_[curr_tree].get(), cur_tree_id);
wxchan's avatar
wxchan committed
421
    for (auto& score_updater : valid_score_updater_) {
422
      score_updater->AddScore(models_[curr_tree].get(), cur_tree_id);
wxchan's avatar
wxchan committed
423
424
425
    }
  }
  // remove model
426
  for (int cur_tree_id = 0; cur_tree_id < num_tree_per_iteration_; ++cur_tree_id) {
wxchan's avatar
wxchan committed
427
428
429
430
431
    models_.pop_back();
  }
  --iter_;
}

Guolin Ke's avatar
Guolin Ke committed
432
bool GBDT::EvalAndCheckEarlyStopping() {
433
434
  bool is_met_early_stopping = false;
  // print message for metric
Guolin Ke's avatar
Guolin Ke committed
435
  auto best_msg = OutputMetric(iter_);
Guolin Ke's avatar
Guolin Ke committed
436
437


Guolin Ke's avatar
Guolin Ke committed
438
  is_met_early_stopping = !best_msg.empty();
439
440
  if (is_met_early_stopping) {
    Log::Info("Early stopping at iteration %d, the best iteration round is %d",
441
              iter_, iter_ - early_stopping_round_);
Guolin Ke's avatar
Guolin Ke committed
442
    Log::Info("Output of best iteration round:\n%s", best_msg.c_str());
443
    // pop last early_stopping_round_ models
444
    for (int i = 0; i < early_stopping_round_ * num_tree_per_iteration_; ++i) {
445
446
447
448
      models_.pop_back();
    }
  }
  return is_met_early_stopping;
Guolin Ke's avatar
Guolin Ke committed
449
450
}

451
void GBDT::UpdateScore(const Tree* tree, const int cur_tree_id) {
Guolin Ke's avatar
Guolin Ke committed
452

Guolin Ke's avatar
Guolin Ke committed
453
  // update training score
Guolin Ke's avatar
Guolin Ke committed
454
  if (!is_use_subset_) {
455
    train_score_updater_->AddScore(tree_learner_.get(), tree, cur_tree_id);
Guolin Ke's avatar
Guolin Ke committed
456
457
458
459
460
461

    // we need to predict out-of-bag scores of data for boosting
    if (num_data_ - bag_data_cnt_ > 0) {
      train_score_updater_->AddScore(tree, bag_data_indices_.data() + bag_data_cnt_, num_data_ - bag_data_cnt_, cur_tree_id);
    }

Guolin Ke's avatar
Guolin Ke committed
462
  } else {
463
    train_score_updater_->AddScore(tree, cur_tree_id);
Guolin Ke's avatar
Guolin Ke committed
464
  }
Guolin Ke's avatar
Guolin Ke committed
465
466


Guolin Ke's avatar
Guolin Ke committed
467
  // update validation score
Guolin Ke's avatar
Guolin Ke committed
468
  for (auto& score_updater : valid_score_updater_) {
469
    score_updater->AddScore(tree, cur_tree_id);
Guolin Ke's avatar
Guolin Ke committed
470
471
472
  }
}

Guolin Ke's avatar
Guolin Ke committed
473
474
475
476
std::vector<double> GBDT::EvalOneMetric(const Metric* metric, const double* score) const {
  return metric->Eval(score, objective_function_);
}

Guolin Ke's avatar
Guolin Ke committed
477
std::string GBDT::OutputMetric(int iter) {
Guolin Ke's avatar
Guolin Ke committed
478
  bool need_output = (iter % config_->metric_freq) == 0;
Guolin Ke's avatar
Guolin Ke committed
479
480
  std::string ret = "";
  std::stringstream msg_buf;
481
  std::vector<std::pair<size_t, size_t>> meet_early_stopping_pairs;
Guolin Ke's avatar
Guolin Ke committed
482
  // print training metric
Guolin Ke's avatar
Guolin Ke committed
483
  if (need_output) {
484
485
    for (auto& sub_metric : training_metrics_) {
      auto name = sub_metric->GetName();
Guolin Ke's avatar
Guolin Ke committed
486
      auto scores = EvalOneMetric(sub_metric, train_score_updater_->score());
Guolin Ke's avatar
Guolin Ke committed
487
      for (size_t k = 0; k < name.size(); ++k) {
Guolin Ke's avatar
Guolin Ke committed
488
489
490
491
492
493
        std::stringstream tmp_buf;
        tmp_buf << "Iteration:" << iter
          << ", training " << name[k]
          << " : " << scores[k];
        Log::Info(tmp_buf.str().c_str());
        if (early_stopping_round_ > 0) {
494
          msg_buf << tmp_buf.str() << '\n';
Guolin Ke's avatar
Guolin Ke committed
495
        }
496
      }
497
    }
Guolin Ke's avatar
Guolin Ke committed
498
499
  }
  // print validation metric
Guolin Ke's avatar
Guolin Ke committed
500
  if (need_output || early_stopping_round_ > 0) {
501
502
    for (size_t i = 0; i < valid_metrics_.size(); ++i) {
      for (size_t j = 0; j < valid_metrics_[i].size(); ++j) {
Guolin Ke's avatar
Guolin Ke committed
503
        auto test_scores = EvalOneMetric(valid_metrics_[i][j], valid_score_updater_[i]->score());
Guolin Ke's avatar
Guolin Ke committed
504
505
506
507
508
509
510
511
512
513
        auto name = valid_metrics_[i][j]->GetName();
        for (size_t k = 0; k < name.size(); ++k) {
          std::stringstream tmp_buf;
          tmp_buf << "Iteration:" << iter
            << ", valid_" << i + 1 << " " << name[k]
            << " : " << test_scores[k];
          if (need_output) {
            Log::Info(tmp_buf.str().c_str());
          }
          if (early_stopping_round_ > 0) {
514
            msg_buf << tmp_buf.str() << '\n';
515
          }
wxchan's avatar
wxchan committed
516
        }
Guolin Ke's avatar
Guolin Ke committed
517
        if (ret.empty() && early_stopping_round_ > 0) {
518
519
520
          auto cur_score = valid_metrics_[i][j]->factor_to_bigger_better() * test_scores.back();
          if (cur_score > best_score_[i][j]) {
            best_score_[i][j] = cur_score;
521
            best_iter_[i][j] = iter;
Guolin Ke's avatar
Guolin Ke committed
522
            meet_early_stopping_pairs.emplace_back(i, j);
523
          } else {
Guolin Ke's avatar
Guolin Ke committed
524
            if (iter - best_iter_[i][j] >= early_stopping_round_) { ret = best_msg_[i][j]; }
525
          }
wxchan's avatar
wxchan committed
526
527
        }
      }
Guolin Ke's avatar
Guolin Ke committed
528
529
    }
  }
Guolin Ke's avatar
Guolin Ke committed
530
531
532
  for (auto& pair : meet_early_stopping_pairs) {
    best_msg_[pair.first][pair.second] = msg_buf.str();
  }
wxchan's avatar
wxchan committed
533
  return ret;
Guolin Ke's avatar
Guolin Ke committed
534
535
}

536
/*! \brief Get eval result */
537
std::vector<double> GBDT::GetEvalAt(int data_idx) const {
Guolin Ke's avatar
Guolin Ke committed
538
  CHECK(data_idx >= 0 && data_idx <= static_cast<int>(valid_score_updater_.size()));
539
540
  std::vector<double> ret;
  if (data_idx == 0) {
541
    for (auto& sub_metric : training_metrics_) {
Guolin Ke's avatar
Guolin Ke committed
542
      auto scores = EvalOneMetric(sub_metric, train_score_updater_->score());
543
544
545
      for (auto score : scores) {
        ret.push_back(score);
      }
546
    }
547
  } else {
548
549
    auto used_idx = data_idx - 1;
    for (size_t j = 0; j < valid_metrics_[used_idx].size(); ++j) {
Guolin Ke's avatar
Guolin Ke committed
550
      auto test_scores = EvalOneMetric(valid_metrics_[used_idx][j], valid_score_updater_[used_idx]->score());
551
552
553
      for (auto score : test_scores) {
        ret.push_back(score);
      }
554
555
556
557
558
    }
  }
  return ret;
}

Guolin Ke's avatar
Guolin Ke committed
559
/*! \brief Get training scores result */
560
const double* GBDT::GetTrainingScore(int64_t* out_len) {
561
  *out_len = static_cast<int64_t>(train_score_updater_->num_data()) * num_class_;
Guolin Ke's avatar
Guolin Ke committed
562
  return train_score_updater_->score();
563
564
}

565
566
567
void GBDT::PredictContrib(const double* features, double* output, const PredictionEarlyStopInstance* early_stop) const {
  int early_stop_round_counter = 0;
  // set zero
Guolin Ke's avatar
Guolin Ke committed
568
569
  const int num_features = max_feature_idx_ + 1;
  std::memset(output, 0, sizeof(double) * num_tree_per_iteration_ * (num_features + 1));
570
571
572
  for (int i = 0; i < num_iteration_for_pred_; ++i) {
    // predict all the trees for one iteration
    for (int k = 0; k < num_tree_per_iteration_; ++k) {
Guolin Ke's avatar
Guolin Ke committed
573
      models_[i * num_tree_per_iteration_ + k]->PredictContrib(features, num_features, output + k*(num_features + 1));
574
575
576
577
578
579
580
581
582
583
584
585
    }
    // check early stopping
    ++early_stop_round_counter;
    if (early_stop->round_period == early_stop_round_counter) {
      if (early_stop->callback_function(output, num_tree_per_iteration_)) {
        return;
      }
      early_stop_round_counter = 0;
    }
  }
}

Guolin Ke's avatar
Guolin Ke committed
586
587
void GBDT::GetPredictAt(int data_idx, double* out_result, int64_t* out_len) {
  CHECK(data_idx >= 0 && data_idx <= static_cast<int>(valid_score_updater_.size()));
Guolin Ke's avatar
Guolin Ke committed
588

589
  const double* raw_scores = nullptr;
Guolin Ke's avatar
Guolin Ke committed
590
591
  data_size_t num_data = 0;
  if (data_idx == 0) {
wxchan's avatar
wxchan committed
592
    raw_scores = GetTrainingScore(out_len);
Guolin Ke's avatar
Guolin Ke committed
593
594
595
596
597
    num_data = train_score_updater_->num_data();
  } else {
    auto used_idx = data_idx - 1;
    raw_scores = valid_score_updater_[used_idx]->score();
    num_data = valid_score_updater_[used_idx]->num_data();
598
    *out_len = static_cast<int64_t>(num_data) * num_class_;
Guolin Ke's avatar
Guolin Ke committed
599
  }
Guolin Ke's avatar
Guolin Ke committed
600
  if (objective_function_ != nullptr && !average_output_) {
Guolin Ke's avatar
Guolin Ke committed
601
602
    #pragma omp parallel for schedule(static)
    for (data_size_t i = 0; i < num_data; ++i) {
Guolin Ke's avatar
Guolin Ke committed
603
      std::vector<double> tree_pred(num_tree_per_iteration_);
604
      for (int j = 0; j < num_tree_per_iteration_; ++j) {
Guolin Ke's avatar
Guolin Ke committed
605
        tree_pred[j] = raw_scores[j * num_data + i];
606
      }
Guolin Ke's avatar
Guolin Ke committed
607
608
      std::vector<double> tmp_result(num_class_);
      objective_function_->ConvertOutput(tree_pred.data(), tmp_result.data());
Guolin Ke's avatar
Guolin Ke committed
609
      for (int j = 0; j < num_class_; ++j) {
610
        out_result[j * num_data + i] = static_cast<double>(tmp_result[j]);
Guolin Ke's avatar
Guolin Ke committed
611
612
      }
    }
613
  } else {
Guolin Ke's avatar
Guolin Ke committed
614
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
615
    for (data_size_t i = 0; i < num_data; ++i) {
616
      for (int j = 0; j < num_tree_per_iteration_; ++j) {
Guolin Ke's avatar
Guolin Ke committed
617
        out_result[j * num_data + i] = static_cast<double>(raw_scores[j * num_data + i]);
Guolin Ke's avatar
Guolin Ke committed
618
619
620
621
622
      }
    }
  }
}

Guolin Ke's avatar
Guolin Ke committed
623
624
void GBDT::ResetTrainingData(const Dataset* train_data, const ObjectiveFunction* objective_function,
                             const std::vector<const Metric*>& training_metrics) {
Guolin Ke's avatar
Guolin Ke committed
625

Guolin Ke's avatar
Guolin Ke committed
626
  if (train_data != train_data_ && !train_data_->CheckAlign(*train_data)) {
627
    Log::Fatal("Cannot reset training data, since new training data has different bin mappers");
wxchan's avatar
wxchan committed
628
629
  }

Guolin Ke's avatar
Guolin Ke committed
630
631
632
633
634
635
  objective_function_ = objective_function;
  if (objective_function_ != nullptr) {
    is_constant_hessian_ = objective_function_->IsConstantHessian();
    CHECK(num_tree_per_iteration_ == objective_function_->NumModelPerIteration());
  } else {
    is_constant_hessian_ = false;
636
637
  }

Guolin Ke's avatar
Guolin Ke committed
638
639
640
641
  // push training metrics
  training_metrics_.clear();
  for (const auto& metric : training_metrics) {
    training_metrics_.push_back(metric);
642
  }
Guolin Ke's avatar
Guolin Ke committed
643
  training_metrics_.shrink_to_fit();
644

Guolin Ke's avatar
Guolin Ke committed
645
646
647
648
649
  if (train_data != train_data_) {
    train_data_ = train_data;
    // not same training data, need reset score and others
    // create score tracker
    train_score_updater_.reset(new ScoreUpdater(train_data_, num_tree_per_iteration_));
650

Guolin Ke's avatar
Guolin Ke committed
651
652
653
654
655
656
    // update score
    for (int i = 0; i < iter_; ++i) {
      for (int cur_tree_id = 0; cur_tree_id < num_tree_per_iteration_; ++cur_tree_id) {
        auto curr_tree = (i + num_init_iteration_) * num_tree_per_iteration_ + cur_tree_id;
        train_score_updater_->AddScore(models_[curr_tree].get(), cur_tree_id);
      }
657
658
    }

Guolin Ke's avatar
Guolin Ke committed
659
    num_data_ = train_data_->num_data();
660

Guolin Ke's avatar
Guolin Ke committed
661
662
663
664
665
666
    // create buffer for gradients and hessians
    if (objective_function_ != nullptr) {
      size_t total_size = static_cast<size_t>(num_data_) * num_tree_per_iteration_;
      gradients_.resize(total_size);
      hessians_.resize(total_size);
    }
667

Guolin Ke's avatar
Guolin Ke committed
668
669
670
671
    max_feature_idx_ = train_data_->num_total_features() - 1;
    label_idx_ = train_data_->label_idx();
    feature_names_ = train_data_->feature_names();
    feature_infos_ = train_data_->feature_infos();
672

Guolin Ke's avatar
Guolin Ke committed
673
    tree_learner_->ResetTrainingData(train_data);
Guolin Ke's avatar
Guolin Ke committed
674
    ResetBaggingConfig(config_.get(), true);
675
  }
676
677
}

Guolin Ke's avatar
Guolin Ke committed
678
679
void GBDT::ResetConfig(const Config* config) {
  auto new_config = std::unique_ptr<Config>(new Config(*config));
Guolin Ke's avatar
Guolin Ke committed
680
681
682
  early_stopping_round_ = new_config->early_stopping_round;
  shrinkage_rate_ = new_config->learning_rate;
  if (tree_learner_ != nullptr) {
Guolin Ke's avatar
Guolin Ke committed
683
    tree_learner_->ResetConfig(new_config.get());
684
  }
Guolin Ke's avatar
Guolin Ke committed
685
686
  if (train_data_ != nullptr) {
    ResetBaggingConfig(new_config.get(), false);
687
  }
Guolin Ke's avatar
Guolin Ke committed
688
  config_.reset(new_config.release());
Guolin Ke's avatar
Guolin Ke committed
689
690
}

Guolin Ke's avatar
Guolin Ke committed
691
void GBDT::ResetBaggingConfig(const Config* config, bool is_change_dataset) {
Guolin Ke's avatar
Guolin Ke committed
692
693
694
695
696
697
  // if need bagging, create buffer
  if (config->bagging_fraction < 1.0 && config->bagging_freq > 0) {
    bag_data_cnt_ =
      static_cast<data_size_t>(config->bagging_fraction * num_data_);
    bag_data_indices_.resize(num_data_);
    tmp_indices_.resize(num_data_);
698

Guolin Ke's avatar
Guolin Ke committed
699
700
701
702
703
    offsets_buf_.resize(num_threads_);
    left_cnts_buf_.resize(num_threads_);
    right_cnts_buf_.resize(num_threads_);
    left_write_pos_buf_.resize(num_threads_);
    right_write_pos_buf_.resize(num_threads_);
704

Guolin Ke's avatar
Guolin Ke committed
705
706
707
708
709
710
    double average_bag_rate = config->bagging_fraction / config->bagging_freq;
    int sparse_group = 0;
    for (int i = 0; i < train_data_->num_feature_groups(); ++i) {
      if (train_data_->FeatureGroupIsSparse(i)) {
        ++sparse_group;
      }
Guolin Ke's avatar
Guolin Ke committed
711
    }
Guolin Ke's avatar
Guolin Ke committed
712
713
714
715
716
717
718
719
720
721
    is_use_subset_ = false;
    const int group_threshold_usesubset = 100;
    const int sparse_group_threshold_usesubset = train_data_->num_feature_groups() / 4;
    if (average_bag_rate <= 0.5
        && (train_data_->num_feature_groups() < group_threshold_usesubset || sparse_group < sparse_group_threshold_usesubset)) {
      if (tmp_subset_ == nullptr || is_change_dataset) {
        tmp_subset_.reset(new Dataset(bag_data_cnt_));
        tmp_subset_->CopyFeatureMapperFrom(train_data_);
      }
      is_use_subset_ = true;
722
      Log::Debug("Use subset for bagging");
Guolin Ke's avatar
Guolin Ke committed
723
724
    }

Guolin Ke's avatar
Guolin Ke committed
725
726
    if (is_change_dataset) {
      need_re_bagging_ = true;
Guolin Ke's avatar
Guolin Ke committed
727
    }
728

Guolin Ke's avatar
Guolin Ke committed
729
730
731
732
733
    if (is_use_subset_ && bag_data_cnt_ < num_data_) {
      if (objective_function_ == nullptr) {
        size_t total_size = static_cast<size_t>(num_data_) * num_tree_per_iteration_;
        gradients_.resize(total_size);
        hessians_.resize(total_size);
734
      }
735
    }
736
  } else {
Guolin Ke's avatar
Guolin Ke committed
737
738
739
740
    bag_data_cnt_ = num_data_;
    bag_data_indices_.clear();
    tmp_indices_.clear();
    is_use_subset_ = false;
741
  }
wxchan's avatar
wxchan committed
742
743
}

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