gbdt.cpp 29.5 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
7
#include "gbdt.h"

#include <LightGBM/metric.h>
Guolin Ke's avatar
Guolin Ke committed
8
#include <LightGBM/network.h>
9
10
11
12
#include <LightGBM/objective_function.h>
#include <LightGBM/prediction_early_stop.h>
#include <LightGBM/utils/common.h>
#include <LightGBM/utils/openmp_wrapper.h>
Guolin Ke's avatar
Guolin Ke committed
13

14
15
16
17
#include <chrono>
#include <ctime>
#include <sstream>

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

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
GBDT::GBDT()
    : iter_(0),
      train_data_(nullptr),
      objective_function_(nullptr),
      early_stopping_round_(0),
      es_first_metric_only_(false),
      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),
      balanced_bagging_(false),
      bagging_runner_(0, bagging_rand_block_) {
Guolin Ke's avatar
Guolin Ke committed
35
  average_output_ = false;
Guolin Ke's avatar
Guolin Ke committed
36
  tree_learner_ = nullptr;
Guolin Ke's avatar
Guolin Ke committed
37
38
39
40
41
}

GBDT::~GBDT() {
}

Guolin Ke's avatar
Guolin Ke committed
42
void GBDT::Init(const Config* config, const Dataset* train_data, const ObjectiveFunction* objective_function,
43
                const std::vector<const Metric*>& training_metrics) {
Nikita Titov's avatar
Nikita Titov committed
44
  CHECK_NOTNULL(train_data);
45
  train_data_ = train_data;
46
  if (!config->monotone_constraints.empty()) {
Nikita Titov's avatar
Nikita Titov committed
47
    CHECK_EQ(static_cast<size_t>(train_data_->num_total_features()), config->monotone_constraints.size());
Nikita Titov's avatar
Nikita Titov committed
48
  }
49
  if (!config->feature_contri.empty()) {
Nikita Titov's avatar
Nikita Titov committed
50
    CHECK_EQ(static_cast<size_t>(train_data_->num_total_features()), config->feature_contri.size());
51
  }
52
  iter_ = 0;
wxchan's avatar
wxchan committed
53
  num_iteration_for_pred_ = 0;
54
  max_feature_idx_ = 0;
wxchan's avatar
wxchan committed
55
  num_class_ = config->num_class;
Guolin Ke's avatar
Guolin Ke committed
56
57
  config_ = std::unique_ptr<Config>(new Config(*config));
  early_stopping_round_ = config_->early_stopping_round;
58
  es_first_metric_only_ = config_->first_metric_only;
Guolin Ke's avatar
Guolin Ke committed
59
  shrinkage_rate_ = config_->learning_rate;
60

61
  // load forced_splits file
62
63
64
65
66
  if (!config->forcedsplits_filename.empty()) {
    std::ifstream forced_splits_file(config->forcedsplits_filename.c_str());
    std::stringstream buffer;
    buffer << forced_splits_file.rdbuf();
    std::string err;
Guolin Ke's avatar
Guolin Ke committed
67
    forced_splits_json_ = Json::parse(buffer.str(), &err);
68
69
  }

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

76
77
  is_constant_hessian_ = GetIsConstHessian(objective_function);

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

  // init tree learner
  tree_learner_->Init(train_data_, is_constant_hessian_);
82
  tree_learner_->SetForcedSplit(&forced_splits_json_);
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

  // 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();
107
  monotone_constraints_ = config->monotone_constraints;
108
109

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

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

void GBDT::AddValidDataset(const Dataset* valid_data,
122
                           const std::vector<const Metric*>& valid_metrics) {
wxchan's avatar
wxchan committed
123
  if (!train_data_->CheckAlign(*valid_data)) {
124
    Log::Fatal("Cannot add validation data, since it has different bin mappers with training data");
125
  }
Guolin Ke's avatar
Guolin Ke committed
126
  // for a validation dataset, we need its score and metric
127
  auto new_score_updater = std::unique_ptr<ScoreUpdater>(new ScoreUpdater(valid_data, num_tree_per_iteration_));
wxchan's avatar
wxchan committed
128
129
  // update score
  for (int i = 0; i < iter_; ++i) {
130
131
132
    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
133
134
    }
  }
Guolin Ke's avatar
Guolin Ke committed
135
  valid_score_updater_.push_back(std::move(new_score_updater));
Guolin Ke's avatar
Guolin Ke committed
136
137
138
139
  valid_metrics_.emplace_back();
  for (const auto& metric : valid_metrics) {
    valid_metrics_.back().push_back(metric);
  }
Guolin Ke's avatar
Guolin Ke committed
140
  valid_metrics_.back().shrink_to_fit();
141

142
143
144
145
146
147
148
  if (early_stopping_round_ > 0) {
    auto num_metrics = valid_metrics.size();
    if (es_first_metric_only_) { num_metrics = 1; }
    best_iter_.emplace_back(num_metrics, 0);
    best_score_.emplace_back(num_metrics, kMinScore);
    best_msg_.emplace_back(num_metrics);
  }
Guolin Ke's avatar
Guolin Ke committed
149
150
}

Guolin Ke's avatar
Guolin Ke committed
151
void GBDT::Boosting() {
152
  Common::FunctionTimer fun_timer("GBDT::Boosting", global_timer);
Guolin Ke's avatar
Guolin Ke committed
153
154
155
156
157
158
159
160
161
  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());
}

162
data_size_t GBDT::BaggingHelper(data_size_t start, data_size_t cnt, data_size_t* buffer) {
163
164
165
  if (cnt <= 0) {
    return 0;
  }
166
  data_size_t cur_left_cnt = 0;
167
  data_size_t cur_right_pos = cnt;
168
169
  // random bagging, minimal unit is one record
  for (data_size_t i = 0; i < cnt; ++i) {
170
171
172
    auto cur_idx = start + i;
    if (bagging_rands_[cur_idx / bagging_rand_block_].NextFloat() < config_->bagging_fraction) {
      buffer[cur_left_cnt++] = cur_idx;
173
    } else {
174
      buffer[--cur_right_pos] = cur_idx;
175
176
177
178
    }
  }
  return cur_left_cnt;
}
Guolin Ke's avatar
Guolin Ke committed
179

180
181
data_size_t GBDT::BalancedBaggingHelper(data_size_t start, data_size_t cnt,
                                        data_size_t* buffer) {
Guolin Ke's avatar
Guolin Ke committed
182
183
184
185
186
  if (cnt <= 0) {
    return 0;
  }
  auto label_ptr = train_data_->metadata().label();
  data_size_t cur_left_cnt = 0;
187
  data_size_t cur_right_pos = cnt;
Guolin Ke's avatar
Guolin Ke committed
188
189
  // random bagging, minimal unit is one record
  for (data_size_t i = 0; i < cnt; ++i) {
190
    auto cur_idx = start + i;
Guolin Ke's avatar
Guolin Ke committed
191
192
193
    bool is_pos = label_ptr[start + i] > 0;
    bool is_in_bag = false;
    if (is_pos) {
194
195
      is_in_bag = bagging_rands_[cur_idx / bagging_rand_block_].NextFloat() <
                  config_->pos_bagging_fraction;
Guolin Ke's avatar
Guolin Ke committed
196
    } else {
197
198
      is_in_bag = bagging_rands_[cur_idx / bagging_rand_block_].NextFloat() <
                  config_->neg_bagging_fraction;
Guolin Ke's avatar
Guolin Ke committed
199
200
    }
    if (is_in_bag) {
201
      buffer[cur_left_cnt++] = cur_idx;
Guolin Ke's avatar
Guolin Ke committed
202
    } else {
203
      buffer[--cur_right_pos] = cur_idx;
Guolin Ke's avatar
Guolin Ke committed
204
205
206
207
208
    }
  }
  return cur_left_cnt;
}

209
void GBDT::Bagging(int iter) {
210
  Common::FunctionTimer fun_timer("GBDT::Bagging", global_timer);
Guolin Ke's avatar
Guolin Ke committed
211
  // if need bagging
Guolin Ke's avatar
Guolin Ke committed
212
213
  if ((bag_data_cnt_ < num_data_ && iter % config_->bagging_freq == 0) ||
      need_re_bagging_) {
Guolin Ke's avatar
Guolin Ke committed
214
    need_re_bagging_ = false;
215
216
217
218
219
220
221
222
    auto left_cnt = bagging_runner_.Run<true>(
        num_data_,
        [=](int, data_size_t cur_start, data_size_t cur_cnt, data_size_t* left,
            data_size_t*) {
          data_size_t cur_left_count = 0;
          if (balanced_bagging_) {
            cur_left_count =
                BalancedBaggingHelper(cur_start, cur_cnt, left);
Guolin Ke's avatar
Guolin Ke committed
223
          } else {
224
            cur_left_count = BaggingHelper(cur_start, cur_cnt, left);
Guolin Ke's avatar
Guolin Ke committed
225
          }
226
227
228
          return cur_left_count;
        },
        bag_data_indices_.data());
Guolin Ke's avatar
Guolin Ke committed
229
    bag_data_cnt_ = left_cnt;
Guolin Ke's avatar
Guolin Ke committed
230
    Log::Debug("Re-bagging, using %d data to train", bag_data_cnt_);
Guolin Ke's avatar
Guolin Ke committed
231
    // set bagging data to tree learner
Guolin Ke's avatar
Guolin Ke committed
232
    if (!is_use_subset_) {
233
      tree_learner_->SetBaggingData(nullptr, bag_data_indices_.data(), bag_data_cnt_);
Guolin Ke's avatar
Guolin Ke committed
234
235
    } else {
      // get subset
Guolin Ke's avatar
Guolin Ke committed
236
      tmp_subset_->ReSize(bag_data_cnt_);
237
      tmp_subset_->CopySubrow(train_data_, bag_data_indices_.data(),
Guolin Ke's avatar
Guolin Ke committed
238
                              bag_data_cnt_, false);
239
240
      tree_learner_->SetBaggingData(tmp_subset_.get(), bag_data_indices_.data(),
                                    bag_data_cnt_);
Guolin Ke's avatar
Guolin Ke committed
241
    }
Guolin Ke's avatar
Guolin Ke committed
242
243
244
  }
}

Guolin Ke's avatar
Guolin Ke committed
245
void GBDT::Train(int snapshot_freq, const std::string& model_output_path) {
246
  Common::FunctionTimer fun_timer("GBDT::Train", global_timer);
Guolin Ke's avatar
Guolin Ke committed
247
248
  bool is_finished = false;
  auto start_time = std::chrono::steady_clock::now();
Guolin Ke's avatar
Guolin Ke committed
249
  for (int iter = 0; iter < config_->num_iterations && !is_finished; ++iter) {
Guolin Ke's avatar
Guolin Ke committed
250
251
252
253
    is_finished = TrainOneIter(nullptr, nullptr);
    if (!is_finished) {
      is_finished = EvalAndCheckEarlyStopping();
    }
Guolin Ke's avatar
Guolin Ke committed
254
255
256
257
258
259
260
    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);
261
      SaveModelToFile(0, -1, config_->saved_feature_importance_type, snapshot_out.c_str());
Guolin Ke's avatar
Guolin Ke committed
262
263
264
265
    }
  }
}

266
void GBDT::RefitTree(const std::vector<std::vector<int>>& tree_leaf_prediction) {
267
268
269
  CHECK_GT(tree_leaf_prediction.size(), 0);
  CHECK_EQ(static_cast<size_t>(num_data_), tree_leaf_prediction.size());
  CHECK_EQ(static_cast<size_t>(models_.size()), tree_leaf_prediction[0].size());
270
271
272
273
274
275
276
277
278
  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];
Nikita Titov's avatar
Nikita Titov committed
279
        CHECK_LT(leaf_pred[i], models_[model_index]->num_leaves());
280
      }
281
282
283
      size_t offset = static_cast<size_t>(tree_id) * num_data_;
      auto grad = gradients_.data() + offset;
      auto hess = hessians_.data() + offset;
284
285
286
287
288
289
290
      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);
    }
  }
}

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;
}

Guolin Ke's avatar
Guolin Ke committed
312
double GBDT::BoostFromAverage(int class_id, bool update_scorer) {
313
  Common::FunctionTimer fun_timer("GBDT::BoostFromAverage", global_timer);
314
  // boosting from average label; or customized "average" if implemented for the current objective
315
316
317
  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);
318
      if (std::fabs(init_score) > kEpsilon) {
Guolin Ke's avatar
Guolin Ke committed
319
320
321
322
323
        if (update_scorer) {
          train_score_updater_->AddScore(init_score, class_id);
          for (auto& score_updater : valid_score_updater_) {
            score_updater->AddScore(init_score, class_id);
          }
324
325
326
        }
        Log::Info("Start training from score %lf", init_score);
        return init_score;
Guolin Ke's avatar
Guolin Ke committed
327
      }
328
329
330
    } 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")) {
331
      Log::Warning("Disabling boost_from_average in %s may cause the slow convergence", objective_function_->GetName());
332
    }
333
  }
Guolin Ke's avatar
Guolin Ke committed
334
335
  return 0.0f;
}
Guolin Ke's avatar
Guolin Ke committed
336

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

Guolin Ke's avatar
Guolin Ke committed
352
  bool should_continue = false;
353
  for (int cur_tree_id = 0; cur_tree_id < num_tree_per_iteration_; ++cur_tree_id) {
354
    const size_t offset = static_cast<size_t>(cur_tree_id) * num_data_;
355
    std::unique_ptr<Tree> new_tree(new Tree(2, false));
356
    if (class_need_train_[cur_tree_id] && train_data_->num_features() > 0) {
357
358
      auto grad = gradients + offset;
      auto hess = hessians + offset;
Guolin Ke's avatar
Guolin Ke committed
359
360
361
      // 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) {
362
363
          gradients_[offset + i] = grad[bag_data_indices_[i]];
          hessians_[offset + i] = hess[bag_data_indices_[i]];
Guolin Ke's avatar
Guolin Ke committed
364
        }
365
366
        grad = gradients_.data() + offset;
        hess = hessians_.data() + offset;
Guolin Ke's avatar
Guolin Ke committed
367
      }
368
      new_tree.reset(tree_learner_->Train(grad, hess));
369
    }
Guolin Ke's avatar
Guolin Ke committed
370

Guolin Ke's avatar
Guolin Ke committed
371
    if (new_tree->num_leaves() > 1) {
Guolin Ke's avatar
Guolin Ke committed
372
      should_continue = true;
373
      auto score_ptr = train_score_updater_->score() + offset;
374
375
      auto residual_getter = [score_ptr](const label_t* label, int i) {return static_cast<double>(label[i]) - score_ptr[i]; };
      tree_learner_->RenewTreeOutput(new_tree.get(), objective_function_, residual_getter,
376
                                     num_data_, bag_data_indices_.data(), bag_data_cnt_);
Guolin Ke's avatar
Guolin Ke committed
377
378
379
      // shrinkage by learning rate
      new_tree->Shrinkage(shrinkage_rate_);
      // update score
380
      UpdateScore(new_tree.get(), cur_tree_id);
381
382
      if (std::fabs(init_scores[cur_tree_id]) > kEpsilon) {
        new_tree->AddBias(init_scores[cur_tree_id]);
Guolin Ke's avatar
Guolin Ke committed
383
      }
384
385
    } else {
      // only add default score one-time
386
387
388
389
390
391
392
393
394
      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];
        }
395
        new_tree->AsConstantTree(output);
Guolin Ke's avatar
Guolin Ke committed
396
        // updates scores
397
        train_score_updater_->AddScore(output, cur_tree_id);
398
        for (auto& score_updater : valid_score_updater_) {
399
          score_updater->AddScore(output, cur_tree_id);
400
401
402
        }
      }
    }
Guolin Ke's avatar
Guolin Ke committed
403
404
405
    // add model
    models_.push_back(std::move(new_tree));
  }
Guolin Ke's avatar
Guolin Ke committed
406

Guolin Ke's avatar
Guolin Ke committed
407
  if (!should_continue) {
408
    Log::Warning("Stopped training because there are no more leaves that meet the split requirements");
409
410
411
412
    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
413
414
415
    }
    return true;
  }
416

Guolin Ke's avatar
Guolin Ke committed
417
418
  ++iter_;
  return false;
Guolin Ke's avatar
Guolin Ke committed
419
}
420

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

Guolin Ke's avatar
Guolin Ke committed
439
bool GBDT::EvalAndCheckEarlyStopping() {
440
441
  bool is_met_early_stopping = false;
  // print message for metric
Guolin Ke's avatar
Guolin Ke committed
442
  auto best_msg = OutputMetric(iter_);
Guolin Ke's avatar
Guolin Ke committed
443
444


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

458
void GBDT::UpdateScore(const Tree* tree, const int cur_tree_id) {
459
  Common::FunctionTimer fun_timer("GBDT::UpdateScore", global_timer);
Guolin Ke's avatar
Guolin Ke committed
460
  // update training score
Guolin Ke's avatar
Guolin Ke committed
461
  if (!is_use_subset_) {
462
    train_score_updater_->AddScore(tree_learner_.get(), tree, cur_tree_id);
Guolin Ke's avatar
Guolin Ke committed
463
464
465
466
467
468

    // 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
469
  } else {
470
    train_score_updater_->AddScore(tree, cur_tree_id);
Guolin Ke's avatar
Guolin Ke committed
471
  }
Guolin Ke's avatar
Guolin Ke committed
472
473


Guolin Ke's avatar
Guolin Ke committed
474
  // update validation score
Guolin Ke's avatar
Guolin Ke committed
475
  for (auto& score_updater : valid_score_updater_) {
476
    score_updater->AddScore(tree, cur_tree_id);
Guolin Ke's avatar
Guolin Ke committed
477
478
479
  }
}

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

544
/*! \brief Get eval result */
545
std::vector<double> GBDT::GetEvalAt(int data_idx) const {
Guolin Ke's avatar
Guolin Ke committed
546
  CHECK(data_idx >= 0 && data_idx <= static_cast<int>(valid_score_updater_.size()));
547
548
  std::vector<double> ret;
  if (data_idx == 0) {
549
    for (auto& sub_metric : training_metrics_) {
Guolin Ke's avatar
Guolin Ke committed
550
      auto scores = EvalOneMetric(sub_metric, train_score_updater_->score());
551
552
553
      for (auto score : scores) {
        ret.push_back(score);
      }
554
    }
555
  } else {
556
557
    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
558
      auto test_scores = EvalOneMetric(valid_metrics_[used_idx][j], valid_score_updater_[used_idx]->score());
559
560
561
      for (auto score : test_scores) {
        ret.push_back(score);
      }
562
563
564
565
566
    }
  }
  return ret;
}

Guolin Ke's avatar
Guolin Ke committed
567
/*! \brief Get training scores result */
568
const double* GBDT::GetTrainingScore(int64_t* out_len) {
569
  *out_len = static_cast<int64_t>(train_score_updater_->num_data()) * num_class_;
Guolin Ke's avatar
Guolin Ke committed
570
  return train_score_updater_->score();
571
572
}

573
void GBDT::PredictContrib(const double* features, double* output) const {
574
  // set zero
Guolin Ke's avatar
Guolin Ke committed
575
576
  const int num_features = max_feature_idx_ + 1;
  std::memset(output, 0, sizeof(double) * num_tree_per_iteration_ * (num_features + 1));
577
578
  const int end_iteration_for_pred = start_iteration_for_pred_ + num_iteration_for_pred_;
  for (int i = start_iteration_for_pred_; i < end_iteration_for_pred; ++i) {
579
580
    // predict all the trees for one iteration
    for (int k = 0; k < num_tree_per_iteration_; ++k) {
Guolin Ke's avatar
Guolin Ke committed
581
      models_[i * num_tree_per_iteration_ + k]->PredictContrib(features, num_features, output + k*(num_features + 1));
582
    }
583
584
585
586
587
588
  }
}

void GBDT::PredictContribByMap(const std::unordered_map<int, double>& features,
                               std::vector<std::unordered_map<int, double>>* output) const {
  const int num_features = max_feature_idx_ + 1;
589
590
  const int end_iteration_for_pred = start_iteration_for_pred_ + num_iteration_for_pred_;
  for (int i = start_iteration_for_pred_; i < end_iteration_for_pred; ++i) {
591
592
593
    // predict all the trees for one iteration
    for (int k = 0; k < num_tree_per_iteration_; ++k) {
      models_[i * num_tree_per_iteration_ + k]->PredictContribByMap(features, num_features, &((*output)[k]));
594
595
596
597
    }
  }
}

Guolin Ke's avatar
Guolin Ke committed
598
599
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
600

601
  const double* raw_scores = nullptr;
Guolin Ke's avatar
Guolin Ke committed
602
603
  data_size_t num_data = 0;
  if (data_idx == 0) {
wxchan's avatar
wxchan committed
604
    raw_scores = GetTrainingScore(out_len);
Guolin Ke's avatar
Guolin Ke committed
605
606
607
608
609
    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();
610
    *out_len = static_cast<int64_t>(num_data) * num_class_;
Guolin Ke's avatar
Guolin Ke committed
611
  }
Guolin Ke's avatar
Guolin Ke committed
612
  if (objective_function_ != nullptr) {
Guolin Ke's avatar
Guolin Ke committed
613
614
    #pragma omp parallel for schedule(static)
    for (data_size_t i = 0; i < num_data; ++i) {
Guolin Ke's avatar
Guolin Ke committed
615
      std::vector<double> tree_pred(num_tree_per_iteration_);
616
      for (int j = 0; j < num_tree_per_iteration_; ++j) {
Guolin Ke's avatar
Guolin Ke committed
617
        tree_pred[j] = raw_scores[j * num_data + i];
618
      }
Guolin Ke's avatar
Guolin Ke committed
619
620
      std::vector<double> tmp_result(num_class_);
      objective_function_->ConvertOutput(tree_pred.data(), tmp_result.data());
Guolin Ke's avatar
Guolin Ke committed
621
      for (int j = 0; j < num_class_; ++j) {
622
        out_result[j * num_data + i] = static_cast<double>(tmp_result[j]);
Guolin Ke's avatar
Guolin Ke committed
623
624
      }
    }
625
  } else {
Guolin Ke's avatar
Guolin Ke committed
626
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
627
    for (data_size_t i = 0; i < num_data; ++i) {
628
      for (int j = 0; j < num_tree_per_iteration_; ++j) {
Guolin Ke's avatar
Guolin Ke committed
629
        out_result[j * num_data + i] = static_cast<double>(raw_scores[j * num_data + i]);
Guolin Ke's avatar
Guolin Ke committed
630
631
632
633
634
      }
    }
  }
}

635
636
double GBDT::GetUpperBoundValue() const {
  double max_value = 0.0;
Nikita Titov's avatar
Nikita Titov committed
637
  for (const auto &tree : models_) {
638
639
640
641
642
643
644
    max_value += tree->GetUpperBoundValue();
  }
  return max_value;
}

double GBDT::GetLowerBoundValue() const {
  double min_value = 0.0;
Nikita Titov's avatar
Nikita Titov committed
645
  for (const auto &tree : models_) {
646
647
648
649
650
    min_value += tree->GetLowerBoundValue();
  }
  return min_value;
}

Guolin Ke's avatar
Guolin Ke committed
651
652
653
void GBDT::ResetTrainingData(const Dataset* train_data, const ObjectiveFunction* objective_function,
                             const std::vector<const Metric*>& training_metrics) {
  if (train_data != train_data_ && !train_data_->CheckAlign(*train_data)) {
654
    Log::Fatal("Cannot reset training data, since new training data has different bin mappers");
wxchan's avatar
wxchan committed
655
656
  }

Guolin Ke's avatar
Guolin Ke committed
657
658
  objective_function_ = objective_function;
  if (objective_function_ != nullptr) {
Nikita Titov's avatar
Nikita Titov committed
659
    CHECK_EQ(num_tree_per_iteration_, objective_function_->NumModelPerIteration());
660
  }
661
  is_constant_hessian_ = GetIsConstHessian(objective_function);
662

Guolin Ke's avatar
Guolin Ke committed
663
664
665
666
  // push training metrics
  training_metrics_.clear();
  for (const auto& metric : training_metrics) {
    training_metrics_.push_back(metric);
667
  }
Guolin Ke's avatar
Guolin Ke committed
668
  training_metrics_.shrink_to_fit();
669

Guolin Ke's avatar
Guolin Ke committed
670
671
672
673
674
  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_));
675

Guolin Ke's avatar
Guolin Ke committed
676
677
678
679
680
681
    // 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);
      }
682
683
    }

Guolin Ke's avatar
Guolin Ke committed
684
    num_data_ = train_data_->num_data();
685

Guolin Ke's avatar
Guolin Ke committed
686
687
688
689
690
691
    // 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);
    }
692

Guolin Ke's avatar
Guolin Ke committed
693
694
695
696
    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();
697

698
    tree_learner_->ResetTrainingData(train_data, is_constant_hessian_);
Guolin Ke's avatar
Guolin Ke committed
699
    ResetBaggingConfig(config_.get(), true);
700
701
  } else {
    tree_learner_->ResetIsConstantHessian(is_constant_hessian_);
702
  }
703
704
}

Guolin Ke's avatar
Guolin Ke committed
705
706
void GBDT::ResetConfig(const Config* config) {
  auto new_config = std::unique_ptr<Config>(new Config(*config));
707
  if (!config->monotone_constraints.empty()) {
Nikita Titov's avatar
Nikita Titov committed
708
    CHECK_EQ(static_cast<size_t>(train_data_->num_total_features()), config->monotone_constraints.size());
709
710
  }
  if (!config->feature_contri.empty()) {
Nikita Titov's avatar
Nikita Titov committed
711
    CHECK_EQ(static_cast<size_t>(train_data_->num_total_features()), config->feature_contri.size());
712
  }
Guolin Ke's avatar
Guolin Ke committed
713
714
715
  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
716
    tree_learner_->ResetConfig(new_config.get());
717
  }
Guolin Ke's avatar
Guolin Ke committed
718
719
  if (train_data_ != nullptr) {
    ResetBaggingConfig(new_config.get(), false);
720
  }
721
722
723
724
725
726
727
728
  if (config_->forcedsplits_filename != new_config->forcedbins_filename) {
    // load forced_splits file
    if (!new_config->forcedsplits_filename.empty()) {
      std::ifstream forced_splits_file(
          new_config->forcedsplits_filename.c_str());
      std::stringstream buffer;
      buffer << forced_splits_file.rdbuf();
      std::string err;
Guolin Ke's avatar
Guolin Ke committed
729
      forced_splits_json_ = Json::parse(buffer.str(), &err);
730
731
732
733
734
735
      tree_learner_->SetForcedSplit(&forced_splits_json_);
    } else {
      forced_splits_json_ = Json();
      tree_learner_->SetForcedSplit(nullptr);
    }
  }
Guolin Ke's avatar
Guolin Ke committed
736
  config_.reset(new_config.release());
Guolin Ke's avatar
Guolin Ke committed
737
738
}

Guolin Ke's avatar
Guolin Ke committed
739
void GBDT::ResetBaggingConfig(const Config* config, bool is_change_dataset) {
Guolin Ke's avatar
Guolin Ke committed
740
  // if need bagging, create buffer
Guolin Ke's avatar
Guolin Ke committed
741
742
743
744
745
746
  data_size_t num_pos_data = 0;
  if (objective_function_ != nullptr) {
    num_pos_data = objective_function_->NumPositiveData();
  }
  bool balance_bagging_cond = (config->pos_bagging_fraction < 1.0 || config->neg_bagging_fraction < 1.0) && (num_pos_data > 0);
  if ((config->bagging_fraction < 1.0 || balance_bagging_cond) && config->bagging_freq > 0) {
747
748
    need_re_bagging_ = false;
    if (!is_change_dataset &&
Guolin Ke's avatar
Guolin Ke committed
749
750
      config_.get() != nullptr && config_->bagging_fraction == config->bagging_fraction && config_->bagging_freq == config->bagging_freq
      && config_->pos_bagging_fraction == config->pos_bagging_fraction && config_->neg_bagging_fraction == config->neg_bagging_fraction) {
751
752
      return;
    }
Guolin Ke's avatar
Guolin Ke committed
753
754
    if (balance_bagging_cond) {
      balanced_bagging_ = true;
755
      bag_data_cnt_ = static_cast<data_size_t>(num_pos_data * config->pos_bagging_fraction)
Guolin Ke's avatar
Guolin Ke committed
756
757
758
759
                      + static_cast<data_size_t>((num_data_ - num_pos_data) * config->neg_bagging_fraction);
    } else {
      bag_data_cnt_ = static_cast<data_size_t>(config->bagging_fraction * num_data_);
    }
Guolin Ke's avatar
Guolin Ke committed
760
    bag_data_indices_.resize(num_data_);
761
762
763
764
765
766
    bagging_runner_.ReSize(num_data_);
    bagging_rands_.clear();
    for (int i = 0;
         i < (num_data_ + bagging_rand_block_ - 1) / bagging_rand_block_; ++i) {
      bagging_rands_.emplace_back(config_->bagging_seed + i);
    }
767

768
769
    double average_bag_rate =
        (static_cast<double>(bag_data_cnt_) / num_data_) / config->bagging_freq;
Guolin Ke's avatar
Guolin Ke committed
770
771
    is_use_subset_ = false;
    const int group_threshold_usesubset = 100;
772
    if (average_bag_rate <= 0.5
773
        && (train_data_->num_feature_groups() < group_threshold_usesubset)) {
Guolin Ke's avatar
Guolin Ke committed
774
775
776
777
778
      if (tmp_subset_ == nullptr || is_change_dataset) {
        tmp_subset_.reset(new Dataset(bag_data_cnt_));
        tmp_subset_->CopyFeatureMapperFrom(train_data_);
      }
      is_use_subset_ = true;
779
      Log::Debug("Use subset for bagging");
Guolin Ke's avatar
Guolin Ke committed
780
781
    }

782
    need_re_bagging_ = true;
783

Guolin Ke's avatar
Guolin Ke committed
784
785
786
787
788
    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);
789
      }
790
    }
791
  } else {
Guolin Ke's avatar
Guolin Ke committed
792
793
    bag_data_cnt_ = num_data_;
    bag_data_indices_.clear();
794
    bagging_runner_.ReSize(0);
Guolin Ke's avatar
Guolin Ke committed
795
    is_use_subset_ = false;
796
  }
wxchan's avatar
wxchan committed
797
798
}

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