gbdt.cpp 28.7 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
#include <chrono>
Guolin Ke's avatar
Guolin Ke committed
15
16
17
18
19
#include <ctime>
#include <sstream>

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
  std::string forced_splits_path = config->forcedsplits_filename;
62
  // load forced_splits file
63
64
65
66
67
68
69
70
  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);
  }

71
72
73
74
  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
75
    num_tree_per_iteration_ = objective_function_->NumModelPerIteration();
76
77
78
79
  } else {
    is_constant_hessian_ = false;
  }

Guolin Ke's avatar
Guolin Ke committed
80
  tree_learner_ = std::unique_ptr<TreeLearner>(TreeLearner::CreateTreeLearner(config_->tree_learner, config_->device_type, config_.get()));
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();
108
  monotone_constraints_ = config->monotone_constraints;
109
110

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

  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
115
    CHECK_EQ(num_tree_per_iteration_, num_class_);
116
117
    for (int i = 0; i < num_class_; ++i) {
      class_need_train_[i] = objective_function_->ClassNeedTrain(i);
118
119
    }
  }
wxchan's avatar
wxchan committed
120
121
122
}

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

143
144
145
146
147
148
149
  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
150
151
}

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

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

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

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

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

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

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
/* 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
313
double GBDT::BoostFromAverage(int class_id, bool update_scorer) {
314
  Common::FunctionTimer fun_timer("GBDT::BoostFromAverage", global_timer);
315
  // boosting from average label; or customized "average" if implemented for the current objective
316
317
318
  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);
319
      if (std::fabs(init_score) > kEpsilon) {
Guolin Ke's avatar
Guolin Ke committed
320
321
322
323
324
        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);
          }
325
326
327
        }
        Log::Info("Start training from score %lf", init_score);
        return init_score;
Guolin Ke's avatar
Guolin Ke committed
328
      }
329
330
331
    } 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")) {
332
      Log::Warning("Disabling boost_from_average in %s may cause the slow convergence", objective_function_->GetName());
333
    }
334
  }
Guolin Ke's avatar
Guolin Ke committed
335
336
  return 0.0f;
}
Guolin Ke's avatar
Guolin Ke committed
337

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

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

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

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

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

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

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


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

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

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


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

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

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

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

574
575
576
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
577
578
  const int num_features = max_feature_idx_ + 1;
  std::memset(output, 0, sizeof(double) * num_tree_per_iteration_ * (num_features + 1));
579
580
581
  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
582
      models_[i * num_tree_per_iteration_ + k]->PredictContrib(features, num_features, output + k*(num_features + 1));
583
584
585
586
587
588
589
590
591
592
593
594
    }
    // 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
595
596
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
597

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

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

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

Guolin Ke's avatar
Guolin Ke committed
648
649
650
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)) {
651
    Log::Fatal("Cannot reset training data, since new training data has different bin mappers");
wxchan's avatar
wxchan committed
652
653
  }

Guolin Ke's avatar
Guolin Ke committed
654
655
656
  objective_function_ = objective_function;
  if (objective_function_ != nullptr) {
    is_constant_hessian_ = objective_function_->IsConstantHessian();
Nikita Titov's avatar
Nikita Titov committed
657
    CHECK_EQ(num_tree_per_iteration_, objective_function_->NumModelPerIteration());
Guolin Ke's avatar
Guolin Ke committed
658
659
  } else {
    is_constant_hessian_ = false;
660
661
  }

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

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

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

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

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

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

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

Guolin Ke's avatar
Guolin Ke committed
704
705
void GBDT::ResetConfig(const Config* config) {
  auto new_config = std::unique_ptr<Config>(new Config(*config));
706
  if (!config->monotone_constraints.empty()) {
Nikita Titov's avatar
Nikita Titov committed
707
    CHECK_EQ(static_cast<size_t>(train_data_->num_total_features()), config->monotone_constraints.size());
708
709
  }
  if (!config->feature_contri.empty()) {
Nikita Titov's avatar
Nikita Titov committed
710
    CHECK_EQ(static_cast<size_t>(train_data_->num_total_features()), config->feature_contri.size());
711
  }
Guolin Ke's avatar
Guolin Ke committed
712
713
714
  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
715
    tree_learner_->ResetConfig(new_config.get());
716
  }
Guolin Ke's avatar
Guolin Ke committed
717
718
  if (train_data_ != nullptr) {
    ResetBaggingConfig(new_config.get(), false);
719
  }
Guolin Ke's avatar
Guolin Ke committed
720
  config_.reset(new_config.release());
Guolin Ke's avatar
Guolin Ke committed
721
722
}

Guolin Ke's avatar
Guolin Ke committed
723
void GBDT::ResetBaggingConfig(const Config* config, bool is_change_dataset) {
Guolin Ke's avatar
Guolin Ke committed
724
  // if need bagging, create buffer
Guolin Ke's avatar
Guolin Ke committed
725
726
727
728
729
730
  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) {
731
732
    need_re_bagging_ = false;
    if (!is_change_dataset &&
Guolin Ke's avatar
Guolin Ke committed
733
734
      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) {
735
736
      return;
    }
Guolin Ke's avatar
Guolin Ke committed
737
738
    if (balance_bagging_cond) {
      balanced_bagging_ = true;
739
      bag_data_cnt_ = static_cast<data_size_t>(num_pos_data * config->pos_bagging_fraction)
Guolin Ke's avatar
Guolin Ke committed
740
741
742
743
                      + 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
744
    bag_data_indices_.resize(num_data_);
745
746
747
748
749
750
    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);
    }
751

752
753
    double average_bag_rate =
        (static_cast<double>(bag_data_cnt_) / num_data_) / config->bagging_freq;
Guolin Ke's avatar
Guolin Ke committed
754
755
    is_use_subset_ = false;
    const int group_threshold_usesubset = 100;
756
    if (average_bag_rate <= 0.5
757
        && (train_data_->num_feature_groups() < group_threshold_usesubset)) {
Guolin Ke's avatar
Guolin Ke committed
758
759
760
761
762
      if (tmp_subset_ == nullptr || is_change_dataset) {
        tmp_subset_.reset(new Dataset(bag_data_cnt_));
        tmp_subset_->CopyFeatureMapperFrom(train_data_);
      }
      is_use_subset_ = true;
763
      Log::Debug("Use subset for bagging");
Guolin Ke's avatar
Guolin Ke committed
764
765
    }

766
    need_re_bagging_ = true;
767

Guolin Ke's avatar
Guolin Ke committed
768
769
770
771
772
    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);
773
      }
774
    }
775
  } else {
Guolin Ke's avatar
Guolin Ke committed
776
777
    bag_data_cnt_ = num_data_;
    bag_data_indices_.clear();
778
    bagging_runner_.ReSize(0);
Guolin Ke's avatar
Guolin Ke committed
779
    is_use_subset_ = false;
780
  }
wxchan's avatar
wxchan committed
781
782
}

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