"vscode:/vscode.git/clone" did not exist on "7b4ead1e515d861c910a6fcb29fee40034bb80d1"
gbdt.cpp 25 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
8
9
10
11
12
13
14
15
#include <LightGBM/utils/common.h>

#include <LightGBM/objective_function.h>
#include <LightGBM/metric.h>

#include <ctime>

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

namespace LightGBM {

20
GBDT::GBDT()
21
  :iter_(0),
22
23
24
25
26
  train_data_(nullptr),
  object_function_(nullptr),
  early_stopping_round_(0),
  max_feature_idx_(0),
  num_class_(1),
27
  sigmoid_(-1.0f),
28
  num_iteration_for_pred_(0),
29
  shrinkage_rate_(0.1f),
wxchan's avatar
wxchan committed
30
  num_init_iteration_(0) {
31
32
33
34
35
#pragma omp parallel
#pragma omp master
    {
      num_threads_ = omp_get_num_threads();
    }
Guolin Ke's avatar
Guolin Ke committed
36
37
38
39
40
}

GBDT::~GBDT() {
}

41
42
43
void GBDT::Init(const BoostingConfig* config, const Dataset* train_data, const ObjectiveFunction* object_function,
     const std::vector<const Metric*>& training_metrics) {
  iter_ = 0;
wxchan's avatar
wxchan committed
44
  num_iteration_for_pred_ = 0;
45
  max_feature_idx_ = 0;
wxchan's avatar
wxchan committed
46
47
  num_class_ = config->num_class;
  train_data_ = nullptr;
Guolin Ke's avatar
Guolin Ke committed
48
  gbdt_config_ = nullptr;
49
  tree_learner_ = nullptr;
wxchan's avatar
wxchan committed
50
51
52
53
54
  ResetTrainingData(config, train_data, object_function, training_metrics);
}

void GBDT::ResetTrainingData(const BoostingConfig* config, const Dataset* train_data, const ObjectiveFunction* object_function,
  const std::vector<const Metric*>& training_metrics) {
Guolin Ke's avatar
Guolin Ke committed
55
  auto new_config = std::unique_ptr<BoostingConfig>(new BoostingConfig(*config));
wxchan's avatar
wxchan committed
56
57
58
  if (train_data_ != nullptr && !train_data_->CheckAlign(*train_data)) {
    Log::Fatal("cannot reset training data, since new training data has different bin mappers");
  }
Guolin Ke's avatar
Guolin Ke committed
59
60
61
  early_stopping_round_ = new_config->early_stopping_round;
  shrinkage_rate_ = new_config->learning_rate;

Guolin Ke's avatar
Guolin Ke committed
62
  object_function_ = object_function;
Guolin Ke's avatar
Guolin Ke committed
63

Guolin Ke's avatar
Guolin Ke committed
64
  sigmoid_ = -1.0f;
wxchan's avatar
wxchan committed
65
  if (object_function_ != nullptr
Guolin Ke's avatar
Guolin Ke committed
66
67
    && std::string(object_function_->GetName()) == std::string("binary")) {
    // only binary classification need sigmoid transform
Guolin Ke's avatar
Guolin Ke committed
68
    sigmoid_ = new_config->sigmoid;
69
  }
Guolin Ke's avatar
Guolin Ke committed
70

Guolin Ke's avatar
Guolin Ke committed
71
  if (train_data_ != train_data && train_data != nullptr) {
72
73
    if (tree_learner_ == nullptr) {
      tree_learner_ = std::unique_ptr<TreeLearner>(TreeLearner::CreateTreeLearner(new_config->tree_learner_type, &new_config->tree_config));
Guolin Ke's avatar
Guolin Ke committed
74
75
    }
    // init tree learner
76
    tree_learner_->Init(train_data);
Guolin Ke's avatar
Guolin Ke committed
77

Guolin Ke's avatar
Guolin Ke committed
78
79
80
81
82
83
    // push training metrics
    training_metrics_.clear();
    for (const auto& metric : training_metrics) {
      training_metrics_.push_back(metric);
    }
    training_metrics_.shrink_to_fit();
wxchan's avatar
wxchan committed
84
85
86
87
88
89
90
91
92
93
94
95
96
    // not same training data, need reset score and others
    // create score tracker
    train_score_updater_.reset(new ScoreUpdater(train_data, num_class_));
    // update score
    for (int i = 0; i < iter_; ++i) {
      for (int curr_class = 0; curr_class < num_class_; ++curr_class) {
        auto curr_tree = (i + num_init_iteration_) * num_class_ + curr_class;
        train_score_updater_->AddScore(models_[curr_tree].get(), curr_class);
      }
    }
    num_data_ = train_data->num_data();
    // create buffer for gradients and hessians
    if (object_function_ != nullptr) {
97
98
99
      size_t total_size = static_cast<size_t>(num_data_) * num_class_;
      gradients_.resize(total_size);
      hessians_.resize(total_size);
wxchan's avatar
wxchan committed
100
101
102
103
104
    }
    // get max feature index
    max_feature_idx_ = train_data->num_total_features() - 1;
    // get label index
    label_idx_ = train_data->label_idx();
105
106
    // get feature names
    feature_names_ = train_data->feature_names();
Guolin Ke's avatar
Guolin Ke committed
107
108

    feature_infos_ = train_data->feature_infos();
Guolin Ke's avatar
Guolin Ke committed
109
110
  }

Guolin Ke's avatar
Guolin Ke committed
111
112
  if ((train_data_ != train_data && train_data != nullptr)
    || (gbdt_config_ != nullptr && gbdt_config_->bagging_fraction != new_config->bagging_fraction)) {
wxchan's avatar
wxchan committed
113
    // if need bagging, create buffer
Guolin Ke's avatar
Guolin Ke committed
114
    if (new_config->bagging_fraction < 1.0 && new_config->bagging_freq > 0) {
115
116
      bag_data_cnt_ =
        static_cast<data_size_t>(new_config->bagging_fraction * num_data_);
117
      bag_data_indices_.resize(num_data_);
118
119
120
121
122
123
      tmp_indices_.resize(num_data_);
      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_);
Guolin Ke's avatar
Guolin Ke committed
124
125
      double average_bag_rate = new_config->bagging_fraction / new_config->bagging_freq;
      is_use_subset_ = false;
126
      if (average_bag_rate <= 0.5) {
Guolin Ke's avatar
Guolin Ke committed
127
        tmp_subset_.reset(new Dataset(bag_data_cnt_));
128
        tmp_subset_->CopyFeatureMapperFrom(train_data);
Guolin Ke's avatar
Guolin Ke committed
129
130
131
        is_use_subset_ = true;
        Log::Debug("use subset for bagging");
      }
wxchan's avatar
wxchan committed
132
133
134
    } else {
      bag_data_cnt_ = num_data_;
      bag_data_indices_.clear();
135
      tmp_indices_.clear();
Guolin Ke's avatar
Guolin Ke committed
136
      is_use_subset_ = false;
wxchan's avatar
wxchan committed
137
    }
Guolin Ke's avatar
Guolin Ke committed
138
  }
wxchan's avatar
wxchan committed
139
  train_data_ = train_data;
Guolin Ke's avatar
Guolin Ke committed
140
141
  if (train_data_ != nullptr) {
    // reset config for tree learner
142
    tree_learner_->ResetConfig(&new_config->tree_config);
Guolin Ke's avatar
Guolin Ke committed
143
  }
Guolin Ke's avatar
Guolin Ke committed
144
  gbdt_config_.reset(new_config.release());
Guolin Ke's avatar
Guolin Ke committed
145
146
}

wxchan's avatar
wxchan committed
147
void GBDT::AddValidDataset(const Dataset* valid_data,
Guolin Ke's avatar
Guolin Ke committed
148
  const std::vector<const Metric*>& valid_metrics) {
wxchan's avatar
wxchan committed
149
150
  if (!train_data_->CheckAlign(*valid_data)) {
    Log::Fatal("cannot add validation data, since it has different bin mappers with training data");
151
  }
Guolin Ke's avatar
Guolin Ke committed
152
  // for a validation dataset, we need its score and metric
Guolin Ke's avatar
Guolin Ke committed
153
  auto new_score_updater = std::unique_ptr<ScoreUpdater>(new ScoreUpdater(valid_data, num_class_));
wxchan's avatar
wxchan committed
154
155
156
157
158
159
160
  // update score
  for (int i = 0; i < iter_; ++i) {
    for (int curr_class = 0; curr_class < num_class_; ++curr_class) {
      auto curr_tree = (i + num_init_iteration_) * num_class_ + curr_class;
      new_score_updater->AddScore(models_[curr_tree].get(), curr_class);
    }
  }
Guolin Ke's avatar
Guolin Ke committed
161
  valid_score_updater_.push_back(std::move(new_score_updater));
Guolin Ke's avatar
Guolin Ke committed
162
  valid_metrics_.emplace_back();
163
164
165
  if (early_stopping_round_ > 0) {
    best_iter_.emplace_back();
    best_score_.emplace_back();
Guolin Ke's avatar
Guolin Ke committed
166
    best_msg_.emplace_back();
167
  }
Guolin Ke's avatar
Guolin Ke committed
168
169
  for (const auto& metric : valid_metrics) {
    valid_metrics_.back().push_back(metric);
170
171
172
    if (early_stopping_round_ > 0) {
      best_iter_.back().push_back(0);
      best_score_.back().push_back(kMinScore);
Guolin Ke's avatar
Guolin Ke committed
173
      best_msg_.back().emplace_back();
174
    }
Guolin Ke's avatar
Guolin Ke committed
175
  }
Guolin Ke's avatar
Guolin Ke committed
176
  valid_metrics_.back().shrink_to_fit();
Guolin Ke's avatar
Guolin Ke committed
177
178
}

Guolin Ke's avatar
Guolin Ke committed
179
data_size_t GBDT::BaggingHelper(Random& cur_rand, data_size_t start, data_size_t cnt, data_size_t* buffer){
180
181
182
  if (cnt <= 0) {
    return 0;
  }
183
184
185
186
  data_size_t bag_data_cnt =
    static_cast<data_size_t>(gbdt_config_->bagging_fraction * cnt);
  data_size_t cur_left_cnt = 0;
  data_size_t cur_right_cnt = 0;
Guolin Ke's avatar
Guolin Ke committed
187
  auto right_buffer = buffer + bag_data_cnt;
188
189
  // random bagging, minimal unit is one record
  for (data_size_t i = 0; i < cnt; ++i) {
Guolin Ke's avatar
Guolin Ke committed
190
191
192
    float prob =
      (bag_data_cnt - cur_left_cnt) / static_cast<float>(cnt - i);
    if (cur_rand.NextFloat() < prob) {
193
194
      buffer[cur_left_cnt++] = start + i;
    } else {
Guolin Ke's avatar
Guolin Ke committed
195
      right_buffer[cur_right_cnt++] = start + i;
196
197
198
199
200
    }
  }
  CHECK(cur_left_cnt == bag_data_cnt);
  return cur_left_cnt;
}
Guolin Ke's avatar
Guolin Ke committed
201

Guolin Ke's avatar
Guolin Ke committed
202
203


204
void GBDT::Bagging(int iter) {
Guolin Ke's avatar
Guolin Ke committed
205
  // if need bagging
206
  if (bag_data_cnt_ < num_data_ && iter % gbdt_config_->bagging_freq == 0) {
Guolin Ke's avatar
Guolin Ke committed
207
    const data_size_t min_inner_size = 1000;
208
209
210
    data_size_t inner_size = (num_data_ + num_threads_ - 1) / num_threads_;
    if (inner_size < min_inner_size) { inner_size = min_inner_size; }

Guolin Ke's avatar
Guolin Ke committed
211
#pragma omp parallel for schedule(static,1)
212
213
214
215
216
217
218
    for (int i = 0; i < num_threads_; ++i) {
      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
219
220
      Random cur_rand(gbdt_config_->bagging_seed + iter * num_threads_ + i);
      data_size_t cur_left_count = BaggingHelper(cur_rand, cur_start, cur_cnt, tmp_indices_.data() + cur_start);
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
      offsets_buf_[i] = cur_start;
      left_cnts_buf_[i] = cur_left_count;
      right_cnts_buf_[i] = cur_cnt - cur_left_count;
    }
    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];

#pragma omp parallel for schedule(static, 1)
    for (int i = 0; i < num_threads_; ++i) {
      if (left_cnts_buf_[i] > 0) {
        std::memcpy(bag_data_indices_.data() + left_write_pos_buf_[i],
          tmp_indices_.data() + offsets_buf_[i], left_cnts_buf_[i] * sizeof(data_size_t));
Guolin Ke's avatar
Guolin Ke committed
239
      }
240
241
242
      if (right_cnts_buf_[i] > 0) {
        std::memcpy(bag_data_indices_.data() + left_cnt + right_write_pos_buf_[i],
          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
243
244
      }
    }
Guolin Ke's avatar
Guolin Ke committed
245
246
    bag_data_cnt_ = left_cnt;
    CHECK(bag_data_indices_[bag_data_cnt_ - 1] > bag_data_indices_[bag_data_cnt_]);
Guolin Ke's avatar
Guolin Ke committed
247
    Log::Debug("Re-bagging, using %d data to train", bag_data_cnt_);
Guolin Ke's avatar
Guolin Ke committed
248
    // set bagging data to tree learner
Guolin Ke's avatar
Guolin Ke committed
249
250
251
252
    if (!is_use_subset_) {
      tree_learner_->SetBaggingData(bag_data_indices_.data(), bag_data_cnt_);
    } else {
      // get subset
Guolin Ke's avatar
Guolin Ke committed
253
254
      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
255
256
      tree_learner_->ResetTrainingData(tmp_subset_.get());
    }
Guolin Ke's avatar
Guolin Ke committed
257
258
259
  }
}

260
void GBDT::UpdateScoreOutOfBag(const Tree* tree, const int curr_class) {
Hui Xue's avatar
Hui Xue committed
261
  // we need to predict out-of-bag socres of data for boosting
Guolin Ke's avatar
Guolin Ke committed
262
  if (num_data_ - bag_data_cnt_ > 0 && !is_use_subset_) {
263
    train_score_updater_->AddScore(tree, bag_data_indices_.data() + bag_data_cnt_, num_data_ - bag_data_cnt_, curr_class);
Guolin Ke's avatar
Guolin Ke committed
264
265
266
  }
}

267
bool GBDT::TrainOneIter(const score_t* gradient, const score_t* hessian, bool is_eval) {
Guolin Ke's avatar
Guolin Ke committed
268
269
270
271
272
273
  // boosting first
  if (gradient == nullptr || hessian == nullptr) {
    Boosting();
    gradient = gradients_.data();
    hessian = hessians_.data();
  }
274
275
  // bagging logic
  Bagging(iter_);
Guolin Ke's avatar
Guolin Ke committed
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
  if (is_use_subset_ && bag_data_cnt_ < num_data_) {
    if (gradients_.empty()) {
      size_t total_size = static_cast<size_t>(num_data_) * num_class_;
      gradients_.resize(total_size);
      hessians_.resize(total_size);
    }    
    // get sub gradients
    for (int curr_class = 0; curr_class < num_class_; ++curr_class) {
      auto bias = curr_class * num_data_;
      for (int i = 0; i < bag_data_cnt_; ++i) {
        gradients_[bias + i] = gradient[bias + bag_data_indices_[i]];
        hessians_[bias + i] = hessian[bias + bag_data_indices_[i]];
      }
    }
    gradient = gradients_.data();
    hessian = hessians_.data();
  }
Guolin Ke's avatar
Guolin Ke committed
293
294
  for (int curr_class = 0; curr_class < num_class_; ++curr_class) {
    // train a new tree
295
    std::unique_ptr<Tree> new_tree(tree_learner_->Train(gradient + curr_class * num_data_, hessian + curr_class * num_data_));
Guolin Ke's avatar
Guolin Ke committed
296
297
298
299
    // if cannot learn a new tree, then stop
    if (new_tree->num_leaves() <= 1) {
      Log::Info("Stopped training because there are no more leafs that meet the split requirements.");
      return true;
300
    }
301

Guolin Ke's avatar
Guolin Ke committed
302
303
304
305
306
    // shrinkage by learning rate
    new_tree->Shrinkage(shrinkage_rate_);
    // update score
    UpdateScore(new_tree.get(), curr_class);
    UpdateScoreOutOfBag(new_tree.get(), curr_class);
307

Guolin Ke's avatar
Guolin Ke committed
308
309
310
311
312
313
314
315
316
    // add model
    models_.push_back(std::move(new_tree));
  }
  ++iter_;
  if (is_eval) {
    return EvalAndCheckEarlyStopping();
  } else {
    return false;
  }
317

Guolin Ke's avatar
Guolin Ke committed
318
}
319

wxchan's avatar
wxchan committed
320
void GBDT::RollbackOneIter() {
321
  if (iter_ <= 0) { return; }
wxchan's avatar
wxchan committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
  int cur_iter = iter_ + num_init_iteration_ - 1;
  // reset score
  for (int curr_class = 0; curr_class < num_class_; ++curr_class) {
    auto curr_tree = cur_iter * num_class_ + curr_class;
    models_[curr_tree]->Shrinkage(-1.0);
    train_score_updater_->AddScore(models_[curr_tree].get(), curr_class);
    for (auto& score_updater : valid_score_updater_) {
      score_updater->AddScore(models_[curr_tree].get(), curr_class);
    }
  }
  // remove model
  for (int curr_class = 0; curr_class < num_class_; ++curr_class) {
    models_.pop_back();
  }
  --iter_;
}

Guolin Ke's avatar
Guolin Ke committed
339
bool GBDT::EvalAndCheckEarlyStopping() {
340
341
  bool is_met_early_stopping = false;
  // print message for metric
Guolin Ke's avatar
Guolin Ke committed
342
343
  auto best_msg = OutputMetric(iter_);
  is_met_early_stopping = !best_msg.empty();
344
345
346
  if (is_met_early_stopping) {
    Log::Info("Early stopping at iteration %d, the best iteration round is %d",
      iter_, iter_ - early_stopping_round_);
Guolin Ke's avatar
Guolin Ke committed
347
    Log::Info("Output of best iteration round:\n%s", best_msg.c_str());
348
    // pop last early_stopping_round_ models
349
    for (int i = 0; i < early_stopping_round_ * num_class_; ++i) {
350
351
352
353
      models_.pop_back();
    }
  }
  return is_met_early_stopping;
Guolin Ke's avatar
Guolin Ke committed
354
355
}

356
void GBDT::UpdateScore(const Tree* tree, const int curr_class) {
Guolin Ke's avatar
Guolin Ke committed
357
  // update training score
Guolin Ke's avatar
Guolin Ke committed
358
359
360
361
362
  if (!is_use_subset_) {
    train_score_updater_->AddScore(tree_learner_.get(), curr_class);
  } else {
    train_score_updater_->AddScore(tree, curr_class);
  }
Guolin Ke's avatar
Guolin Ke committed
363
  // update validation score
Guolin Ke's avatar
Guolin Ke committed
364
365
  for (auto& score_updater : valid_score_updater_) {
    score_updater->AddScore(tree, curr_class);
Guolin Ke's avatar
Guolin Ke committed
366
367
368
  }
}

Guolin Ke's avatar
Guolin Ke committed
369
370
371
372
std::string GBDT::OutputMetric(int iter) {
  bool need_output = (iter % gbdt_config_->output_freq) == 0;
  std::string ret = "";
  std::stringstream msg_buf;
373
  std::vector<std::pair<size_t, size_t>> meet_early_stopping_pairs;
Guolin Ke's avatar
Guolin Ke committed
374
  // print training metric
Guolin Ke's avatar
Guolin Ke committed
375
  if (need_output) {
376
377
378
    for (auto& sub_metric : training_metrics_) {
      auto name = sub_metric->GetName();
      auto scores = sub_metric->Eval(train_score_updater_->score());
Guolin Ke's avatar
Guolin Ke committed
379
      for (size_t k = 0; k < name.size(); ++k) {
Guolin Ke's avatar
Guolin Ke committed
380
381
382
383
384
385
386
387
        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) {
          msg_buf << tmp_buf.str() << std::endl;
        }
388
      }
389
    }
Guolin Ke's avatar
Guolin Ke committed
390
391
  }
  // print validation metric
Guolin Ke's avatar
Guolin Ke committed
392
  if (need_output || early_stopping_round_ > 0) {
393
394
395
    for (size_t i = 0; i < valid_metrics_.size(); ++i) {
      for (size_t j = 0; j < valid_metrics_[i].size(); ++j) {
        auto test_scores = valid_metrics_[i][j]->Eval(valid_score_updater_[i]->score());
Guolin Ke's avatar
Guolin Ke committed
396
397
398
399
400
401
402
403
404
405
406
        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) {
            msg_buf << tmp_buf.str() << std::endl;
407
          }
wxchan's avatar
wxchan committed
408
        }
Guolin Ke's avatar
Guolin Ke committed
409
        if (ret.empty() && early_stopping_round_ > 0) {
410
411
412
          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;
413
            best_iter_[i][j] = iter;
Guolin Ke's avatar
Guolin Ke committed
414
            meet_early_stopping_pairs.emplace_back(i, j);
415
          } else {
Guolin Ke's avatar
Guolin Ke committed
416
            if (iter - best_iter_[i][j] >= early_stopping_round_) { ret = best_msg_[i][j]; }
417
          }
wxchan's avatar
wxchan committed
418
419
        }
      }
Guolin Ke's avatar
Guolin Ke committed
420
421
    }
  }
Guolin Ke's avatar
Guolin Ke committed
422
423
424
  for (auto& pair : meet_early_stopping_pairs) {
    best_msg_[pair.first][pair.second] = msg_buf.str();
  }
wxchan's avatar
wxchan committed
425
  return ret;
Guolin Ke's avatar
Guolin Ke committed
426
427
}

428
/*! \brief Get eval result */
429
std::vector<double> GBDT::GetEvalAt(int data_idx) const {
Guolin Ke's avatar
Guolin Ke committed
430
  CHECK(data_idx >= 0 && data_idx <= static_cast<int>(valid_score_updater_.size()));
431
432
  std::vector<double> ret;
  if (data_idx == 0) {
433
434
    for (auto& sub_metric : training_metrics_) {
      auto scores = sub_metric->Eval(train_score_updater_->score());
435
436
437
      for (auto score : scores) {
        ret.push_back(score);
      }
438
439
    }
  }
440
441
442
443
444
445
446
  else {
    auto used_idx = data_idx - 1;
    for (size_t j = 0; j < valid_metrics_[used_idx].size(); ++j) {
      auto test_scores = valid_metrics_[used_idx][j]->Eval(valid_score_updater_[used_idx]->score());
      for (auto score : test_scores) {
        ret.push_back(score);
      }
447
448
449
450
451
    }
  }
  return ret;
}

Guolin Ke's avatar
Guolin Ke committed
452
/*! \brief Get training scores result */
453
const double* GBDT::GetTrainingScore(int64_t* out_len) {
454
  *out_len = static_cast<int64_t>(train_score_updater_->num_data()) * num_class_;
Guolin Ke's avatar
Guolin Ke committed
455
  return train_score_updater_->score();
456
457
}

Guolin Ke's avatar
Guolin Ke committed
458
459
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
460

461
  const double* raw_scores = nullptr;
Guolin Ke's avatar
Guolin Ke committed
462
463
  data_size_t num_data = 0;
  if (data_idx == 0) {
wxchan's avatar
wxchan committed
464
    raw_scores = GetTrainingScore(out_len);
Guolin Ke's avatar
Guolin Ke committed
465
466
467
468
469
    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();
470
    *out_len = static_cast<int64_t>(num_data) * num_class_;
Guolin Ke's avatar
Guolin Ke committed
471
472
  }
  if (num_class_ > 1) {
wxchan's avatar
wxchan committed
473
#pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
474
    for (data_size_t i = 0; i < num_data; ++i) {
475
      std::vector<double> tmp_result(num_class_);
Guolin Ke's avatar
Guolin Ke committed
476
      for (int j = 0; j < num_class_; ++j) {
477
        tmp_result[j] = raw_scores[j * num_data + i];
Guolin Ke's avatar
Guolin Ke committed
478
479
480
      }
      Common::Softmax(&tmp_result);
      for (int j = 0; j < num_class_; ++j) {
Guolin Ke's avatar
Guolin Ke committed
481
        out_result[j * num_data + i] = static_cast<double>(tmp_result[j]);
Guolin Ke's avatar
Guolin Ke committed
482
483
      }
    }
Guolin Ke's avatar
Guolin Ke committed
484
  } else if(sigmoid_ > 0.0f){
wxchan's avatar
wxchan committed
485
#pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
486
    for (data_size_t i = 0; i < num_data; ++i) {
487
      out_result[i] = static_cast<double>(1.0f / (1.0f + std::exp(- sigmoid_ * raw_scores[i])));
Guolin Ke's avatar
Guolin Ke committed
488
489
    }
  } else {
wxchan's avatar
wxchan committed
490
#pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
491
    for (data_size_t i = 0; i < num_data; ++i) {
Guolin Ke's avatar
Guolin Ke committed
492
      out_result[i] = static_cast<double>(raw_scores[i]);
Guolin Ke's avatar
Guolin Ke committed
493
494
495
496
497
    }
  }

}

Guolin Ke's avatar
Guolin Ke committed
498
void GBDT::Boosting() {
499
500
501
  if (object_function_ == nullptr) {
    Log::Fatal("No object function provided");
  }
Hui Xue's avatar
Hui Xue committed
502
  // objective function will calculate gradients and hessians
503
  int64_t num_score = 0;
Guolin Ke's avatar
Guolin Ke committed
504
  object_function_->
Guolin Ke's avatar
Guolin Ke committed
505
    GetGradients(GetTrainingScore(&num_score), gradients_.data(), hessians_.data());
Guolin Ke's avatar
Guolin Ke committed
506
507
}

508
std::string GBDT::DumpModel(int num_iteration) const {
Guolin Ke's avatar
Guolin Ke committed
509
  std::stringstream str_buf;
wxchan's avatar
wxchan committed
510

Guolin Ke's avatar
Guolin Ke committed
511
  str_buf << "{";
Guolin Ke's avatar
Guolin Ke committed
512
  str_buf << "\"name\":\"" << SubModelName() << "\"," << std::endl;
Guolin Ke's avatar
Guolin Ke committed
513
514
515
516
  str_buf << "\"num_class\":" << num_class_ << "," << std::endl;
  str_buf << "\"label_index\":" << label_idx_ << "," << std::endl;
  str_buf << "\"max_feature_idx\":" << max_feature_idx_ << "," << std::endl;
  str_buf << "\"sigmoid\":" << sigmoid_ << "," << std::endl;
wxchan's avatar
wxchan committed
517

Guolin Ke's avatar
Guolin Ke committed
518
  str_buf << "\"feature_names\":[\"" 
519
     << Common::Join(feature_names_, "\",\"") << "\"]," 
Guolin Ke's avatar
Guolin Ke committed
520
521
     << std::endl;

Guolin Ke's avatar
Guolin Ke committed
522
  str_buf << "\"tree_info\":[";
523
524
525
526
527
  int num_used_model = static_cast<int>(models_.size());
  if (num_iteration > 0) {
    num_used_model = std::min(num_iteration * num_class_, num_used_model);
  } 
  for (int i = 0; i < num_used_model; ++i) {
wxchan's avatar
wxchan committed
528
    if (i > 0) {
Guolin Ke's avatar
Guolin Ke committed
529
      str_buf << ",";
wxchan's avatar
wxchan committed
530
    }
Guolin Ke's avatar
Guolin Ke committed
531
532
533
534
    str_buf << "{";
    str_buf << "\"tree_index\":" << i << ",";
    str_buf << models_[i]->ToJSON();
    str_buf << "}";
wxchan's avatar
wxchan committed
535
  }
Guolin Ke's avatar
Guolin Ke committed
536
  str_buf << "]" << std::endl;
wxchan's avatar
wxchan committed
537

Guolin Ke's avatar
Guolin Ke committed
538
  str_buf << "}" << std::endl;
wxchan's avatar
wxchan committed
539

Guolin Ke's avatar
Guolin Ke committed
540
  return str_buf.str();
wxchan's avatar
wxchan committed
541
542
}

543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
std::string GBDT::SaveModelToString(int num_iterations) const {
    std::stringstream ss;

    // output model type
    ss << SubModelName() << std::endl;
    // output number of class
    ss << "num_class=" << num_class_ << std::endl;
    // output label index
    ss << "label_index=" << label_idx_ << std::endl;
    // output max_feature_idx
    ss << "max_feature_idx=" << max_feature_idx_ << std::endl;
    // output objective name
    if (object_function_ != nullptr) {
      ss << "objective=" << object_function_->GetName() << std::endl;
    }
    // output sigmoid parameter
    ss << "sigmoid=" << sigmoid_ << std::endl;

    ss << "feature_names=" << Common::Join(feature_names_, " ") << std::endl;

Guolin Ke's avatar
Guolin Ke committed
563
564
    ss << "feature_infos=" << Common::Join(feature_infos_, " ") << std::endl;

565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
    ss << std::endl;
    int num_used_model = static_cast<int>(models_.size());
    if (num_iterations > 0) {
      num_used_model = std::min(num_iterations * num_class_, num_used_model);
    }
    // output tree models
    for (int i = 0; i < num_used_model; ++i) {
      ss << "Tree=" << i << std::endl;
      ss << models_[i]->ToString() << std::endl;
    }

    std::vector<std::pair<size_t, std::string>> pairs = FeatureImportance();
    ss << std::endl << "feature importances:" << std::endl;
    for (size_t i = 0; i < pairs.size(); ++i) {
      ss << pairs[i].second << "=" << std::to_string(pairs[i].first) << std::endl;
    }

    return ss.str();
}

585
bool GBDT::SaveModelToFile(int num_iteration, const char* filename) const {
wxchan's avatar
wxchan committed
586
587
588
  /*! \brief File to write models */
  std::ofstream output_file;
  output_file.open(filename);
589

590
  output_file << SaveModelToString(num_iteration);
591

wxchan's avatar
wxchan committed
592
  output_file.close();
593
594

  return (bool)output_file;
Guolin Ke's avatar
Guolin Ke committed
595
596
}

597
bool GBDT::LoadModelFromString(const std::string& model_str) {
Guolin Ke's avatar
Guolin Ke committed
598
599
600
  // use serialized string to restore this object
  models_.clear();
  std::vector<std::string> lines = Common::Split(model_str.c_str(), '\n');
601
602

  // get number of classes
603
604
605
606
  auto line = Common::FindFromLines(lines, "num_class=");
  if (line.size() > 0) {
    Common::Atoi(Common::Split(line.c_str(), '=')[1].c_str(), &num_class_);
  } else {
607
    Log::Fatal("Model file doesn't specify the number of classes");
608
    return false;
609
  }
Guolin Ke's avatar
Guolin Ke committed
610
  // get index of label
611
612
613
614
  line = Common::FindFromLines(lines, "label_index=");
  if (line.size() > 0) {
    Common::Atoi(Common::Split(line.c_str(), '=')[1].c_str(), &label_idx_);
  } else {
615
    Log::Fatal("Model file doesn't specify the label index");
616
    return false;
Guolin Ke's avatar
Guolin Ke committed
617
  }
Guolin Ke's avatar
Guolin Ke committed
618
  // get max_feature_idx first
619
620
621
622
  line = Common::FindFromLines(lines, "max_feature_idx=");
  if (line.size() > 0) {
    Common::Atoi(Common::Split(line.c_str(), '=')[1].c_str(), &max_feature_idx_);
  } else {
623
    Log::Fatal("Model file doesn't specify max_feature_idx");
624
    return false;
Guolin Ke's avatar
Guolin Ke committed
625
626
  }
  // get sigmoid parameter
627
628
629
630
  line = Common::FindFromLines(lines, "sigmoid=");
  if (line.size() > 0) {
    Common::Atof(Common::Split(line.c_str(), '=')[1].c_str(), &sigmoid_);
  } else {
631
    sigmoid_ = -1.0f;
Guolin Ke's avatar
Guolin Ke committed
632
  }
Guolin Ke's avatar
Guolin Ke committed
633
634
635
  // get feature names
  line = Common::FindFromLines(lines, "feature_names=");
  if (line.size() > 0) {
Guolin Ke's avatar
Guolin Ke committed
636
    feature_names_ = Common::Split(line.substr(std::strlen("feature_names=")).c_str(), " ");
Guolin Ke's avatar
Guolin Ke committed
637
638
    if (feature_names_.size() != static_cast<size_t>(max_feature_idx_ + 1)) {
      Log::Fatal("Wrong size of feature_names");
639
      return false;
Guolin Ke's avatar
Guolin Ke committed
640
    }
Guolin Ke's avatar
Guolin Ke committed
641
642
  }
  else {
Guolin Ke's avatar
Guolin Ke committed
643
    Log::Fatal("Model file doesn't contain feature names");
644
    return false;
Guolin Ke's avatar
Guolin Ke committed
645
646
  }

Guolin Ke's avatar
Guolin Ke committed
647
648
649
650
651
652
653
654
655
656
657
658
  line = Common::FindFromLines(lines, "feature_infos=");
  if (line.size() > 0) {
    feature_infos_ = Common::Split(line.substr(std::strlen("feature_infos=")).c_str(), " ");
    if (feature_infos_.size() != static_cast<size_t>(max_feature_idx_ + 1)) {
      Log::Fatal("Wrong size of feature_infos");
      return false;
    }
  } else {
    Log::Fatal("Model file doesn't contain feature infos");
    return false;
  }

Guolin Ke's avatar
Guolin Ke committed
659
  // get tree models
660
  size_t i = 0;
Guolin Ke's avatar
Guolin Ke committed
661
662
663
664
665
666
667
  while (i < lines.size()) {
    size_t find_pos = lines[i].find("Tree=");
    if (find_pos != std::string::npos) {
      ++i;
      int start = static_cast<int>(i);
      while (i < lines.size() && lines[i].find("Tree=") == std::string::npos) { ++i; }
      int end = static_cast<int>(i);
Guolin Ke's avatar
Guolin Ke committed
668
      std::string tree_str = Common::Join<std::string>(lines, start, end, "\n");
Guolin Ke's avatar
Guolin Ke committed
669
670
      auto new_tree = std::unique_ptr<Tree>(new Tree(tree_str));
      models_.push_back(std::move(new_tree));
Guolin Ke's avatar
Guolin Ke committed
671
672
673
674
    } else {
      ++i;
    }
  }
675
  Log::Info("Finished loading %d models", models_.size());
wxchan's avatar
wxchan committed
676
677
  num_iteration_for_pred_ = static_cast<int>(models_.size()) / num_class_;
  num_init_iteration_ = num_iteration_for_pred_;
678
  iter_ = 0;
679
680

  return true;
Guolin Ke's avatar
Guolin Ke committed
681
682
}

wxchan's avatar
wxchan committed
683
std::vector<std::pair<size_t, std::string>> GBDT::FeatureImportance() const {
684

685
  std::vector<size_t> feature_importances(max_feature_idx_ + 1, 0);
686
    for (size_t iter = 0; iter < models_.size(); ++iter) {
687
        for (int split_idx = 0; split_idx < models_[iter]->num_leaves() - 1; ++split_idx) {
Guolin Ke's avatar
Guolin Ke committed
688
            ++feature_importances[models_[iter]->split_feature(split_idx)];
wxchan's avatar
wxchan committed
689
690
        }
    }
691
692
693
    // store the importance first
    std::vector<std::pair<size_t, std::string>> pairs;
    for (size_t i = 0; i < feature_importances.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
694
      if (feature_importances[i] > 0) {
695
        pairs.emplace_back(feature_importances[i], feature_names_[i]);
Guolin Ke's avatar
Guolin Ke committed
696
      }
697
698
699
700
701
    }
    // sort the importance
    std::sort(pairs.begin(), pairs.end(),
      [](const std::pair<size_t, std::string>& lhs,
        const std::pair<size_t, std::string>& rhs) {
702
      return lhs.first > rhs.first;
703
    });
wxchan's avatar
wxchan committed
704
    return pairs;
wxchan's avatar
wxchan committed
705
706
}

707
708
std::vector<double> GBDT::PredictRaw(const double* value) const {
  std::vector<double> ret(num_class_, 0.0f);
wxchan's avatar
wxchan committed
709
  for (int i = 0; i < num_iteration_for_pred_; ++i) {
710
711
712
    for (int j = 0; j < num_class_; ++j) {
      ret[j] += models_[i * num_class_ + j]->Predict(value);
    }
Guolin Ke's avatar
Guolin Ke committed
713
714
715
716
  }
  return ret;
}

717
std::vector<double> GBDT::Predict(const double* value) const {
718
  std::vector<double> ret(num_class_, 0.0f);
wxchan's avatar
wxchan committed
719
  for (int i = 0; i < num_iteration_for_pred_; ++i) {
720
721
    for (int j = 0; j < num_class_; ++j) {
      ret[j] += models_[i * num_class_ + j]->Predict(value);
722
723
    }
  }
724
725
  // if need sigmoid transform
  if (sigmoid_ > 0 && num_class_ == 1) {
726
    ret[0] = 1.0f / (1.0f + std::exp(-sigmoid_ * ret[0]));
727
728
729
  } else if (num_class_ > 1) {
    Common::Softmax(&ret);
  }
730
731
732
  return ret;
}

733
std::vector<int> GBDT::PredictLeafIndex(const double* value) const {
wxchan's avatar
wxchan committed
734
  std::vector<int> ret;
wxchan's avatar
wxchan committed
735
  for (int i = 0; i < num_iteration_for_pred_; ++i) {
736
737
738
    for (int j = 0; j < num_class_; ++j) {
      ret.push_back(models_[i * num_class_ + j]->PredictLeafIndex(value));
    }
wxchan's avatar
wxchan committed
739
740
741
742
  }
  return ret;
}

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