"git@developer.sourcefind.cn:tianlh/lightgbm-dcu.git" did not exist on "3b6ebd794b82e02f8d5e1d0b915533bb4c36dbfc"
c_api.cpp 106 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
#include <LightGBM/c_api.h>
Guolin Ke's avatar
Guolin Ke committed
6

Guolin Ke's avatar
Guolin Ke committed
7
8
#include <LightGBM/boosting.h>
#include <LightGBM/config.h>
9
10
11
#include <LightGBM/dataset.h>
#include <LightGBM/dataset_loader.h>
#include <LightGBM/metric.h>
12
#include <LightGBM/network.h>
13
14
#include <LightGBM/objective_function.h>
#include <LightGBM/prediction_early_stop.h>
15
#include <LightGBM/utils/byte_buffer.h>
16
17
18
19
20
#include <LightGBM/utils/common.h>
#include <LightGBM/utils/log.h>
#include <LightGBM/utils/openmp_wrapper.h>
#include <LightGBM/utils/random.h>
#include <LightGBM/utils/threading.h>
Guolin Ke's avatar
Guolin Ke committed
21

22
23
24
25
26
27
28
29
#include <string>
#include <cstdio>
#include <functional>
#include <memory>
#include <mutex>
#include <stdexcept>
#include <vector>

30
#include "application/predictor.hpp"
31
32
#include <LightGBM/utils/yamc/alternate_shared_mutex.hpp>
#include <LightGBM/utils/yamc/yamc_shared_lock.hpp>
Guolin Ke's avatar
Guolin Ke committed
33

Guolin Ke's avatar
Guolin Ke committed
34
35
namespace LightGBM {

Guolin Ke's avatar
Guolin Ke committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
inline int LGBM_APIHandleException(const std::exception& ex) {
  LGBM_SetLastError(ex.what());
  return -1;
}
inline int LGBM_APIHandleException(const std::string& ex) {
  LGBM_SetLastError(ex.c_str());
  return -1;
}

#define API_BEGIN() try {
#define API_END() } \
catch(std::exception& ex) { return LGBM_APIHandleException(ex); } \
catch(std::string& ex) { return LGBM_APIHandleException(ex); } \
catch(...) { return LGBM_APIHandleException("unknown exception"); } \
return 0;

52
53
54
55
56
57
#define UNIQUE_LOCK(mtx) \
std::unique_lock<yamc::alternate::shared_mutex> lock(mtx);

#define SHARED_LOCK(mtx) \
yamc::shared_lock<yamc::alternate::shared_mutex> lock(&mtx);

58
59
60
61
62
63
64
65
const int PREDICTOR_TYPES = 4;

// Single row predictor to abstract away caching logic
class SingleRowPredictor {
 public:
  PredictFunction predict_function;
  int64_t num_pred_in_one_row;

66
  SingleRowPredictor(int predict_type, Boosting* boosting, const Config& config, int start_iter, int num_iter) {
67
68
69
70
71
72
73
74
75
76
77
78
79
    bool is_predict_leaf = false;
    bool is_raw_score = false;
    bool predict_contrib = false;
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
      is_predict_leaf = true;
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
      is_raw_score = true;
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
      predict_contrib = true;
    }
    early_stop_ = config.pred_early_stop;
    early_stop_freq_ = config.pred_early_stop_freq;
    early_stop_margin_ = config.pred_early_stop_margin;
80
81
    iter_ = num_iter;
    predictor_.reset(new Predictor(boosting, start_iter, iter_, is_raw_score, is_predict_leaf, predict_contrib,
82
                                   early_stop_, early_stop_freq_, early_stop_margin_));
83
    num_pred_in_one_row = boosting->NumPredictOneRow(start_iter, iter_, is_predict_leaf, predict_contrib);
84
    predict_function = predictor_->GetPredictFunction();
Guolin Ke's avatar
Guolin Ke committed
85
    num_total_model_ = boosting->NumberOfTotalModel();
86
  }
87

88
  ~SingleRowPredictor() {}
89

Guolin Ke's avatar
Guolin Ke committed
90
  bool IsPredictorEqual(const Config& config, int iter, Boosting* boosting) {
91
92
93
94
95
    return early_stop_ == config.pred_early_stop &&
      early_stop_freq_ == config.pred_early_stop_freq &&
      early_stop_margin_ == config.pred_early_stop_margin &&
      iter_ == iter &&
      num_total_model_ == boosting->NumberOfTotalModel();
96
  }
Guolin Ke's avatar
Guolin Ke committed
97

98
99
100
101
102
103
104
105
106
 private:
  std::unique_ptr<Predictor> predictor_;
  bool early_stop_;
  int early_stop_freq_;
  double early_stop_margin_;
  int iter_;
  int num_total_model_;
};

Guolin Ke's avatar
Guolin Ke committed
107
class Booster {
Nikita Titov's avatar
Nikita Titov committed
108
 public:
Guolin Ke's avatar
Guolin Ke committed
109
  explicit Booster(const char* filename) {
110
    boosting_.reset(Boosting::CreateBoosting("gbdt", filename));
111
112
  }

Guolin Ke's avatar
Guolin Ke committed
113
  Booster(const Dataset* train_data,
114
          const char* parameters) {
Guolin Ke's avatar
Guolin Ke committed
115
    auto param = Config::Str2Map(parameters);
wxchan's avatar
wxchan committed
116
    config_.Set(param);
117
    OMP_SET_NUM_THREADS(config_.num_threads);
Guolin Ke's avatar
Guolin Ke committed
118
    // create boosting
Guolin Ke's avatar
Guolin Ke committed
119
    if (config_.input_model.size() > 0) {
120
121
      Log::Warning("Continued train from model is not supported for c_api,\n"
                   "please use continued train with input score");
Guolin Ke's avatar
Guolin Ke committed
122
    }
Guolin Ke's avatar
Guolin Ke committed
123

Guolin Ke's avatar
Guolin Ke committed
124
    boosting_.reset(Boosting::CreateBoosting(config_.boosting, nullptr));
Guolin Ke's avatar
Guolin Ke committed
125

126
127
    train_data_ = train_data;
    CreateObjectiveAndMetrics();
Guolin Ke's avatar
Guolin Ke committed
128
    // initialize the boosting
Guolin Ke's avatar
Guolin Ke committed
129
    if (config_.tree_learner == std::string("feature")) {
130
      Log::Fatal("Do not support feature parallel in c api");
131
    }
Guolin Ke's avatar
Guolin Ke committed
132
    if (Network::num_machines() == 1 && config_.tree_learner != std::string("serial")) {
133
      Log::Warning("Only find one worker, will switch to serial tree learner");
Guolin Ke's avatar
Guolin Ke committed
134
      config_.tree_learner = "serial";
135
    }
Guolin Ke's avatar
Guolin Ke committed
136
    boosting_->Init(&config_, train_data_, objective_fun_.get(),
137
                    Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
wxchan's avatar
wxchan committed
138
139
140
  }

  void MergeFrom(const Booster* other) {
141
    UNIQUE_LOCK(mutex_)
wxchan's avatar
wxchan committed
142
    boosting_->MergeFrom(other->boosting_.get());
Guolin Ke's avatar
Guolin Ke committed
143
144
145
146
  }

  ~Booster() {
  }
147

148
  void CreateObjectiveAndMetrics() {
Guolin Ke's avatar
Guolin Ke committed
149
    // create objective function
Guolin Ke's avatar
Guolin Ke committed
150
151
    objective_fun_.reset(ObjectiveFunction::CreateObjectiveFunction(config_.objective,
                                                                    config_));
Guolin Ke's avatar
Guolin Ke committed
152
    if (objective_fun_ == nullptr) {
153
      Log::Info("Using self-defined objective function");
Guolin Ke's avatar
Guolin Ke committed
154
155
156
157
158
159
160
161
    }
    // initialize the objective function
    if (objective_fun_ != nullptr) {
      objective_fun_->Init(train_data_->metadata(), train_data_->num_data());
    }

    // create training metric
    train_metric_.clear();
Guolin Ke's avatar
Guolin Ke committed
162
    for (auto metric_type : config_.metric) {
Guolin Ke's avatar
Guolin Ke committed
163
      auto metric = std::unique_ptr<Metric>(
Guolin Ke's avatar
Guolin Ke committed
164
        Metric::CreateMetric(metric_type, config_));
Guolin Ke's avatar
Guolin Ke committed
165
166
167
168
169
      if (metric == nullptr) { continue; }
      metric->Init(train_data_->metadata(), train_data_->num_data());
      train_metric_.push_back(std::move(metric));
    }
    train_metric_.shrink_to_fit();
170
171
172
173
  }

  void ResetTrainingData(const Dataset* train_data) {
    if (train_data != train_data_) {
174
      UNIQUE_LOCK(mutex_)
175
176
177
178
179
180
      train_data_ = train_data;
      CreateObjectiveAndMetrics();
      // reset the boosting
      boosting_->ResetTrainingData(train_data_,
                                   objective_fun_.get(), Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
    }
wxchan's avatar
wxchan committed
181
182
  }

183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
  static void CheckDatasetResetConfig(
      const Config& old_config,
      const std::unordered_map<std::string, std::string>& new_param) {
    Config new_config;
    new_config.Set(new_param);
    if (new_param.count("data_random_seed") &&
        new_config.data_random_seed != old_config.data_random_seed) {
      Log::Fatal("Cannot change data_random_seed after constructed Dataset handle.");
    }
    if (new_param.count("max_bin") &&
        new_config.max_bin != old_config.max_bin) {
      Log::Fatal("Cannot change max_bin after constructed Dataset handle.");
    }
    if (new_param.count("max_bin_by_feature") &&
        new_config.max_bin_by_feature != old_config.max_bin_by_feature) {
      Log::Fatal(
          "Cannot change max_bin_by_feature after constructed Dataset handle.");
    }
    if (new_param.count("bin_construct_sample_cnt") &&
        new_config.bin_construct_sample_cnt !=
            old_config.bin_construct_sample_cnt) {
      Log::Fatal(
          "Cannot change bin_construct_sample_cnt after constructed Dataset "
          "handle.");
    }
    if (new_param.count("min_data_in_bin") &&
        new_config.min_data_in_bin != old_config.min_data_in_bin) {
      Log::Fatal(
          "Cannot change min_data_in_bin after constructed Dataset handle.");
    }
    if (new_param.count("use_missing") &&
        new_config.use_missing != old_config.use_missing) {
      Log::Fatal("Cannot change use_missing after constructed Dataset handle.");
    }
    if (new_param.count("zero_as_missing") &&
        new_config.zero_as_missing != old_config.zero_as_missing) {
      Log::Fatal(
          "Cannot change zero_as_missing after constructed Dataset handle.");
    }
    if (new_param.count("categorical_feature") &&
        new_config.categorical_feature != old_config.categorical_feature) {
      Log::Fatal(
          "Cannot change categorical_feature after constructed Dataset "
          "handle.");
    }
    if (new_param.count("feature_pre_filter") &&
        new_config.feature_pre_filter != old_config.feature_pre_filter) {
      Log::Fatal(
          "Cannot change feature_pre_filter after constructed Dataset handle.");
    }
    if (new_param.count("is_enable_sparse") &&
        new_config.is_enable_sparse != old_config.is_enable_sparse) {
      Log::Fatal(
          "Cannot change is_enable_sparse after constructed Dataset handle.");
    }
    if (new_param.count("pre_partition") &&
        new_config.pre_partition != old_config.pre_partition) {
      Log::Fatal(
          "Cannot change pre_partition after constructed Dataset handle.");
    }
    if (new_param.count("enable_bundle") &&
        new_config.enable_bundle != old_config.enable_bundle) {
      Log::Fatal(
          "Cannot change enable_bundle after constructed Dataset handle.");
    }
    if (new_param.count("header") && new_config.header != old_config.header) {
      Log::Fatal("Cannot change header after constructed Dataset handle.");
    }
    if (new_param.count("two_round") &&
        new_config.two_round != old_config.two_round) {
      Log::Fatal("Cannot change two_round after constructed Dataset handle.");
    }
    if (new_param.count("label_column") &&
        new_config.label_column != old_config.label_column) {
      Log::Fatal(
          "Cannot change label_column after constructed Dataset handle.");
    }
    if (new_param.count("weight_column") &&
        new_config.weight_column != old_config.weight_column) {
      Log::Fatal(
          "Cannot change weight_column after constructed Dataset handle.");
    }
    if (new_param.count("group_column") &&
        new_config.group_column != old_config.group_column) {
      Log::Fatal(
          "Cannot change group_column after constructed Dataset handle.");
    }
    if (new_param.count("ignore_column") &&
        new_config.ignore_column != old_config.ignore_column) {
      Log::Fatal(
          "Cannot change ignore_column after constructed Dataset handle.");
    }
    if (new_param.count("forcedbins_filename")) {
      Log::Fatal("Cannot change forced bins after constructed Dataset handle.");
    }
    if (new_param.count("min_data_in_leaf") &&
        new_config.min_data_in_leaf < old_config.min_data_in_leaf &&
        old_config.feature_pre_filter) {
      Log::Fatal(
          "Reducing `min_data_in_leaf` with `feature_pre_filter=true` may "
          "cause unexpected behaviour "
          "for features that were pre-filtered by the larger "
          "`min_data_in_leaf`.\n"
          "You need to set `feature_pre_filter=false` to dynamically change "
          "the `min_data_in_leaf`.");
    }
Nikita Titov's avatar
Nikita Titov committed
289
    if (new_param.count("linear_tree") && new_config.linear_tree != old_config.linear_tree) {
290
      Log::Fatal("Cannot change linear_tree after constructed Dataset handle.");
291
    }
Nikita Titov's avatar
Nikita Titov committed
292
293
294
295
    if (new_param.count("precise_float_parser") &&
        new_config.precise_float_parser != old_config.precise_float_parser) {
      Log::Fatal("Cannot change precise_float_parser after constructed Dataset handle.");
    }
296
297
  }

wxchan's avatar
wxchan committed
298
  void ResetConfig(const char* parameters) {
299
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
300
    auto param = Config::Str2Map(parameters);
301
302
303
    Config new_config;
    new_config.Set(param);
    if (param.count("num_class") && new_config.num_class != config_.num_class) {
304
      Log::Fatal("Cannot change num_class during training");
wxchan's avatar
wxchan committed
305
    }
306
    if (param.count("boosting") && new_config.boosting != config_.boosting) {
Guolin Ke's avatar
Guolin Ke committed
307
      Log::Fatal("Cannot change boosting during training");
wxchan's avatar
wxchan committed
308
    }
309
    if (param.count("metric") && new_config.metric != config_.metric) {
310
      Log::Fatal("Cannot change metric during training");
Guolin Ke's avatar
Guolin Ke committed
311
    }
312
313
    CheckDatasetResetConfig(config_, param);

Guolin Ke's avatar
Guolin Ke committed
314
    config_.Set(param);
315

316
    OMP_SET_NUM_THREADS(config_.num_threads);
Guolin Ke's avatar
Guolin Ke committed
317
318
319

    if (param.count("objective")) {
      // create objective function
Guolin Ke's avatar
Guolin Ke committed
320
321
      objective_fun_.reset(ObjectiveFunction::CreateObjectiveFunction(config_.objective,
                                                                      config_));
Guolin Ke's avatar
Guolin Ke committed
322
      if (objective_fun_ == nullptr) {
323
        Log::Info("Using self-defined objective function");
Guolin Ke's avatar
Guolin Ke committed
324
325
326
327
328
      }
      // initialize the objective function
      if (objective_fun_ != nullptr) {
        objective_fun_->Init(train_data_->metadata(), train_data_->num_data());
      }
329
330
      boosting_->ResetTrainingData(train_data_,
                                   objective_fun_.get(), Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
wxchan's avatar
wxchan committed
331
    }
Guolin Ke's avatar
Guolin Ke committed
332

Guolin Ke's avatar
Guolin Ke committed
333
    boosting_->ResetConfig(&config_);
wxchan's avatar
wxchan committed
334
335
336
  }

  void AddValidData(const Dataset* valid_data) {
337
    UNIQUE_LOCK(mutex_)
wxchan's avatar
wxchan committed
338
    valid_metrics_.emplace_back();
Guolin Ke's avatar
Guolin Ke committed
339
340
    for (auto metric_type : config_.metric) {
      auto metric = std::unique_ptr<Metric>(Metric::CreateMetric(metric_type, config_));
wxchan's avatar
wxchan committed
341
342
343
344
345
346
      if (metric == nullptr) { continue; }
      metric->Init(valid_data->metadata(), valid_data->num_data());
      valid_metrics_.back().push_back(std::move(metric));
    }
    valid_metrics_.back().shrink_to_fit();
    boosting_->AddValidDataset(valid_data,
347
                               Common::ConstPtrInVectorWrapper<Metric>(valid_metrics_.back()));
wxchan's avatar
wxchan committed
348
  }
Guolin Ke's avatar
Guolin Ke committed
349

350
  bool TrainOneIter() {
351
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
352
    return boosting_->TrainOneIter(nullptr, nullptr);
353
354
  }

Guolin Ke's avatar
Guolin Ke committed
355
  void Refit(const int32_t* leaf_preds, int32_t nrow, int32_t ncol) {
356
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
357
358
359
    std::vector<std::vector<int32_t>> v_leaf_preds(nrow, std::vector<int32_t>(ncol, 0));
    for (int i = 0; i < nrow; ++i) {
      for (int j = 0; j < ncol; ++j) {
360
        v_leaf_preds[i][j] = leaf_preds[static_cast<size_t>(i) * static_cast<size_t>(ncol) + static_cast<size_t>(j)];
Guolin Ke's avatar
Guolin Ke committed
361
362
363
364
365
      }
    }
    boosting_->RefitTree(v_leaf_preds);
  }

366
  bool TrainOneIter(const score_t* gradients, const score_t* hessians) {
367
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
368
    return boosting_->TrainOneIter(gradients, hessians);
369
370
  }

wxchan's avatar
wxchan committed
371
  void RollbackOneIter() {
372
    UNIQUE_LOCK(mutex_)
wxchan's avatar
wxchan committed
373
374
375
    boosting_->RollbackOneIter();
  }

376
  void SetSingleRowPredictor(int start_iteration, int num_iteration, int predict_type, const Config& config) {
377
378
379
380
      UNIQUE_LOCK(mutex_)
      if (single_row_predictor_[predict_type].get() == nullptr ||
          !single_row_predictor_[predict_type]->IsPredictorEqual(config, num_iteration, boosting_.get())) {
        single_row_predictor_[predict_type].reset(new SingleRowPredictor(predict_type, boosting_.get(),
381
                                                                         config, start_iteration, num_iteration));
382
383
384
385
      }
  }

  void PredictSingleRow(int predict_type, int ncol,
386
387
               std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun,
               const Config& config,
388
               double* out_result, int64_t* out_len) const {
389
390
391
    if (!config.predict_disable_shape_check && ncol != boosting_->MaxFeatureIdx() + 1) {
      Log::Fatal("The number of features in data (%d) is not the same as it was in training data (%d).\n"\
                 "You can set ``predict_disable_shape_check=true`` to discard this error, but please be aware what you are doing.", ncol, boosting_->MaxFeatureIdx() + 1);
392
    }
393
    UNIQUE_LOCK(mutex_)
394
    const auto& single_row_predictor = single_row_predictor_[predict_type];
395
396
    auto one_row = get_row_fun(0);
    auto pred_wrt_ptr = out_result;
397
    single_row_predictor->predict_function(one_row, pred_wrt_ptr);
398

399
    *out_len = single_row_predictor->num_pred_in_one_row;
400
401
  }

402
  Predictor CreatePredictor(int start_iteration, int num_iteration, int predict_type, int ncol, const Config& config) const {
403
404
405
    if (!config.predict_disable_shape_check && ncol != boosting_->MaxFeatureIdx() + 1) {
      Log::Fatal("The number of features in data (%d) is not the same as it was in training data (%d).\n" \
                 "You can set ``predict_disable_shape_check=true`` to discard this error, but please be aware what you are doing.", ncol, boosting_->MaxFeatureIdx() + 1);
406
    }
Guolin Ke's avatar
Guolin Ke committed
407
408
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
409
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
410
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
Guolin Ke's avatar
Guolin Ke committed
411
      is_predict_leaf = true;
Guolin Ke's avatar
Guolin Ke committed
412
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
Guolin Ke's avatar
Guolin Ke committed
413
      is_raw_score = true;
414
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
415
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
416
417
    } else {
      is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
418
    }
Guolin Ke's avatar
Guolin Ke committed
419

420
    return Predictor(boosting_.get(), start_iteration, num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
421
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin);
422
423
  }

424
  void Predict(int start_iteration, int num_iteration, int predict_type, int nrow, int ncol,
425
426
               std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun,
               const Config& config,
427
428
               double* out_result, int64_t* out_len) const {
    SHARED_LOCK(mutex_);
429
    auto predictor = CreatePredictor(start_iteration, num_iteration, predict_type, ncol, config);
430
431
432
433
434
435
436
    bool is_predict_leaf = false;
    bool predict_contrib = false;
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
      is_predict_leaf = true;
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
      predict_contrib = true;
    }
437
    int64_t num_pred_in_one_row = boosting_->NumPredictOneRow(start_iteration, num_iteration, is_predict_leaf, predict_contrib);
Guolin Ke's avatar
Guolin Ke committed
438
    auto pred_fun = predictor.GetPredictFunction();
439
440
    OMP_INIT_EX();
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
441
    for (int i = 0; i < nrow; ++i) {
442
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
443
      auto one_row = get_row_fun(i);
Tony-Y's avatar
Tony-Y committed
444
      auto pred_wrt_ptr = out_result + static_cast<size_t>(num_pred_in_one_row) * i;
Guolin Ke's avatar
Guolin Ke committed
445
      pred_fun(one_row, pred_wrt_ptr);
446
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
447
    }
448
    OMP_THROW_EX();
449
    *out_len = num_pred_in_one_row * nrow;
Guolin Ke's avatar
Guolin Ke committed
450
451
  }

452
  void PredictSparse(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
453
454
455
456
                     std::function<std::vector<std::pair<int, double>>(int64_t row_idx)> get_row_fun,
                     const Config& config, int64_t* out_elements_size,
                     std::vector<std::vector<std::unordered_map<int, double>>>* agg_ptr,
                     int32_t** out_indices, void** out_data, int data_type,
457
                     bool* is_data_float32_ptr, int num_matrices) const {
458
    auto predictor = CreatePredictor(start_iteration, num_iteration, predict_type, ncol, config);
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
    auto pred_sparse_fun = predictor.GetPredictSparseFunction();
    std::vector<std::vector<std::unordered_map<int, double>>>& agg = *agg_ptr;
    OMP_INIT_EX();
    #pragma omp parallel for schedule(static)
    for (int64_t i = 0; i < nrow; ++i) {
      OMP_LOOP_EX_BEGIN();
      auto one_row = get_row_fun(i);
      agg[i] = std::vector<std::unordered_map<int, double>>(num_matrices);
      pred_sparse_fun(one_row, &agg[i]);
      OMP_LOOP_EX_END();
    }
    OMP_THROW_EX();
    // calculate the nonzero data and indices size
    int64_t elements_size = 0;
    for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
      auto row_vector = agg[i];
      for (int j = 0; j < static_cast<int>(row_vector.size()); ++j) {
        elements_size += static_cast<int64_t>(row_vector[j].size());
      }
    }
    *out_elements_size = elements_size;
    *is_data_float32_ptr = false;
    // allocate data and indices arrays
    if (data_type == C_API_DTYPE_FLOAT32) {
      *out_data = new float[elements_size];
      *is_data_float32_ptr = true;
    } else if (data_type == C_API_DTYPE_FLOAT64) {
      *out_data = new double[elements_size];
    } else {
      Log::Fatal("Unknown data type in PredictSparse");
      return;
    }
    *out_indices = new int32_t[elements_size];
  }

494
  void PredictSparseCSR(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
495
496
497
                        std::function<std::vector<std::pair<int, double>>(int64_t row_idx)> get_row_fun,
                        const Config& config,
                        int64_t* out_len, void** out_indptr, int indptr_type,
498
499
                        int32_t** out_indices, void** out_data, int data_type) const {
    SHARED_LOCK(mutex_);
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
    // Get the number of trees per iteration (for multiclass scenario we output multiple sparse matrices)
    int num_matrices = boosting_->NumModelPerIteration();
    bool is_indptr_int32 = false;
    bool is_data_float32 = false;
    int64_t indptr_size = (nrow + 1) * num_matrices;
    if (indptr_type == C_API_DTYPE_INT32) {
      *out_indptr = new int32_t[indptr_size];
      is_indptr_int32 = true;
    } else if (indptr_type == C_API_DTYPE_INT64) {
      *out_indptr = new int64_t[indptr_size];
    } else {
      Log::Fatal("Unknown indptr type in PredictSparseCSR");
      return;
    }
    // aggregated per row feature contribution results
    std::vector<std::vector<std::unordered_map<int, double>>> agg(nrow);
    int64_t elements_size = 0;
517
    PredictSparse(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, &elements_size, &agg,
518
519
520
                  out_indices, out_data, data_type, &is_data_float32, num_matrices);
    std::vector<int> row_sizes(num_matrices * nrow);
    std::vector<int64_t> row_matrix_offsets(num_matrices * nrow);
521
    std::vector<int64_t> matrix_offsets(num_matrices);
522
523
524
525
526
527
528
529
530
531
532
533
534
535
    int64_t row_vector_cnt = 0;
    for (int m = 0; m < num_matrices; ++m) {
      for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
        auto row_vector = agg[i];
        auto row_vector_size = row_vector[m].size();
        // keep track of the row_vector sizes for parallelization
        row_sizes[row_vector_cnt] = static_cast<int>(row_vector_size);
        if (i == 0) {
          row_matrix_offsets[row_vector_cnt] = 0;
        } else {
          row_matrix_offsets[row_vector_cnt] = static_cast<int64_t>(row_sizes[row_vector_cnt - 1] + row_matrix_offsets[row_vector_cnt - 1]);
        }
        row_vector_cnt++;
      }
536
537
538
539
540
541
      if (m == 0) {
        matrix_offsets[m] = 0;
      }
      if (m + 1 < num_matrices) {
        matrix_offsets[m + 1] = static_cast<int64_t>(matrix_offsets[m] + row_matrix_offsets[row_vector_cnt - 1] + row_sizes[row_vector_cnt - 1]);
      }
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
    }
    // copy vector results to output for each row
    int64_t indptr_index = 0;
    for (int m = 0; m < num_matrices; ++m) {
      if (is_indptr_int32) {
        (reinterpret_cast<int32_t*>(*out_indptr))[indptr_index] = 0;
      } else {
        (reinterpret_cast<int64_t*>(*out_indptr))[indptr_index] = 0;
      }
      indptr_index++;
      int64_t matrix_start_index = m * static_cast<int64_t>(agg.size());
      OMP_INIT_EX();
      #pragma omp parallel for schedule(static)
      for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
        OMP_LOOP_EX_BEGIN();
        auto row_vector = agg[i];
        int64_t row_start_index = matrix_start_index + i;
559
        int64_t element_index = row_matrix_offsets[row_start_index] + matrix_offsets[m];
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
        int64_t indptr_loop_index = indptr_index + i;
        for (auto it = row_vector[m].begin(); it != row_vector[m].end(); ++it) {
          (*out_indices)[element_index] = it->first;
          if (is_data_float32) {
            (reinterpret_cast<float*>(*out_data))[element_index] = static_cast<float>(it->second);
          } else {
            (reinterpret_cast<double*>(*out_data))[element_index] = it->second;
          }
          element_index++;
        }
        int64_t indptr_value = row_matrix_offsets[row_start_index] + row_sizes[row_start_index];
        if (is_indptr_int32) {
          (reinterpret_cast<int32_t*>(*out_indptr))[indptr_loop_index] = static_cast<int32_t>(indptr_value);
        } else {
          (reinterpret_cast<int64_t*>(*out_indptr))[indptr_loop_index] = indptr_value;
        }
        OMP_LOOP_EX_END();
      }
      OMP_THROW_EX();
      indptr_index += static_cast<int64_t>(agg.size());
    }
    out_len[0] = elements_size;
    out_len[1] = indptr_size;
  }

585
  void PredictSparseCSC(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
586
587
588
                        std::function<std::vector<std::pair<int, double>>(int64_t row_idx)> get_row_fun,
                        const Config& config,
                        int64_t* out_len, void** out_col_ptr, int col_ptr_type,
589
590
                        int32_t** out_indices, void** out_data, int data_type) const {
    SHARED_LOCK(mutex_);
591
592
    // Get the number of trees per iteration (for multiclass scenario we output multiple sparse matrices)
    int num_matrices = boosting_->NumModelPerIteration();
593
    auto predictor = CreatePredictor(start_iteration, num_iteration, predict_type, ncol, config);
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
    auto pred_sparse_fun = predictor.GetPredictSparseFunction();
    bool is_col_ptr_int32 = false;
    bool is_data_float32 = false;
    int num_output_cols = ncol + 1;
    int col_ptr_size = (num_output_cols + 1) * num_matrices;
    if (col_ptr_type == C_API_DTYPE_INT32) {
      *out_col_ptr = new int32_t[col_ptr_size];
      is_col_ptr_int32 = true;
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
      *out_col_ptr = new int64_t[col_ptr_size];
    } else {
      Log::Fatal("Unknown col_ptr type in PredictSparseCSC");
      return;
    }
    // aggregated per row feature contribution results
    std::vector<std::vector<std::unordered_map<int, double>>> agg(nrow);
    int64_t elements_size = 0;
611
    PredictSparse(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, &elements_size, &agg,
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
                  out_indices, out_data, data_type, &is_data_float32, num_matrices);
    // calculate number of elements per column to construct
    // the CSC matrix with random access
    std::vector<std::vector<int64_t>> column_sizes(num_matrices);
    for (int m = 0; m < num_matrices; ++m) {
      column_sizes[m] = std::vector<int64_t>(num_output_cols, 0);
      for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
        auto row_vector = agg[i];
        for (auto it = row_vector[m].begin(); it != row_vector[m].end(); ++it) {
          column_sizes[m][it->first] += 1;
        }
      }
    }
    // keep track of column counts
    std::vector<std::vector<int64_t>> column_counts(num_matrices);
    // keep track of beginning index for each column
    std::vector<std::vector<int64_t>> column_start_indices(num_matrices);
    // keep track of beginning index for each matrix
    std::vector<int64_t> matrix_start_indices(num_matrices, 0);
    int col_ptr_index = 0;
    for (int m = 0; m < num_matrices; ++m) {
      int64_t col_ptr_value = 0;
      column_start_indices[m] = std::vector<int64_t>(num_output_cols, 0);
      column_counts[m] = std::vector<int64_t>(num_output_cols, 0);
      if (is_col_ptr_int32) {
        (reinterpret_cast<int32_t*>(*out_col_ptr))[col_ptr_index] = static_cast<int32_t>(col_ptr_value);
      } else {
        (reinterpret_cast<int64_t*>(*out_col_ptr))[col_ptr_index] = col_ptr_value;
      }
      col_ptr_index++;
      for (int64_t i = 1; i < static_cast<int64_t>(column_sizes[m].size()); ++i) {
        column_start_indices[m][i] = column_sizes[m][i - 1] + column_start_indices[m][i - 1];
        if (is_col_ptr_int32) {
          (reinterpret_cast<int32_t*>(*out_col_ptr))[col_ptr_index] = static_cast<int32_t>(column_start_indices[m][i]);
        } else {
          (reinterpret_cast<int64_t*>(*out_col_ptr))[col_ptr_index] = column_start_indices[m][i];
        }
        col_ptr_index++;
      }
      int64_t last_elem_index = static_cast<int64_t>(column_sizes[m].size()) - 1;
      int64_t last_column_start_index = column_start_indices[m][last_elem_index];
      int64_t last_column_size = column_sizes[m][last_elem_index];
      if (is_col_ptr_int32) {
        (reinterpret_cast<int32_t*>(*out_col_ptr))[col_ptr_index] = static_cast<int32_t>(last_column_start_index + last_column_size);
      } else {
        (reinterpret_cast<int64_t*>(*out_col_ptr))[col_ptr_index] = last_column_start_index + last_column_size;
      }
659
660
      if (m + 1 < num_matrices) {
        matrix_start_indices[m + 1] = matrix_start_indices[m] + last_column_start_index + last_column_size;
661
      }
662
      col_ptr_index++;
663
    }
664
665
666
    // Note: we parallelize across matrices instead of rows because of the column_counts[m][col_idx] increment inside the loop
    OMP_INIT_EX();
    #pragma omp parallel for schedule(static)
667
    for (int m = 0; m < num_matrices; ++m) {
668
      OMP_LOOP_EX_BEGIN();
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
      for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
        auto row_vector = agg[i];
        for (auto it = row_vector[m].begin(); it != row_vector[m].end(); ++it) {
          int64_t col_idx = it->first;
          int64_t element_index = column_start_indices[m][col_idx] +
            matrix_start_indices[m] +
            column_counts[m][col_idx];
          // store the row index
          (*out_indices)[element_index] = static_cast<int32_t>(i);
          // update column count
          column_counts[m][col_idx]++;
          if (is_data_float32) {
            (reinterpret_cast<float*>(*out_data))[element_index] = static_cast<float>(it->second);
          } else {
            (reinterpret_cast<double*>(*out_data))[element_index] = it->second;
          }
        }
      }
687
      OMP_LOOP_EX_END();
688
    }
689
    OMP_THROW_EX();
690
691
692
693
    out_len[0] = elements_size;
    out_len[1] = col_ptr_size;
  }

694
  void Predict(int start_iteration, int num_iteration, int predict_type, const char* data_filename,
Guolin Ke's avatar
Guolin Ke committed
695
               int data_has_header, const Config& config,
696
697
               const char* result_filename) const {
    SHARED_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
698
699
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
700
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
701
702
703
704
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
      is_predict_leaf = true;
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
      is_raw_score = true;
705
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
706
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
707
708
709
    } else {
      is_raw_score = false;
    }
710
    Predictor predictor(boosting_.get(), start_iteration, num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
711
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin);
Guolin Ke's avatar
Guolin Ke committed
712
    bool bool_data_has_header = data_has_header > 0 ? true : false;
Chen Yufei's avatar
Chen Yufei committed
713
714
    predictor.Predict(data_filename, result_filename, bool_data_has_header, config.predict_disable_shape_check,
                      config.precise_float_parser);
Guolin Ke's avatar
Guolin Ke committed
715
716
  }

717
  void GetPredictAt(int data_idx, double* out_result, int64_t* out_len) const {
wxchan's avatar
wxchan committed
718
719
720
    boosting_->GetPredictAt(data_idx, out_result, out_len);
  }

721
  void SaveModelToFile(int start_iteration, int num_iteration, int feature_importance_type, const char* filename) const {
722
    boosting_->SaveModelToFile(start_iteration, num_iteration, feature_importance_type, filename);
Guolin Ke's avatar
Guolin Ke committed
723
  }
724

725
  void LoadModelFromString(const char* model_str) {
726
727
    size_t len = std::strlen(model_str);
    boosting_->LoadModelFromString(model_str, len);
728
729
  }

730
  std::string SaveModelToString(int start_iteration, int num_iteration,
731
                                int feature_importance_type) const {
732
733
    return boosting_->SaveModelToString(start_iteration,
                                        num_iteration, feature_importance_type);
734
735
  }

736
  std::string DumpModel(int start_iteration, int num_iteration,
737
                        int feature_importance_type) const {
738
739
    return boosting_->DumpModel(start_iteration, num_iteration,
                                feature_importance_type);
wxchan's avatar
wxchan committed
740
  }
741

742
  std::vector<double> FeatureImportance(int num_iteration, int importance_type) const {
743
744
745
    return boosting_->FeatureImportance(num_iteration, importance_type);
  }

746
  double UpperBoundValue() const {
747
    SHARED_LOCK(mutex_)
748
749
750
751
    return boosting_->GetUpperBoundValue();
  }

  double LowerBoundValue() const {
752
    SHARED_LOCK(mutex_)
753
754
755
    return boosting_->GetLowerBoundValue();
  }

Guolin Ke's avatar
Guolin Ke committed
756
  double GetLeafValue(int tree_idx, int leaf_idx) const {
757
    SHARED_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
758
    return dynamic_cast<GBDTBase*>(boosting_.get())->GetLeafValue(tree_idx, leaf_idx);
Guolin Ke's avatar
Guolin Ke committed
759
760
761
  }

  void SetLeafValue(int tree_idx, int leaf_idx, double val) {
762
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
763
    dynamic_cast<GBDTBase*>(boosting_.get())->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
764
765
  }

766
  void ShuffleModels(int start_iter, int end_iter) {
767
    UNIQUE_LOCK(mutex_)
768
    boosting_->ShuffleModels(start_iter, end_iter);
769
770
  }

wxchan's avatar
wxchan committed
771
  int GetEvalCounts() const {
772
    SHARED_LOCK(mutex_)
wxchan's avatar
wxchan committed
773
774
775
776
777
778
    int ret = 0;
    for (const auto& metric : train_metric_) {
      ret += static_cast<int>(metric->GetName().size());
    }
    return ret;
  }
779

780
  int GetEvalNames(char** out_strs, const int len, const size_t buffer_len, size_t *out_buffer_len) const {
781
    SHARED_LOCK(mutex_)
782
    *out_buffer_len = 0;
wxchan's avatar
wxchan committed
783
784
785
    int idx = 0;
    for (const auto& metric : train_metric_) {
      for (const auto& name : metric->GetName()) {
786
787
788
789
790
        if (idx < len) {
          std::memcpy(out_strs[idx], name.c_str(), std::min(name.size() + 1, buffer_len));
          out_strs[idx][buffer_len - 1] = '\0';
        }
        *out_buffer_len = std::max(name.size() + 1, *out_buffer_len);
wxchan's avatar
wxchan committed
791
792
793
794
795
796
        ++idx;
      }
    }
    return idx;
  }

797
  int GetFeatureNames(char** out_strs, const int len, const size_t buffer_len, size_t *out_buffer_len) const {
798
    SHARED_LOCK(mutex_)
799
    *out_buffer_len = 0;
wxchan's avatar
wxchan committed
800
801
    int idx = 0;
    for (const auto& name : boosting_->FeatureNames()) {
802
803
804
805
806
      if (idx < len) {
        std::memcpy(out_strs[idx], name.c_str(), std::min(name.size() + 1, buffer_len));
        out_strs[idx][buffer_len - 1] = '\0';
      }
      *out_buffer_len = std::max(name.size() + 1, *out_buffer_len);
wxchan's avatar
wxchan committed
807
808
809
810
811
      ++idx;
    }
    return idx;
  }

wxchan's avatar
wxchan committed
812
  const Boosting* GetBoosting() const { return boosting_.get(); }
Guolin Ke's avatar
Guolin Ke committed
813

Nikita Titov's avatar
Nikita Titov committed
814
 private:
wxchan's avatar
wxchan committed
815
  const Dataset* train_data_;
Guolin Ke's avatar
Guolin Ke committed
816
  std::unique_ptr<Boosting> boosting_;
817
  std::unique_ptr<SingleRowPredictor> single_row_predictor_[PREDICTOR_TYPES];
818

Guolin Ke's avatar
Guolin Ke committed
819
  /*! \brief All configs */
Guolin Ke's avatar
Guolin Ke committed
820
  Config config_;
Guolin Ke's avatar
Guolin Ke committed
821
  /*! \brief Metric for training data */
Guolin Ke's avatar
Guolin Ke committed
822
  std::vector<std::unique_ptr<Metric>> train_metric_;
Guolin Ke's avatar
Guolin Ke committed
823
  /*! \brief Metrics for validation data */
Guolin Ke's avatar
Guolin Ke committed
824
  std::vector<std::vector<std::unique_ptr<Metric>>> valid_metrics_;
Guolin Ke's avatar
Guolin Ke committed
825
  /*! \brief Training objective function */
Guolin Ke's avatar
Guolin Ke committed
826
  std::unique_ptr<ObjectiveFunction> objective_fun_;
wxchan's avatar
wxchan committed
827
  /*! \brief mutex for threading safe call */
828
  mutable yamc::alternate::shared_mutex mutex_;
Guolin Ke's avatar
Guolin Ke committed
829
830
};

831
}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
832

833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
// explicitly declare symbols from LightGBM namespace
using LightGBM::AllgatherFunction;
using LightGBM::Booster;
using LightGBM::Common::CheckElementsIntervalClosed;
using LightGBM::Common::RemoveQuotationSymbol;
using LightGBM::Common::Vector2Ptr;
using LightGBM::Common::VectorSize;
using LightGBM::Config;
using LightGBM::data_size_t;
using LightGBM::Dataset;
using LightGBM::DatasetLoader;
using LightGBM::kZeroThreshold;
using LightGBM::LGBM_APIHandleException;
using LightGBM::Log;
using LightGBM::Network;
using LightGBM::Random;
using LightGBM::ReduceScatterFunction;
Guolin Ke's avatar
Guolin Ke committed
850

Guolin Ke's avatar
Guolin Ke committed
851
852
853
854
855
856
857
858
// some help functions used to convert data

std::function<std::vector<double>(int row_idx)>
RowFunctionFromDenseMatric(const void* data, int num_row, int num_col, int data_type, int is_row_major);

std::function<std::vector<std::pair<int, double>>(int row_idx)>
RowPairFunctionFromDenseMatric(const void* data, int num_row, int num_col, int data_type, int is_row_major);

859
860
861
std::function<std::vector<std::pair<int, double>>(int row_idx)>
RowPairFunctionFromDenseRows(const void** data, int num_col, int data_type);

862
863
template<typename T>
std::function<std::vector<std::pair<int, double>>(T idx)>
Guolin Ke's avatar
Guolin Ke committed
864
RowFunctionFromCSR(const void* indptr, int indptr_type, const int32_t* indices,
865
                   const void* data, int data_type, int64_t nindptr, int64_t nelem);
Guolin Ke's avatar
Guolin Ke committed
866
867
868

// Row iterator of on column for CSC matrix
class CSC_RowIterator {
Nikita Titov's avatar
Nikita Titov committed
869
 public:
Guolin Ke's avatar
Guolin Ke committed
870
  CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
871
                  const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx);
Guolin Ke's avatar
Guolin Ke committed
872
873
874
875
876
  ~CSC_RowIterator() {}
  // return value at idx, only can access by ascent order
  double Get(int idx);
  // return next non-zero pair, if index < 0, means no more data
  std::pair<int, double> NextNonZero();
Nikita Titov's avatar
Nikita Titov committed
877
878

 private:
Guolin Ke's avatar
Guolin Ke committed
879
880
881
882
883
884
885
886
887
  int nonzero_idx_ = 0;
  int cur_idx_ = -1;
  double cur_val_ = 0.0f;
  bool is_end_ = false;
  std::function<std::pair<int, double>(int idx)> iter_fun_;
};

// start of c_api functions

Guolin Ke's avatar
Guolin Ke committed
888
const char* LGBM_GetLastError() {
wxchan's avatar
wxchan committed
889
  return LastErrorMsg();
Guolin Ke's avatar
Guolin Ke committed
890
891
}

892
893
894
895
896
897
898
899
900
901
902
903
int LGBM_DumpParamAliases(int64_t buffer_len,
                          int64_t* out_len,
                          char* out_str) {
  API_BEGIN();
  std::string aliases = Config::DumpAliases();
  *out_len = static_cast<int64_t>(aliases.size()) + 1;
  if (*out_len <= buffer_len) {
    std::memcpy(out_str, aliases.c_str(), *out_len);
  }
  API_END();
}

904
905
906
907
908
909
int LGBM_RegisterLogCallback(void (*callback)(const char*)) {
  API_BEGIN();
  Log::ResetCallBack(callback);
  API_END();
}

910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
static inline int SampleCount(int32_t total_nrow, const Config& config) {
  return static_cast<int>(total_nrow < config.bin_construct_sample_cnt ? total_nrow : config.bin_construct_sample_cnt);
}

static inline std::vector<int32_t> CreateSampleIndices(int32_t total_nrow, const Config& config) {
  Random rand(config.data_random_seed);
  int sample_cnt = SampleCount(total_nrow, config);
  return rand.Sample(total_nrow, sample_cnt);
}

int LGBM_GetSampleCount(int32_t num_total_row,
                        const char* parameters,
                        int* out) {
  API_BEGIN();
  if (out == nullptr) {
    Log::Fatal("LGBM_GetSampleCount output is nullptr");
  }
  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);

  *out = SampleCount(num_total_row, config);
  API_END();
}

int LGBM_SampleIndices(int32_t num_total_row,
                       const char* parameters,
                       void* out,
                       int32_t* out_len) {
  // This API is to keep python binding's behavior the same with C++ implementation.
  // Sample count, random seed etc. should be provided in parameters.
  API_BEGIN();
  if (out == nullptr) {
    Log::Fatal("LGBM_SampleIndices output is nullptr");
  }
  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);

  auto sample_indices = CreateSampleIndices(num_total_row, config);
  memcpy(out, sample_indices.data(), sizeof(int32_t) * sample_indices.size());
  *out_len = static_cast<int32_t>(sample_indices.size());
  API_END();
}

955
956
957
958
959
960
961
962
963
964
965
966
967
int LGBM_ByteBufferGetAt(ByteBufferHandle handle, int32_t index, uint8_t* out_val) {
  API_BEGIN();
  LightGBM::ByteBuffer* byteBuffer = reinterpret_cast<LightGBM::ByteBuffer*>(handle);
  *out_val = byteBuffer->GetAt(index);
  API_END();
}

int LGBM_ByteBufferFree(ByteBufferHandle handle) {
  API_BEGIN();
  delete reinterpret_cast<LightGBM::ByteBuffer*>(handle);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
968
int LGBM_DatasetCreateFromFile(const char* filename,
969
970
971
                               const char* parameters,
                               const DatasetHandle reference,
                               DatasetHandle* out) {
972
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
973
974
  auto param = Config::Str2Map(parameters);
  Config config;
975
  config.Set(param);
976
  OMP_SET_NUM_THREADS(config.num_threads);
977
  DatasetLoader loader(config, nullptr, 1, filename);
Guolin Ke's avatar
Guolin Ke committed
978
  if (reference == nullptr) {
979
    if (Network::num_machines() == 1) {
980
      *out = loader.LoadFromFile(filename);
981
    } else {
982
      *out = loader.LoadFromFile(filename, Network::rank(), Network::num_machines());
983
    }
Guolin Ke's avatar
Guolin Ke committed
984
  } else {
985
    *out = loader.LoadFromFileAlignWithOtherDataset(filename,
986
                                                    reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
987
  }
988
  API_END();
Guolin Ke's avatar
Guolin Ke committed
989
990
}

Guolin Ke's avatar
Guolin Ke committed
991
int LGBM_DatasetCreateFromSampledColumn(double** sample_data,
992
993
994
995
                                        int** sample_indices,
                                        int32_t ncol,
                                        const int* num_per_col,
                                        int32_t num_sample_row,
996
997
                                        int32_t num_local_row,
                                        int64_t num_dist_row,
998
999
                                        const char* parameters,
                                        DatasetHandle* out) {
1000
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1001
1002
  auto param = Config::Str2Map(parameters);
  Config config;
1003
  config.Set(param);
1004
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
1005
  DatasetLoader loader(config, nullptr, 1, nullptr);
1006
1007
1008
1009
  *out = loader.ConstructFromSampleData(sample_data,
                                        sample_indices,
                                        ncol,
                                        num_per_col,
1010
                                        num_sample_row,
1011
1012
                                        static_cast<data_size_t>(num_local_row),
                                        num_dist_row);
1013
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1014
1015
}

Guolin Ke's avatar
Guolin Ke committed
1016
int LGBM_DatasetCreateByReference(const DatasetHandle reference,
1017
1018
                                  int64_t num_total_row,
                                  DatasetHandle* out) {
Guolin Ke's avatar
Guolin Ke committed
1019
1020
  API_BEGIN();
  std::unique_ptr<Dataset> ret;
1021
1022
1023
1024
1025
  data_size_t nrows = static_cast<data_size_t>(num_total_row);
  ret.reset(new Dataset(nrows));
  const Dataset* reference_dataset = reinterpret_cast<const Dataset*>(reference);
  ret->CreateValid(reference_dataset);
  ret->InitByReference(nrows, reference_dataset);
Guolin Ke's avatar
Guolin Ke committed
1026
1027
1028
1029
  *out = ret.release();
  API_END();
}

1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
int LGBM_DatasetCreateFromSerializedReference(const void* ref_buffer,
                                              int32_t ref_buffer_size,
                                              int64_t num_row,
                                              int32_t num_classes,
                                              const char* parameters,
                                              DatasetHandle* out) {
  API_BEGIN();
  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);
  OMP_SET_NUM_THREADS(config.num_threads);
  DatasetLoader loader(config, nullptr, 1, nullptr);
  *out = loader.LoadFromSerializedReference(static_cast<const char*>(ref_buffer),
    static_cast<size_t>(ref_buffer_size),
    static_cast<data_size_t>(num_row),
    num_classes);
  API_END();
}

1049
1050
1051
1052
1053
int LGBM_DatasetInitStreaming(DatasetHandle dataset,
                              int32_t has_weights,
                              int32_t has_init_scores,
                              int32_t has_queries,
                              int32_t nclasses,
1054
1055
                              int32_t nthreads,
                              int32_t omp_max_threads) {
1056
1057
1058
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto num_data = p_dataset->num_data();
1059
  p_dataset->InitStreaming(num_data, has_weights, has_init_scores, has_queries, nclasses, nthreads, omp_max_threads);
1060
1061
1062
1063
  p_dataset->set_wait_for_manual_finish(true);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1064
int LGBM_DatasetPushRows(DatasetHandle dataset,
1065
1066
1067
1068
1069
                         const void* data,
                         int data_type,
                         int32_t nrow,
                         int32_t ncol,
                         int32_t start_row) {
Guolin Ke's avatar
Guolin Ke committed
1070
1071
1072
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, 1);
1073
1074
1075
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }
1076
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1077
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1078
  for (int i = 0; i < nrow; ++i) {
1079
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1080
1081
1082
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(tid, start_row + i, one_row);
1083
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1084
  }
1085
  OMP_THROW_EX();
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
  if (!p_dataset->wait_for_manual_finish() && (start_row + nrow == p_dataset->num_data())) {
    p_dataset->FinishLoad();
  }
  API_END();
}

int LGBM_DatasetPushRowsWithMetadata(DatasetHandle dataset,
                                     const void* data,
                                     int data_type,
                                     int32_t nrow,
                                     int32_t ncol,
                                     int32_t start_row,
                                     const float* labels,
                                     const float* weights,
                                     const double* init_scores,
                                     const int32_t* queries,
                                     int32_t tid) {
  API_BEGIN();
#ifdef LABEL_T_USE_DOUBLE
  Log::Fatal("Don't support LABEL_T_USE_DOUBLE");
#endif
  if (!data) {
    Log::Fatal("data cannot be null.");
  }
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, 1);
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }

1116
1117
  const int max_omp_threads = p_dataset->omp_max_threads() > 0 ? p_dataset->omp_max_threads() : OMP_NUM_THREADS();

1118
1119
1120
1121
1122
  OMP_INIT_EX();
#pragma omp parallel for schedule(static)
  for (int i = 0; i < nrow; ++i) {
    OMP_LOOP_EX_BEGIN();
    // convert internal thread id to be unique based on external thread id
1123
    const int internal_tid = omp_get_thread_num() + (max_omp_threads * tid);
1124
1125
1126
1127
1128
1129
1130
1131
1132
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(internal_tid, start_row + i, one_row);
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();

  p_dataset->InsertMetadataAt(start_row, nrow, labels, weights, init_scores, queries);

  if (!p_dataset->wait_for_manual_finish() && (start_row + nrow == p_dataset->num_data())) {
Guolin Ke's avatar
Guolin Ke committed
1133
1134
1135
1136
1137
    p_dataset->FinishLoad();
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1138
int LGBM_DatasetPushRowsByCSR(DatasetHandle dataset,
1139
1140
1141
1142
1143
1144
1145
1146
1147
                              const void* indptr,
                              int indptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t nindptr,
                              int64_t nelem,
                              int64_t,
                              int64_t start_row) {
Guolin Ke's avatar
Guolin Ke committed
1148
1149
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
1150
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
1151
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
1152
1153
1154
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }
1155
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1156
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1157
  for (int i = 0; i < nrow; ++i) {
1158
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1159
1160
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
1161
    p_dataset->PushOneRow(tid, static_cast<data_size_t>(start_row + i), one_row);
1162
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1163
  }
1164
  OMP_THROW_EX();
1165
  if (!p_dataset->wait_for_manual_finish() && (start_row + nrow == static_cast<int64_t>(p_dataset->num_data()))) {
Guolin Ke's avatar
Guolin Ke committed
1166
1167
    p_dataset->FinishLoad();
  }
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
  API_END();
}

int LGBM_DatasetPushRowsByCSRWithMetadata(DatasetHandle dataset,
                                          const void* indptr,
                                          int indptr_type,
                                          const int32_t* indices,
                                          const void* data,
                                          int data_type,
                                          int64_t nindptr,
                                          int64_t nelem,
                                          int64_t start_row,
                                          const float* labels,
                                          const float* weights,
                                          const double* init_scores,
                                          const int32_t* queries,
                                          int32_t tid) {
  API_BEGIN();
#ifdef LABEL_T_USE_DOUBLE
  Log::Fatal("Don't support LABEL_T_USE_DOUBLE");
#endif
  if (!data) {
    Log::Fatal("data cannot be null.");
  }
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }
1198
1199
1200

  const int max_omp_threads = p_dataset->omp_max_threads() > 0 ? p_dataset->omp_max_threads() : OMP_NUM_THREADS();

1201
1202
1203
1204
1205
  OMP_INIT_EX();
#pragma omp parallel for schedule(static)
  for (int i = 0; i < nrow; ++i) {
    OMP_LOOP_EX_BEGIN();
    // convert internal thread id to be unique based on external thread id
1206
    const int internal_tid = omp_get_thread_num() + (max_omp_threads * tid);
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(internal_tid, static_cast<data_size_t>(start_row + i), one_row);
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();

  p_dataset->InsertMetadataAt(static_cast<int32_t>(start_row), nrow, labels, weights, init_scores, queries);

  if (!p_dataset->wait_for_manual_finish() && (start_row + nrow == static_cast<int64_t>(p_dataset->num_data()))) {
    p_dataset->FinishLoad();
  }
  API_END();
}

int LGBM_DatasetSetWaitForManualFinish(DatasetHandle dataset, int wait) {
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  p_dataset->set_wait_for_manual_finish(wait);
  API_END();
}

int LGBM_DatasetMarkFinished(DatasetHandle dataset) {
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  p_dataset->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1232
1233
1234
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1235
int LGBM_DatasetCreateFromMat(const void* data,
1236
1237
1238
1239
1240
1241
1242
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
  return LGBM_DatasetCreateFromMats(1,
                                    &data,
                                    data_type,
                                    &nrow,
                                    ncol,
                                    is_row_major,
                                    parameters,
                                    reference,
                                    out);
}

int LGBM_DatasetCreateFromMats(int32_t nmat,
                               const void** data,
                               int data_type,
                               int32_t* nrow,
                               int32_t ncol,
                               int is_row_major,
                               const char* parameters,
                               const DatasetHandle reference,
                               DatasetHandle* out) {
1263
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1264
1265
  auto param = Config::Str2Map(parameters);
  Config config;
1266
  config.Set(param);
1267
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
1268
  std::unique_ptr<Dataset> ret;
1269
1270
1271
1272
1273
1274
1275
1276
1277
  int32_t total_nrow = 0;
  for (int j = 0; j < nmat; ++j) {
    total_nrow += nrow[j];
  }

  std::vector<std::function<std::vector<double>(int row_idx)>> get_row_fun;
  for (int j = 0; j < nmat; ++j) {
    get_row_fun.push_back(RowFunctionFromDenseMatric(data[j], nrow[j], ncol, data_type, is_row_major));
  }
1278

Guolin Ke's avatar
Guolin Ke committed
1279
1280
  if (reference == nullptr) {
    // sample data first
1281
1282
    auto sample_indices = CreateSampleIndices(total_nrow, config);
    int sample_cnt = static_cast<int>(sample_indices.size());
1283
    std::vector<std::vector<double>> sample_values(ncol);
Guolin Ke's avatar
Guolin Ke committed
1284
    std::vector<std::vector<int>> sample_idx(ncol);
1285
1286
1287

    int offset = 0;
    int j = 0;
Guolin Ke's avatar
Guolin Ke committed
1288
    for (size_t i = 0; i < sample_indices.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
1289
      auto idx = sample_indices[i];
1290
1291
1292
1293
      while ((idx - offset) >= nrow[j]) {
        offset += nrow[j];
        ++j;
      }
1294

1295
1296
1297
1298
1299
      auto row = get_row_fun[j](static_cast<int>(idx - offset));
      for (size_t k = 0; k < row.size(); ++k) {
        if (std::fabs(row[k]) > kZeroThreshold || std::isnan(row[k])) {
          sample_values[k].emplace_back(row[k]);
          sample_idx[k].emplace_back(static_cast<int>(i));
Guolin Ke's avatar
Guolin Ke committed
1300
        }
Guolin Ke's avatar
Guolin Ke committed
1301
1302
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1303
    DatasetLoader loader(config, nullptr, 1, nullptr);
1304
1305
1306
1307
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             ncol,
                                             VectorSize<double>(sample_values).data(),
1308
1309
1310
                                             sample_cnt,
                                             total_nrow,
                                             total_nrow));
Guolin Ke's avatar
Guolin Ke committed
1311
  } else {
1312
    ret.reset(new Dataset(total_nrow));
Guolin Ke's avatar
Guolin Ke committed
1313
    ret->CreateValid(
1314
      reinterpret_cast<const Dataset*>(reference));
1315
1316
1317
    if (ret->has_raw()) {
      ret->ResizeRaw(total_nrow);
    }
Guolin Ke's avatar
Guolin Ke committed
1318
  }
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
  int32_t start_row = 0;
  for (int j = 0; j < nmat; ++j) {
    OMP_INIT_EX();
    #pragma omp parallel for schedule(static)
    for (int i = 0; i < nrow[j]; ++i) {
      OMP_LOOP_EX_BEGIN();
      const int tid = omp_get_thread_num();
      auto one_row = get_row_fun[j](i);
      ret->PushOneRow(tid, start_row + i, one_row);
      OMP_LOOP_EX_END();
    }
    OMP_THROW_EX();

    start_row += nrow[j];
Guolin Ke's avatar
Guolin Ke committed
1333
1334
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1335
  *out = ret.release();
1336
  API_END();
1337
1338
}

Guolin Ke's avatar
Guolin Ke committed
1339
int LGBM_DatasetCreateFromCSR(const void* indptr,
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
                              int indptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t nindptr,
                              int64_t nelem,
                              int64_t num_col,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
1350
  API_BEGIN();
1351
1352
1353
1354
1355
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }
Guolin Ke's avatar
Guolin Ke committed
1356
1357
  auto param = Config::Str2Map(parameters);
  Config config;
1358
  config.Set(param);
1359
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
1360
  std::unique_ptr<Dataset> ret;
1361
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
1362
1363
1364
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (reference == nullptr) {
    // sample data first
1365
1366
    auto sample_indices = CreateSampleIndices(nrow, config);
    int sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
1367
1368
    std::vector<std::vector<double>> sample_values(num_col);
    std::vector<std::vector<int>> sample_idx(num_col);
1369
1370
1371
1372
    for (size_t i = 0; i < sample_indices.size(); ++i) {
      auto idx = sample_indices[i];
      auto row = get_row_fun(static_cast<int>(idx));
      for (std::pair<int, double>& inner_data : row) {
Nikita Titov's avatar
Nikita Titov committed
1373
        CHECK_LT(inner_data.first, num_col);
Guolin Ke's avatar
Guolin Ke committed
1374
        if (std::fabs(inner_data.second) > kZeroThreshold || std::isnan(inner_data.second)) {
Guolin Ke's avatar
Guolin Ke committed
1375
1376
          sample_values[inner_data.first].emplace_back(inner_data.second);
          sample_idx[inner_data.first].emplace_back(static_cast<int>(i));
1377
1378
1379
        }
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1380
    DatasetLoader loader(config, nullptr, 1, nullptr);
1381
1382
1383
1384
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             static_cast<int>(num_col),
                                             VectorSize<double>(sample_values).data(),
1385
1386
1387
                                             sample_cnt,
                                             nrow,
                                             nrow));
1388
  } else {
1389
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
1390
    ret->CreateValid(
1391
      reinterpret_cast<const Dataset*>(reference));
1392
1393
1394
    if (ret->has_raw()) {
      ret->ResizeRaw(nrow);
    }
1395
  }
1396
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1397
  #pragma omp parallel for schedule(static)
1398
  for (int i = 0; i < nindptr - 1; ++i) {
1399
    OMP_LOOP_EX_BEGIN();
1400
1401
1402
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    ret->PushOneRow(tid, i, one_row);
1403
    OMP_LOOP_EX_END();
1404
  }
1405
  OMP_THROW_EX();
1406
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1407
  *out = ret.release();
1408
  API_END();
1409
1410
}

1411
int LGBM_DatasetCreateFromCSRFunc(void* get_row_funptr,
1412
1413
1414
1415
1416
                                  int num_rows,
                                  int64_t num_col,
                                  const char* parameters,
                                  const DatasetHandle reference,
                                  DatasetHandle* out) {
1417
  API_BEGIN();
1418
1419
1420
1421
1422
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }
1423
1424
1425
1426
  auto get_row_fun = *static_cast<std::function<void(int idx, std::vector<std::pair<int, double>>&)>*>(get_row_funptr);
  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);
1427
  OMP_SET_NUM_THREADS(config.num_threads);
1428
1429
1430
1431
  std::unique_ptr<Dataset> ret;
  int32_t nrow = num_rows;
  if (reference == nullptr) {
    // sample data first
1432
1433
    auto sample_indices = CreateSampleIndices(nrow, config);
    int sample_cnt = static_cast<int>(sample_indices.size());
1434
1435
1436
1437
1438
1439
1440
1441
    std::vector<std::vector<double>> sample_values(num_col);
    std::vector<std::vector<int>> sample_idx(num_col);
    // local buffer to re-use memory
    std::vector<std::pair<int, double>> buffer;
    for (size_t i = 0; i < sample_indices.size(); ++i) {
      auto idx = sample_indices[i];
      get_row_fun(static_cast<int>(idx), buffer);
      for (std::pair<int, double>& inner_data : buffer) {
Nikita Titov's avatar
Nikita Titov committed
1442
        CHECK_LT(inner_data.first, num_col);
1443
1444
1445
1446
1447
1448
1449
        if (std::fabs(inner_data.second) > kZeroThreshold || std::isnan(inner_data.second)) {
          sample_values[inner_data.first].emplace_back(inner_data.second);
          sample_idx[inner_data.first].emplace_back(static_cast<int>(i));
        }
      }
    }
    DatasetLoader loader(config, nullptr, 1, nullptr);
1450
1451
1452
1453
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             static_cast<int>(num_col),
                                             VectorSize<double>(sample_values).data(),
1454
1455
1456
                                             sample_cnt,
                                             nrow,
                                             nrow));
1457
1458
1459
1460
  } else {
    ret.reset(new Dataset(nrow));
    ret->CreateValid(
      reinterpret_cast<const Dataset*>(reference));
1461
1462
1463
    if (ret->has_raw()) {
      ret->ResizeRaw(nrow);
    }
1464
  }
1465

1466
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1467
1468
  std::vector<std::pair<int, double>> thread_buffer;
  #pragma omp parallel for schedule(static) private(thread_buffer)
1469
1470
1471
  for (int i = 0; i < num_rows; ++i) {
    OMP_LOOP_EX_BEGIN();
    {
1472
      const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1473
1474
      get_row_fun(i, thread_buffer);
      ret->PushOneRow(tid, i, thread_buffer);
1475
1476
1477
1478
1479
1480
1481
1482
1483
    }
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();
  ret->FinishLoad();
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1484
int LGBM_DatasetCreateFromCSC(const void* col_ptr,
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
                              int col_ptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t ncol_ptr,
                              int64_t nelem,
                              int64_t num_row,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
1495
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1496
1497
  auto param = Config::Str2Map(parameters);
  Config config;
1498
  config.Set(param);
1499
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
1500
  std::unique_ptr<Dataset> ret;
Guolin Ke's avatar
Guolin Ke committed
1501
1502
1503
  int32_t nrow = static_cast<int32_t>(num_row);
  if (reference == nullptr) {
    // sample data first
1504
1505
    auto sample_indices = CreateSampleIndices(nrow, config);
    int sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
1506
    std::vector<std::vector<double>> sample_values(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
1507
    std::vector<std::vector<int>> sample_idx(ncol_ptr - 1);
1508
    OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1509
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1510
    for (int i = 0; i < static_cast<int>(sample_values.size()); ++i) {
1511
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1512
1513
1514
      CSC_RowIterator col_it(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, i);
      for (int j = 0; j < sample_cnt; j++) {
        auto val = col_it.Get(sample_indices[j]);
Guolin Ke's avatar
Guolin Ke committed
1515
        if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
Guolin Ke's avatar
Guolin Ke committed
1516
1517
          sample_values[i].emplace_back(val);
          sample_idx[i].emplace_back(j);
Guolin Ke's avatar
Guolin Ke committed
1518
1519
        }
      }
1520
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1521
    }
1522
    OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
1523
    DatasetLoader loader(config, nullptr, 1, nullptr);
1524
1525
1526
1527
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             static_cast<int>(sample_values.size()),
                                             VectorSize<double>(sample_values).data(),
1528
1529
1530
                                             sample_cnt,
                                             nrow,
                                             nrow));
Guolin Ke's avatar
Guolin Ke committed
1531
  } else {
1532
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
1533
    ret->CreateValid(
1534
      reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
1535
  }
1536
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1537
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1538
  for (int i = 0; i < ncol_ptr - 1; ++i) {
1539
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1540
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1541
    int feature_idx = ret->InnerFeatureIndex(i);
Guolin Ke's avatar
Guolin Ke committed
1542
    if (feature_idx < 0) { continue; }
Guolin Ke's avatar
Guolin Ke committed
1543
1544
    int group = ret->Feature2Group(feature_idx);
    int sub_feature = ret->Feture2SubFeature(feature_idx);
Guolin Ke's avatar
Guolin Ke committed
1545
    CSC_RowIterator col_it(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, i);
Guolin Ke's avatar
Guolin Ke committed
1546
1547
1548
1549
1550
1551
1552
1553
    auto bin_mapper = ret->FeatureBinMapper(feature_idx);
    if (bin_mapper->GetDefaultBin() == bin_mapper->GetMostFreqBin()) {
      int row_idx = 0;
      while (row_idx < nrow) {
        auto pair = col_it.NextNonZero();
        row_idx = pair.first;
        // no more data
        if (row_idx < 0) { break; }
1554
        ret->PushOneData(tid, row_idx, group, feature_idx, sub_feature, pair.second);
Guolin Ke's avatar
Guolin Ke committed
1555
1556
1557
1558
      }
    } else {
      for (int row_idx = 0; row_idx < nrow; ++row_idx) {
        auto val = col_it.Get(row_idx);
1559
        ret->PushOneData(tid, row_idx, group, feature_idx, sub_feature, val);
Guolin Ke's avatar
Guolin Ke committed
1560
      }
Guolin Ke's avatar
Guolin Ke committed
1561
    }
1562
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1563
  }
1564
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
1565
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1566
  *out = ret.release();
1567
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1568
1569
}

Guolin Ke's avatar
Guolin Ke committed
1570
int LGBM_DatasetGetSubset(
1571
  const DatasetHandle handle,
wxchan's avatar
wxchan committed
1572
1573
1574
  const int32_t* used_row_indices,
  int32_t num_used_row_indices,
  const char* parameters,
Guolin Ke's avatar
typo  
Guolin Ke committed
1575
  DatasetHandle* out) {
wxchan's avatar
wxchan committed
1576
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1577
1578
  auto param = Config::Str2Map(parameters);
  Config config;
1579
  config.Set(param);
1580
  OMP_SET_NUM_THREADS(config.num_threads);
1581
  auto full_dataset = reinterpret_cast<const Dataset*>(handle);
1582
  CHECK_GT(num_used_row_indices, 0);
1583
1584
  const int32_t lower = 0;
  const int32_t upper = full_dataset->num_data() - 1;
1585
  CheckElementsIntervalClosed(used_row_indices, lower, upper, num_used_row_indices, "Used indices of subset");
1586
1587
1588
  if (!std::is_sorted(used_row_indices, used_row_indices + num_used_row_indices)) {
    Log::Fatal("used_row_indices should be sorted in Subset");
  }
Guolin Ke's avatar
Guolin Ke committed
1589
  auto ret = std::unique_ptr<Dataset>(new Dataset(num_used_row_indices));
1590
  ret->CopyFeatureMapperFrom(full_dataset);
1591
  ret->CopySubrow(full_dataset, used_row_indices, num_used_row_indices, true);
wxchan's avatar
wxchan committed
1592
1593
1594
1595
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1596
int LGBM_DatasetSetFeatureNames(
Guolin Ke's avatar
typo  
Guolin Ke committed
1597
  DatasetHandle handle,
Guolin Ke's avatar
Guolin Ke committed
1598
  const char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
1599
  int num_feature_names) {
Guolin Ke's avatar
Guolin Ke committed
1600
1601
1602
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  std::vector<std::string> feature_names_str;
Guolin Ke's avatar
Guolin Ke committed
1603
  for (int i = 0; i < num_feature_names; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1604
1605
1606
1607
1608
1609
    feature_names_str.emplace_back(feature_names[i]);
  }
  dataset->set_feature_names(feature_names_str);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1610
int LGBM_DatasetGetFeatureNames(
1611
1612
1613
1614
1615
1616
    DatasetHandle handle,
    const int len,
    int* num_feature_names,
    const size_t buffer_len,
    size_t* out_buffer_len,
    char** feature_names) {
1617
  API_BEGIN();
1618
  *out_buffer_len = 0;
1619
1620
  auto dataset = reinterpret_cast<Dataset*>(handle);
  auto inside_feature_name = dataset->feature_names();
Guolin Ke's avatar
Guolin Ke committed
1621
1622
  *num_feature_names = static_cast<int>(inside_feature_name.size());
  for (int i = 0; i < *num_feature_names; ++i) {
1623
1624
1625
1626
1627
    if (i < len) {
      std::memcpy(feature_names[i], inside_feature_name[i].c_str(), std::min(inside_feature_name[i].size() + 1, buffer_len));
      feature_names[i][buffer_len - 1] = '\0';
    }
    *out_buffer_len = std::max(inside_feature_name[i].size() + 1, *out_buffer_len);
1628
1629
1630
1631
  }
  API_END();
}

1632
1633
1634
#ifdef _MSC_VER
  #pragma warning(disable : 4702)
#endif
Guolin Ke's avatar
Guolin Ke committed
1635
int LGBM_DatasetFree(DatasetHandle handle) {
1636
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1637
  delete reinterpret_cast<Dataset*>(handle);
1638
  API_END();
1639
1640
}

Guolin Ke's avatar
Guolin Ke committed
1641
int LGBM_DatasetSaveBinary(DatasetHandle handle,
1642
                           const char* filename) {
1643
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1644
1645
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->SaveBinaryFile(filename);
1646
  API_END();
1647
1648
}

1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
int LGBM_DatasetSerializeReferenceToBinary(DatasetHandle handle,
                                           ByteBufferHandle* out,
                                           int32_t* out_len) {
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  std::unique_ptr<LightGBM::ByteBuffer> ret;
  ret.reset(new LightGBM::ByteBuffer());
  dataset->SerializeReference(ret.get());
  *out_len = static_cast<int32_t>(ret->GetSize());
  *out = ret.release();
  API_END();
}

1662
1663
1664
1665
1666
1667
1668
1669
int LGBM_DatasetDumpText(DatasetHandle handle,
                         const char* filename) {
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->DumpTextFile(filename);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1670
int LGBM_DatasetSetField(DatasetHandle handle,
1671
1672
1673
1674
                         const char* field_name,
                         const void* field_data,
                         int num_element,
                         int type) {
1675
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1676
  auto dataset = reinterpret_cast<Dataset*>(handle);
1677
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
1678
  if (type == C_API_DTYPE_FLOAT32) {
Guolin Ke's avatar
Guolin Ke committed
1679
    is_success = dataset->SetFloatField(field_name, reinterpret_cast<const float*>(field_data), static_cast<int32_t>(num_element));
Guolin Ke's avatar
Guolin Ke committed
1680
  } else if (type == C_API_DTYPE_INT32) {
Guolin Ke's avatar
Guolin Ke committed
1681
    is_success = dataset->SetIntField(field_name, reinterpret_cast<const int*>(field_data), static_cast<int32_t>(num_element));
Guolin Ke's avatar
Guolin Ke committed
1682
1683
  } else if (type == C_API_DTYPE_FLOAT64) {
    is_success = dataset->SetDoubleField(field_name, reinterpret_cast<const double*>(field_data), static_cast<int32_t>(num_element));
1684
  }
1685
  if (!is_success) { Log::Fatal("Input data type error or field not found"); }
1686
  API_END();
1687
1688
}

Guolin Ke's avatar
Guolin Ke committed
1689
int LGBM_DatasetGetField(DatasetHandle handle,
1690
1691
1692
1693
                         const char* field_name,
                         int* out_len,
                         const void** out_ptr,
                         int* out_type) {
1694
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1695
  auto dataset = reinterpret_cast<Dataset*>(handle);
1696
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
1697
  if (dataset->GetFloatField(field_name, out_len, reinterpret_cast<const float**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
1698
    *out_type = C_API_DTYPE_FLOAT32;
1699
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
1700
  } else if (dataset->GetIntField(field_name, out_len, reinterpret_cast<const int**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
1701
    *out_type = C_API_DTYPE_INT32;
1702
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
1703
1704
1705
  } else if (dataset->GetDoubleField(field_name, out_len, reinterpret_cast<const double**>(out_ptr))) {
    *out_type = C_API_DTYPE_FLOAT64;
    is_success = true;
Nikita Titov's avatar
Nikita Titov committed
1706
  }
1707
  if (!is_success) { Log::Fatal("Field not found"); }
wxchan's avatar
wxchan committed
1708
  if (*out_ptr == nullptr) { *out_len = 0; }
1709
  API_END();
1710
1711
}

1712
int LGBM_DatasetUpdateParamChecking(const char* old_parameters, const char* new_parameters) {
1713
  API_BEGIN();
1714
1715
1716
1717
1718
  auto old_param = Config::Str2Map(old_parameters);
  Config old_config;
  old_config.Set(old_param);
  auto new_param = Config::Str2Map(new_parameters);
  Booster::CheckDatasetResetConfig(old_config, new_param);
1719
1720
1721
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1722
int LGBM_DatasetGetNumData(DatasetHandle handle,
1723
                           int* out) {
1724
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1725
1726
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_data();
1727
  API_END();
1728
1729
}

Guolin Ke's avatar
Guolin Ke committed
1730
int LGBM_DatasetGetNumFeature(DatasetHandle handle,
1731
                              int* out) {
1732
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1733
1734
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_total_features();
1735
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1736
}
1737

1738
1739
1740
1741
1742
int LGBM_DatasetGetFeatureNumBin(DatasetHandle handle,
                                 int feature,
                                 int* out) {
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
1743
1744
1745
1746
1747
  int num_features = dataset->num_total_features();
  if (feature < 0 || feature >= num_features) {
    Log::Fatal("Tried to retrieve number of bins for feature index %d, "
               "but the valid feature indices are [0, %d].", feature, num_features - 1);
  }
1748
1749
1750
1751
1752
1753
1754
1755
1756
  int inner_idx = dataset->InnerFeatureIndex(feature);
  if (inner_idx >= 0) {
    *out = dataset->FeatureNumBin(inner_idx);
  } else {
    *out = 0;
  }
  API_END();
}

1757
1758
1759
1760
1761
int LGBM_DatasetAddFeaturesFrom(DatasetHandle target,
                                DatasetHandle source) {
  API_BEGIN();
  auto target_d = reinterpret_cast<Dataset*>(target);
  auto source_d = reinterpret_cast<Dataset*>(source);
1762
  target_d->AddFeaturesFrom(source_d);
1763
1764
1765
  API_END();
}

1766
1767
// ---- start of booster

Guolin Ke's avatar
Guolin Ke committed
1768
int LGBM_BoosterCreate(const DatasetHandle train_data,
1769
1770
                       const char* parameters,
                       BoosterHandle* out) {
1771
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1772
  const Dataset* p_train_data = reinterpret_cast<const Dataset*>(train_data);
wxchan's avatar
wxchan committed
1773
1774
  auto ret = std::unique_ptr<Booster>(new Booster(p_train_data, parameters));
  *out = ret.release();
1775
  API_END();
1776
1777
}

Guolin Ke's avatar
Guolin Ke committed
1778
int LGBM_BoosterCreateFromModelfile(
1779
  const char* filename,
Guolin Ke's avatar
Guolin Ke committed
1780
  int* out_num_iterations,
1781
  BoosterHandle* out) {
1782
  API_BEGIN();
wxchan's avatar
wxchan committed
1783
  auto ret = std::unique_ptr<Booster>(new Booster(filename));
Guolin Ke's avatar
Guolin Ke committed
1784
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
wxchan's avatar
wxchan committed
1785
  *out = ret.release();
1786
  API_END();
1787
1788
}

Guolin Ke's avatar
Guolin Ke committed
1789
int LGBM_BoosterLoadModelFromString(
1790
1791
1792
1793
  const char* model_str,
  int* out_num_iterations,
  BoosterHandle* out) {
  API_BEGIN();
wxchan's avatar
wxchan committed
1794
  auto ret = std::unique_ptr<Booster>(new Booster(nullptr));
1795
1796
1797
1798
1799
1800
  ret->LoadModelFromString(model_str);
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
  *out = ret.release();
  API_END();
}

1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
int LGBM_BoosterGetLoadedParam(
  BoosterHandle handle,
  int64_t buffer_len,
  int64_t* out_len,
  char* out_str) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  std::string params = ref_booster->GetBoosting()->GetLoadedParam();
  *out_len = static_cast<int64_t>(params.size()) + 1;
  if (*out_len <= buffer_len) {
    std::memcpy(out_str, params.c_str(), *out_len);
  }
  API_END();
}

1816
1817
1818
#ifdef _MSC_VER
  #pragma warning(disable : 4702)
#endif
Guolin Ke's avatar
Guolin Ke committed
1819
int LGBM_BoosterFree(BoosterHandle handle) {
1820
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1821
  delete reinterpret_cast<Booster*>(handle);
1822
  API_END();
1823
1824
}

1825
int LGBM_BoosterShuffleModels(BoosterHandle handle, int start_iter, int end_iter) {
1826
1827
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1828
  ref_booster->ShuffleModels(start_iter, end_iter);
1829
1830
1831
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1832
int LGBM_BoosterMerge(BoosterHandle handle,
1833
                      BoosterHandle other_handle) {
wxchan's avatar
wxchan committed
1834
1835
1836
1837
1838
1839
1840
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  Booster* ref_other_booster = reinterpret_cast<Booster*>(other_handle);
  ref_booster->MergeFrom(ref_other_booster);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1841
int LGBM_BoosterAddValidData(BoosterHandle handle,
1842
                             const DatasetHandle valid_data) {
wxchan's avatar
wxchan committed
1843
1844
1845
1846
1847
1848
1849
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  const Dataset* p_dataset = reinterpret_cast<const Dataset*>(valid_data);
  ref_booster->AddValidData(p_dataset);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1850
int LGBM_BoosterResetTrainingData(BoosterHandle handle,
1851
                                  const DatasetHandle train_data) {
wxchan's avatar
wxchan committed
1852
1853
1854
1855
1856
1857
1858
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  const Dataset* p_dataset = reinterpret_cast<const Dataset*>(train_data);
  ref_booster->ResetTrainingData(p_dataset);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1859
int LGBM_BoosterResetParameter(BoosterHandle handle, const char* parameters) {
wxchan's avatar
wxchan committed
1860
1861
1862
1863
1864
1865
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->ResetConfig(parameters);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1866
int LGBM_BoosterGetNumClasses(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1867
1868
1869
1870
1871
1872
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->NumberOfClasses();
  API_END();
}

1873
int LGBM_BoosterGetLinear(BoosterHandle handle, int* out) {
1874
1875
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1876
1877
1878
1879
1880
  if (ref_booster->GetBoosting()->IsLinear()) {
    *out = 1;
  } else {
    *out = 0;
  }
1881
1882
1883
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1884
1885
1886
1887
1888
1889
1890
int LGBM_BoosterRefit(BoosterHandle handle, const int32_t* leaf_preds, int32_t nrow, int32_t ncol) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->Refit(leaf_preds, nrow, ncol);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1891
int LGBM_BoosterUpdateOneIter(BoosterHandle handle, int* is_finished) {
1892
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1893
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1894
1895
1896
1897
1898
  if (ref_booster->TrainOneIter()) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
1899
  API_END();
1900
1901
}

Guolin Ke's avatar
Guolin Ke committed
1902
int LGBM_BoosterUpdateOneIterCustom(BoosterHandle handle,
1903
1904
1905
                                    const float* grad,
                                    const float* hess,
                                    int* is_finished) {
1906
  API_BEGIN();
1907
  #ifdef SCORE_T_USE_DOUBLE
1908
1909
1910
1911
  (void) handle;       // UNUSED VARIABLE
  (void) grad;         // UNUSED VARIABLE
  (void) hess;         // UNUSED VARIABLE
  (void) is_finished;  // UNUSED VARIABLE
1912
  Log::Fatal("Don't support custom loss function when SCORE_T_USE_DOUBLE is enabled");
1913
  #else
1914
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1915
1916
1917
1918
1919
  if (ref_booster->TrainOneIter(grad, hess)) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
1920
  #endif
1921
  API_END();
1922
1923
}

Guolin Ke's avatar
Guolin Ke committed
1924
int LGBM_BoosterRollbackOneIter(BoosterHandle handle) {
wxchan's avatar
wxchan committed
1925
1926
1927
1928
1929
1930
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->RollbackOneIter();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1931
int LGBM_BoosterGetCurrentIteration(BoosterHandle handle, int* out_iteration) {
wxchan's avatar
wxchan committed
1932
1933
1934
1935
1936
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_iteration = ref_booster->GetBoosting()->GetCurrentIteration();
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
1937

1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
int LGBM_BoosterNumModelPerIteration(BoosterHandle handle, int* out_tree_per_iteration) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_tree_per_iteration = ref_booster->GetBoosting()->NumModelPerIteration();
  API_END();
}

int LGBM_BoosterNumberOfTotalModel(BoosterHandle handle, int* out_models) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_models = ref_booster->GetBoosting()->NumberOfTotalModel();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1952
int LGBM_BoosterGetEvalCounts(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1953
1954
1955
1956
1957
1958
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalCounts();
  API_END();
}

1959
1960
1961
1962
1963
1964
int LGBM_BoosterGetEvalNames(BoosterHandle handle,
                             const int len,
                             int* out_len,
                             const size_t buffer_len,
                             size_t* out_buffer_len,
                             char** out_strs) {
wxchan's avatar
wxchan committed
1965
1966
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1967
  *out_len = ref_booster->GetEvalNames(out_strs, len, buffer_len, out_buffer_len);
wxchan's avatar
wxchan committed
1968
1969
1970
  API_END();
}

1971
1972
1973
1974
1975
1976
int LGBM_BoosterGetFeatureNames(BoosterHandle handle,
                                const int len,
                                int* out_len,
                                const size_t buffer_len,
                                size_t* out_buffer_len,
                                char** out_strs) {
wxchan's avatar
wxchan committed
1977
1978
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1979
  *out_len = ref_booster->GetFeatureNames(out_strs, len, buffer_len, out_buffer_len);
wxchan's avatar
wxchan committed
1980
1981
1982
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1983
int LGBM_BoosterGetNumFeature(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1984
1985
1986
1987
1988
1989
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->MaxFeatureIdx() + 1;
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1990
int LGBM_BoosterGetEval(BoosterHandle handle,
1991
1992
1993
                        int data_idx,
                        int* out_len,
                        double* out_results) {
1994
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1995
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1996
  auto boosting = ref_booster->GetBoosting();
wxchan's avatar
wxchan committed
1997
  auto result_buf = boosting->GetEvalAt(data_idx);
Guolin Ke's avatar
Guolin Ke committed
1998
  *out_len = static_cast<int>(result_buf.size());
1999
  for (size_t i = 0; i < result_buf.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
2000
    (out_results)[i] = static_cast<double>(result_buf[i]);
2001
  }
2002
  API_END();
2003
2004
}

Guolin Ke's avatar
Guolin Ke committed
2005
int LGBM_BoosterGetNumPredict(BoosterHandle handle,
2006
2007
                              int data_idx,
                              int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
2008
2009
2010
2011
2012
2013
  API_BEGIN();
  auto boosting = reinterpret_cast<Booster*>(handle)->GetBoosting();
  *out_len = boosting->GetNumPredictAt(data_idx);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2014
int LGBM_BoosterGetPredict(BoosterHandle handle,
2015
2016
2017
                           int data_idx,
                           int64_t* out_len,
                           double* out_result) {
2018
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2019
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2020
  ref_booster->GetPredictAt(data_idx, out_result, out_len);
2021
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2022
2023
}

Guolin Ke's avatar
Guolin Ke committed
2024
int LGBM_BoosterPredictForFile(BoosterHandle handle,
2025
2026
2027
                               const char* data_filename,
                               int data_has_header,
                               int predict_type,
2028
                               int start_iteration,
2029
                               int num_iteration,
2030
                               const char* parameter,
2031
                               const char* result_filename) {
2032
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2033
2034
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2035
  config.Set(param);
2036
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
2037
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2038
  ref_booster->Predict(start_iteration, num_iteration, predict_type, data_filename, data_has_header,
Guolin Ke's avatar
Guolin Ke committed
2039
                       config, result_filename);
2040
  API_END();
2041
2042
}

Guolin Ke's avatar
Guolin Ke committed
2043
int LGBM_BoosterCalcNumPredict(BoosterHandle handle,
2044
2045
                               int num_row,
                               int predict_type,
2046
                               int start_iteration,
2047
2048
                               int num_iteration,
                               int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
2049
2050
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2051
  *out_len = static_cast<int64_t>(num_row) * ref_booster->GetBoosting()->NumPredictOneRow(start_iteration,
2052
    num_iteration, predict_type == C_API_PREDICT_LEAF_INDEX, predict_type == C_API_PREDICT_CONTRIB);
Guolin Ke's avatar
Guolin Ke committed
2053
2054
2055
  API_END();
}

2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
/*!
 * \brief Object to store resources meant for single-row Fast Predict methods.
 *
 * Meant to be used as a basic struct by the *Fast* predict methods only.
 * It stores the configuration resources for reuse during prediction.
 *
 * Even the row function is stored. We score the instance at the same memory
 * address all the time. One just replaces the feature values at that address
 * and scores again with the *Fast* methods.
 */
struct FastConfig {
  FastConfig(Booster *const booster_ptr,
             const char *parameter,
2069
             const int predict_type_,
2070
             const int data_type_,
2071
             const int32_t num_cols) : booster(booster_ptr), predict_type(predict_type_), data_type(data_type_), ncol(num_cols) {
2072
2073
2074
2075
2076
    config.Set(Config::Str2Map(parameter));
  }

  Booster* const booster;
  Config config;
2077
  const int predict_type;
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
  const int data_type;
  const int32_t ncol;
};

int LGBM_FastConfigFree(FastConfigHandle fastConfig) {
  API_BEGIN();
  delete reinterpret_cast<FastConfig*>(fastConfig);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2088
int LGBM_BoosterPredictForCSR(BoosterHandle handle,
2089
2090
2091
2092
2093
2094
2095
                              const void* indptr,
                              int indptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t nindptr,
                              int64_t nelem,
2096
                              int64_t num_col,
2097
                              int predict_type,
2098
                              int start_iteration,
2099
                              int num_iteration,
2100
                              const char* parameter,
2101
2102
                              int64_t* out_len,
                              double* out_result) {
2103
  API_BEGIN();
2104
2105
2106
2107
2108
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }
Guolin Ke's avatar
Guolin Ke committed
2109
2110
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2111
  config.Set(param);
2112
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
2113
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2114
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
2115
  int nrow = static_cast<int>(nindptr - 1);
2116
  ref_booster->Predict(start_iteration, num_iteration, predict_type, nrow, static_cast<int>(num_col), get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
2117
                       config, out_result, out_len);
2118
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2119
}
2120

2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
int LGBM_BoosterPredictSparseOutput(BoosterHandle handle,
                                    const void* indptr,
                                    int indptr_type,
                                    const int32_t* indices,
                                    const void* data,
                                    int data_type,
                                    int64_t nindptr,
                                    int64_t nelem,
                                    int64_t num_col_or_row,
                                    int predict_type,
2131
                                    int start_iteration,
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
                                    int num_iteration,
                                    const char* parameter,
                                    int matrix_type,
                                    int64_t* out_len,
                                    void** out_indptr,
                                    int32_t** out_indices,
                                    void** out_data) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
2144
  OMP_SET_NUM_THREADS(config.num_threads);
2145
2146
2147
2148
2149
2150
2151
2152
  if (matrix_type == C_API_MATRIX_TYPE_CSR) {
    if (num_col_or_row <= 0) {
      Log::Fatal("The number of columns should be greater than zero.");
    } else if (num_col_or_row >= INT32_MAX) {
      Log::Fatal("The number of columns should be smaller than INT32_MAX.");
    }
    auto get_row_fun = RowFunctionFromCSR<int64_t>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
    int64_t nrow = nindptr - 1;
2153
    ref_booster->PredictSparseCSR(start_iteration, num_iteration, predict_type, nrow, static_cast<int>(num_col_or_row), get_row_fun,
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
                                  config, out_len, out_indptr, indptr_type, out_indices, out_data, data_type);
  } else if (matrix_type == C_API_MATRIX_TYPE_CSC) {
    int num_threads = OMP_NUM_THREADS();
    int ncol = static_cast<int>(nindptr - 1);
    std::vector<std::vector<CSC_RowIterator>> iterators(num_threads, std::vector<CSC_RowIterator>());
    for (int i = 0; i < num_threads; ++i) {
      for (int j = 0; j < ncol; ++j) {
        iterators[i].emplace_back(indptr, indptr_type, indices, data, data_type, nindptr, nelem, j);
      }
    }
    std::function<std::vector<std::pair<int, double>>(int64_t row_idx)> get_row_fun =
      [&iterators, ncol](int64_t i) {
      std::vector<std::pair<int, double>> one_row;
      one_row.reserve(ncol);
      const int tid = omp_get_thread_num();
      for (int j = 0; j < ncol; ++j) {
        auto val = iterators[tid][j].Get(static_cast<int>(i));
        if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
          one_row.emplace_back(j, val);
        }
      }
      return one_row;
    };
2177
    ref_booster->PredictSparseCSC(start_iteration, num_iteration, predict_type, num_col_or_row, ncol, get_row_fun, config,
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
                                  out_len, out_indptr, indptr_type, out_indices, out_data, data_type);
  } else {
    Log::Fatal("Unknown matrix type in LGBM_BoosterPredictSparseOutput");
  }
  API_END();
}

int LGBM_BoosterFreePredictSparse(void* indptr, int32_t* indices, void* data, int indptr_type, int data_type) {
  API_BEGIN();
  if (indptr_type == C_API_DTYPE_INT32) {
2188
    delete[] reinterpret_cast<int32_t*>(indptr);
2189
  } else if (indptr_type == C_API_DTYPE_INT64) {
2190
    delete[] reinterpret_cast<int64_t*>(indptr);
2191
2192
2193
  } else {
    Log::Fatal("Unknown indptr type in LGBM_BoosterFreePredictSparse");
  }
2194
  delete[] indices;
2195
  if (data_type == C_API_DTYPE_FLOAT32) {
2196
    delete[] reinterpret_cast<float*>(data);
2197
  } else if (data_type == C_API_DTYPE_FLOAT64) {
2198
    delete[] reinterpret_cast<double*>(data);
2199
2200
2201
2202
2203
2204
  } else {
    Log::Fatal("Unknown data type in LGBM_BoosterFreePredictSparse");
  }
  API_END();
}

2205
int LGBM_BoosterPredictForCSRSingleRow(BoosterHandle handle,
2206
2207
2208
2209
2210
2211
2212
                                       const void* indptr,
                                       int indptr_type,
                                       const int32_t* indices,
                                       const void* data,
                                       int data_type,
                                       int64_t nindptr,
                                       int64_t nelem,
2213
                                       int64_t num_col,
2214
                                       int predict_type,
2215
                                       int start_iteration,
2216
2217
2218
2219
                                       int num_iteration,
                                       const char* parameter,
                                       int64_t* out_len,
                                       double* out_result) {
2220
  API_BEGIN();
2221
2222
2223
2224
2225
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }
2226
2227
2228
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
2229
  OMP_SET_NUM_THREADS(config.num_threads);
2230
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2231
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
2232
  ref_booster->SetSingleRowPredictor(start_iteration, num_iteration, predict_type, config);
2233
  ref_booster->PredictSingleRow(predict_type, static_cast<int32_t>(num_col), get_row_fun, config, out_result, out_len);
2234
2235
2236
  API_END();
}

2237
int LGBM_BoosterPredictForCSRSingleRowFastInit(BoosterHandle handle,
2238
                                               const int predict_type,
2239
                                               const int start_iteration,
2240
                                               const int num_iteration,
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
                                               const int data_type,
                                               const int64_t num_col,
                                               const char* parameter,
                                               FastConfigHandle *out_fastConfig) {
  API_BEGIN();
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }

  auto fastConfig_ptr = std::unique_ptr<FastConfig>(new FastConfig(
    reinterpret_cast<Booster*>(handle),
    parameter,
2255
    predict_type,
2256
2257
2258
    data_type,
    static_cast<int32_t>(num_col)));

2259
  OMP_SET_NUM_THREADS(fastConfig_ptr->config.num_threads);
2260

2261
  fastConfig_ptr->booster->SetSingleRowPredictor(start_iteration, num_iteration, predict_type, fastConfig_ptr->config);
2262

2263
2264
2265
2266
2267
2268
  *out_fastConfig = fastConfig_ptr.release();
  API_END();
}

int LGBM_BoosterPredictForCSRSingleRowFast(FastConfigHandle fastConfig_handle,
                                           const void* indptr,
2269
                                           const int indptr_type,
2270
2271
                                           const int32_t* indices,
                                           const void* data,
2272
2273
                                           const int64_t nindptr,
                                           const int64_t nelem,
2274
2275
2276
2277
2278
                                           int64_t* out_len,
                                           double* out_result) {
  API_BEGIN();
  FastConfig *fastConfig = reinterpret_cast<FastConfig*>(fastConfig_handle);
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, fastConfig->data_type, nindptr, nelem);
2279
  fastConfig->booster->PredictSingleRow(fastConfig->predict_type, fastConfig->ncol,
2280
2281
2282
2283
                                        get_row_fun, fastConfig->config, out_result, out_len);
  API_END();
}

2284

Guolin Ke's avatar
Guolin Ke committed
2285
int LGBM_BoosterPredictForCSC(BoosterHandle handle,
2286
2287
2288
2289
2290
2291
2292
2293
2294
                              const void* col_ptr,
                              int col_ptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t ncol_ptr,
                              int64_t nelem,
                              int64_t num_row,
                              int predict_type,
2295
                              int start_iteration,
2296
                              int num_iteration,
2297
                              const char* parameter,
2298
2299
                              int64_t* out_len,
                              double* out_result) {
Guolin Ke's avatar
Guolin Ke committed
2300
2301
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2302
2303
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2304
  config.Set(param);
2305
  OMP_SET_NUM_THREADS(config.num_threads);
2306
  int num_threads = OMP_NUM_THREADS();
Guolin Ke's avatar
Guolin Ke committed
2307
  int ncol = static_cast<int>(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
2308
2309
2310
2311
2312
  std::vector<std::vector<CSC_RowIterator>> iterators(num_threads, std::vector<CSC_RowIterator>());
  for (int i = 0; i < num_threads; ++i) {
    for (int j = 0; j < ncol; ++j) {
      iterators[i].emplace_back(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, j);
    }
Guolin Ke's avatar
Guolin Ke committed
2313
2314
  }
  std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun =
Guolin Ke's avatar
Guolin Ke committed
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
      [&iterators, ncol](int i) {
        std::vector<std::pair<int, double>> one_row;
        one_row.reserve(ncol);
        const int tid = omp_get_thread_num();
        for (int j = 0; j < ncol; ++j) {
          auto val = iterators[tid][j].Get(i);
          if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
            one_row.emplace_back(j, val);
          }
        }
        return one_row;
      };
2327
  ref_booster->Predict(start_iteration, num_iteration, predict_type, static_cast<int>(num_row), ncol, get_row_fun, config,
cbecker's avatar
cbecker committed
2328
                       out_result, out_len);
Guolin Ke's avatar
Guolin Ke committed
2329
2330
2331
  API_END();
}

2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
int LGBM_BoosterValidateFeatureNames(BoosterHandle handle,
                                     const char** data_names,
                                     int data_num_features) {
  API_BEGIN();
  int booster_num_features;
  size_t out_buffer_len;
  LGBM_BoosterGetFeatureNames(handle, 0, &booster_num_features, 0, &out_buffer_len, nullptr);
  if (booster_num_features != data_num_features) {
    Log::Fatal("Model was trained on %d features, but got %d input features to predict.", booster_num_features, data_num_features);
  }
  std::vector<std::vector<char>> tmp_names(booster_num_features, std::vector<char>(out_buffer_len));
  std::vector<char*> booster_names = Vector2Ptr(&tmp_names);
  LGBM_BoosterGetFeatureNames(handle, data_num_features, &booster_num_features, out_buffer_len, &out_buffer_len, booster_names.data());
  for (int i = 0; i < booster_num_features; ++i) {
    if (strcmp(data_names[i], booster_names[i]) != 0) {
      Log::Fatal("Expected '%s' at position %d but found '%s'", booster_names[i], i, data_names[i]);
    }
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2353
int LGBM_BoosterPredictForMat(BoosterHandle handle,
2354
2355
2356
2357
2358
2359
                              const void* data,
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              int predict_type,
2360
                              int start_iteration,
2361
                              int num_iteration,
2362
                              const char* parameter,
2363
2364
                              int64_t* out_len,
                              double* out_result) {
2365
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2366
2367
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2368
  config.Set(param);
2369
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
2370
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2371
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
2372
  ref_booster->Predict(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
2373
                       config, out_result, out_len);
2374
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2375
}
2376

2377
int LGBM_BoosterPredictForMatSingleRow(BoosterHandle handle,
2378
2379
2380
2381
2382
                                       const void* data,
                                       int data_type,
                                       int32_t ncol,
                                       int is_row_major,
                                       int predict_type,
2383
                                       int start_iteration,
2384
2385
2386
2387
                                       int num_iteration,
                                       const char* parameter,
                                       int64_t* out_len,
                                       double* out_result) {
2388
2389
2390
2391
  API_BEGIN();
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
2392
  OMP_SET_NUM_THREADS(config.num_threads);
2393
2394
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, 1, ncol, data_type, is_row_major);
2395
  ref_booster->SetSingleRowPredictor(start_iteration, num_iteration, predict_type, config);
2396
  ref_booster->PredictSingleRow(predict_type, ncol, get_row_fun, config, out_result, out_len);
2397
2398
2399
  API_END();
}

2400
int LGBM_BoosterPredictForMatSingleRowFastInit(BoosterHandle handle,
2401
                                               const int predict_type,
2402
                                               const int start_iteration,
2403
                                               const int num_iteration,
2404
2405
2406
2407
2408
2409
2410
2411
                                               const int data_type,
                                               const int32_t ncol,
                                               const char* parameter,
                                               FastConfigHandle *out_fastConfig) {
  API_BEGIN();
  auto fastConfig_ptr = std::unique_ptr<FastConfig>(new FastConfig(
    reinterpret_cast<Booster*>(handle),
    parameter,
2412
    predict_type,
2413
2414
2415
    data_type,
    ncol));

2416
  OMP_SET_NUM_THREADS(fastConfig_ptr->config.num_threads);
2417

2418
  fastConfig_ptr->booster->SetSingleRowPredictor(start_iteration, num_iteration, predict_type, fastConfig_ptr->config);
2419

2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
  *out_fastConfig = fastConfig_ptr.release();
  API_END();
}

int LGBM_BoosterPredictForMatSingleRowFast(FastConfigHandle fastConfig_handle,
                                           const void* data,
                                           int64_t* out_len,
                                           double* out_result) {
  API_BEGIN();
  FastConfig *fastConfig = reinterpret_cast<FastConfig*>(fastConfig_handle);
  // Single row in row-major format:
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, 1, fastConfig->ncol, fastConfig->data_type, 1);
2432
  fastConfig->booster->PredictSingleRow(fastConfig->predict_type, fastConfig->ncol,
2433
2434
2435
2436
2437
                                        get_row_fun, fastConfig->config,
                                        out_result, out_len);
  API_END();
}

2438

2439
2440
2441
2442
2443
2444
int LGBM_BoosterPredictForMats(BoosterHandle handle,
                               const void** data,
                               int data_type,
                               int32_t nrow,
                               int32_t ncol,
                               int predict_type,
2445
                               int start_iteration,
2446
2447
2448
2449
2450
2451
2452
2453
                               int num_iteration,
                               const char* parameter,
                               int64_t* out_len,
                               double* out_result) {
  API_BEGIN();
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
2454
  OMP_SET_NUM_THREADS(config.num_threads);
2455
2456
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  auto get_row_fun = RowPairFunctionFromDenseRows(data, ncol, data_type);
2457
  ref_booster->Predict(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, out_result, out_len);
2458
2459
2460
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2461
int LGBM_BoosterSaveModel(BoosterHandle handle,
2462
                          int start_iteration,
2463
                          int num_iteration,
2464
                          int feature_importance_type,
2465
                          const char* filename) {
2466
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2467
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2468
2469
  ref_booster->SaveModelToFile(start_iteration, num_iteration,
                               feature_importance_type, filename);
wxchan's avatar
wxchan committed
2470
2471
2472
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2473
int LGBM_BoosterSaveModelToString(BoosterHandle handle,
2474
                                  int start_iteration,
2475
                                  int num_iteration,
2476
                                  int feature_importance_type,
2477
                                  int64_t buffer_len,
2478
                                  int64_t* out_len,
2479
                                  char* out_str) {
2480
2481
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2482
2483
  std::string model = ref_booster->SaveModelToString(
      start_iteration, num_iteration, feature_importance_type);
2484
  *out_len = static_cast<int64_t>(model.size()) + 1;
2485
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
2486
    std::memcpy(out_str, model.c_str(), *out_len);
2487
2488
2489
2490
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2491
int LGBM_BoosterDumpModel(BoosterHandle handle,
2492
                          int start_iteration,
2493
                          int num_iteration,
2494
                          int feature_importance_type,
2495
2496
                          int64_t buffer_len,
                          int64_t* out_len,
2497
                          char* out_str) {
wxchan's avatar
wxchan committed
2498
2499
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2500
2501
  std::string model = ref_booster->DumpModel(start_iteration, num_iteration,
                                             feature_importance_type);
2502
  *out_len = static_cast<int64_t>(model.size()) + 1;
wxchan's avatar
wxchan committed
2503
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
2504
    std::memcpy(out_str, model.c_str(), *out_len);
wxchan's avatar
wxchan committed
2505
  }
2506
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2507
}
2508

Guolin Ke's avatar
Guolin Ke committed
2509
int LGBM_BoosterGetLeafValue(BoosterHandle handle,
2510
2511
2512
                             int tree_idx,
                             int leaf_idx,
                             double* out_val) {
Guolin Ke's avatar
Guolin Ke committed
2513
2514
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2515
  *out_val = static_cast<double>(ref_booster->GetLeafValue(tree_idx, leaf_idx));
Guolin Ke's avatar
Guolin Ke committed
2516
2517
2518
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2519
int LGBM_BoosterSetLeafValue(BoosterHandle handle,
2520
2521
2522
                             int tree_idx,
                             int leaf_idx,
                             double val) {
Guolin Ke's avatar
Guolin Ke committed
2523
2524
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2525
  ref_booster->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
2526
2527
2528
  API_END();
}

2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
int LGBM_BoosterFeatureImportance(BoosterHandle handle,
                                  int num_iteration,
                                  int importance_type,
                                  double* out_results) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  std::vector<double> feature_importances = ref_booster->FeatureImportance(num_iteration, importance_type);
  for (size_t i = 0; i < feature_importances.size(); ++i) {
    (out_results)[i] = feature_importances[i];
  }
  API_END();
}

2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
int LGBM_BoosterGetUpperBoundValue(BoosterHandle handle,
                                   double* out_results) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  double max_value = ref_booster->UpperBoundValue();
  *out_results = max_value;
  API_END();
}

int LGBM_BoosterGetLowerBoundValue(BoosterHandle handle,
                                   double* out_results) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  double min_value = ref_booster->LowerBoundValue();
  *out_results = min_value;
  API_END();
}

2560
2561
2562
2563
2564
int LGBM_NetworkInit(const char* machines,
                     int local_listen_port,
                     int listen_time_out,
                     int num_machines) {
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2565
  Config config;
2566
  config.machines = RemoveQuotationSymbol(std::string(machines));
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
  config.local_listen_port = local_listen_port;
  config.num_machines = num_machines;
  config.time_out = listen_time_out;
  if (num_machines > 1) {
    Network::Init(config);
  }
  API_END();
}

int LGBM_NetworkFree() {
  API_BEGIN();
  Network::Dispose();
  API_END();
}

2582
2583
2584
int LGBM_NetworkInitWithFunctions(int num_machines, int rank,
                                  void* reduce_scatter_ext_fun,
                                  void* allgather_ext_fun) {
ww's avatar
ww committed
2585
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2586
  if (num_machines > 1) {
2587
    Network::Init(num_machines, rank, (ReduceScatterFunction)reduce_scatter_ext_fun, (AllgatherFunction)allgather_ext_fun);
ww's avatar
ww committed
2588
2589
2590
  }
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
2591

Guolin Ke's avatar
Guolin Ke committed
2592
// ---- start of some help functions
2593

2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618

template<typename T>
std::function<std::vector<double>(int row_idx)>
RowFunctionFromDenseMatric_helper(const void* data, int num_row, int num_col, int is_row_major) {
  const T* data_ptr = reinterpret_cast<const T*>(data);
  if (is_row_major) {
    return [=] (int row_idx) {
      std::vector<double> ret(num_col);
      auto tmp_ptr = data_ptr + static_cast<size_t>(num_col) * row_idx;
      for (int i = 0; i < num_col; ++i) {
        ret[i] = static_cast<double>(*(tmp_ptr + i));
      }
      return ret;
    };
  } else {
    return [=] (int row_idx) {
      std::vector<double> ret(num_col);
      for (int i = 0; i < num_col; ++i) {
        ret[i] = static_cast<double>(*(data_ptr + static_cast<size_t>(num_row) * i + row_idx));
      }
      return ret;
    };
  }
}

2619
2620
std::function<std::vector<double>(int row_idx)>
RowFunctionFromDenseMatric(const void* data, int num_row, int num_col, int data_type, int is_row_major) {
Guolin Ke's avatar
Guolin Ke committed
2621
  if (data_type == C_API_DTYPE_FLOAT32) {
2622
    return RowFunctionFromDenseMatric_helper<float>(data, num_row, num_col, is_row_major);
Guolin Ke's avatar
Guolin Ke committed
2623
  } else if (data_type == C_API_DTYPE_FLOAT64) {
2624
    return RowFunctionFromDenseMatric_helper<double>(data, num_row, num_col, is_row_major);
2625
  }
2626
  Log::Fatal("Unknown data type in RowFunctionFromDenseMatric");
2627
  return nullptr;
2628
2629
2630
2631
}

std::function<std::vector<std::pair<int, double>>(int row_idx)>
RowPairFunctionFromDenseMatric(const void* data, int num_row, int num_col, int data_type, int is_row_major) {
Guolin Ke's avatar
Guolin Ke committed
2632
2633
  auto inner_function = RowFunctionFromDenseMatric(data, num_row, num_col, data_type, is_row_major);
  if (inner_function != nullptr) {
2634
    return [inner_function] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
2635
2636
      auto raw_values = inner_function(row_idx);
      std::vector<std::pair<int, double>> ret;
Guolin Ke's avatar
Guolin Ke committed
2637
      ret.reserve(raw_values.size());
Guolin Ke's avatar
Guolin Ke committed
2638
      for (int i = 0; i < static_cast<int>(raw_values.size()); ++i) {
Guolin Ke's avatar
Guolin Ke committed
2639
        if (std::fabs(raw_values[i]) > kZeroThreshold || std::isnan(raw_values[i])) {
Guolin Ke's avatar
Guolin Ke committed
2640
          ret.emplace_back(i, raw_values[i]);
2641
        }
Guolin Ke's avatar
Guolin Ke committed
2642
2643
2644
      }
      return ret;
    };
2645
  }
Guolin Ke's avatar
Guolin Ke committed
2646
  return nullptr;
2647
2648
}

2649
2650
2651
2652
2653
2654
2655
// data is array of pointers to individual rows
std::function<std::vector<std::pair<int, double>>(int row_idx)>
RowPairFunctionFromDenseRows(const void** data, int num_col, int data_type) {
  return [=](int row_idx) {
    auto inner_function = RowFunctionFromDenseMatric(data[row_idx], 1, num_col, data_type, /* is_row_major */ true);
    auto raw_values = inner_function(0);
    std::vector<std::pair<int, double>> ret;
Guolin Ke's avatar
Guolin Ke committed
2656
    ret.reserve(raw_values.size());
2657
2658
2659
2660
2661
2662
2663
2664
2665
    for (int i = 0; i < static_cast<int>(raw_values.size()); ++i) {
      if (std::fabs(raw_values[i]) > kZeroThreshold || std::isnan(raw_values[i])) {
        ret.emplace_back(i, raw_values[i]);
      }
    }
    return ret;
  };
}

2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
template<typename T, typename T1, typename T2>
std::function<std::vector<std::pair<int, double>>(T idx)>
RowFunctionFromCSR_helper(const void* indptr, const int32_t* indices, const void* data) {
  const T1* data_ptr = reinterpret_cast<const T1*>(data);
  const T2* ptr_indptr = reinterpret_cast<const T2*>(indptr);
  return [=] (T idx) {
    std::vector<std::pair<int, double>> ret;
    int64_t start = ptr_indptr[idx];
    int64_t end = ptr_indptr[idx + 1];
    if (end - start > 0)  {
      ret.reserve(end - start);
    }
    for (int64_t i = start; i < end; ++i) {
      ret.emplace_back(indices[i], data_ptr[i]);
    }
    return ret;
  };
}

2685
2686
template<typename T>
std::function<std::vector<std::pair<int, double>>(T idx)>
2687
RowFunctionFromCSR(const void* indptr, int indptr_type, const int32_t* indices, const void* data, int data_type, int64_t , int64_t ) {
Guolin Ke's avatar
Guolin Ke committed
2688
2689
  if (data_type == C_API_DTYPE_FLOAT32) {
    if (indptr_type == C_API_DTYPE_INT32) {
2690
     return RowFunctionFromCSR_helper<T, float, int32_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2691
    } else if (indptr_type == C_API_DTYPE_INT64) {
2692
     return RowFunctionFromCSR_helper<T, float, int64_t>(indptr, indices, data);
2693
    }
Guolin Ke's avatar
Guolin Ke committed
2694
2695
  } else if (data_type == C_API_DTYPE_FLOAT64) {
    if (indptr_type == C_API_DTYPE_INT32) {
2696
     return RowFunctionFromCSR_helper<T, double, int32_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2697
    } else if (indptr_type == C_API_DTYPE_INT64) {
2698
     return RowFunctionFromCSR_helper<T, double, int64_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2699
2700
    }
  }
2701
  Log::Fatal("Unknown data type in RowFunctionFromCSR");
2702
  return nullptr;
2703
2704
}

2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723


template <typename T1, typename T2>
std::function<std::pair<int, double>(int idx)> IterateFunctionFromCSC_helper(const void* col_ptr, const int32_t* indices, const void* data, int col_idx) {
  const T1* data_ptr = reinterpret_cast<const T1*>(data);
  const T2* ptr_col_ptr = reinterpret_cast<const T2*>(col_ptr);
  int64_t start = ptr_col_ptr[col_idx];
  int64_t end = ptr_col_ptr[col_idx + 1];
  return [=] (int offset) {
    int64_t i = static_cast<int64_t>(start + offset);
    if (i >= end) {
      return std::make_pair(-1, 0.0);
    }
    int idx = static_cast<int>(indices[i]);
    double val = static_cast<double>(data_ptr[i]);
    return std::make_pair(idx, val);
  };
}

Guolin Ke's avatar
Guolin Ke committed
2724
std::function<std::pair<int, double>(int idx)>
2725
IterateFunctionFromCSC(const void* col_ptr, int col_ptr_type, const int32_t* indices, const void* data, int data_type, int64_t ncol_ptr, int64_t , int col_idx) {
Guolin Ke's avatar
Guolin Ke committed
2726
  CHECK(col_idx < ncol_ptr && col_idx >= 0);
Guolin Ke's avatar
Guolin Ke committed
2727
2728
  if (data_type == C_API_DTYPE_FLOAT32) {
    if (col_ptr_type == C_API_DTYPE_INT32) {
2729
      return IterateFunctionFromCSC_helper<float, int32_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2730
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
2731
      return IterateFunctionFromCSC_helper<float, int64_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2732
    }
Guolin Ke's avatar
Guolin Ke committed
2733
2734
  } else if (data_type == C_API_DTYPE_FLOAT64) {
    if (col_ptr_type == C_API_DTYPE_INT32) {
2735
      return IterateFunctionFromCSC_helper<double, int32_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2736
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
2737
      return IterateFunctionFromCSC_helper<double, int64_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2738
2739
    }
  }
2740
  Log::Fatal("Unknown data type in CSC matrix");
2741
  return nullptr;
2742
2743
}

Guolin Ke's avatar
Guolin Ke committed
2744
CSC_RowIterator::CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
2745
                                 const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx) {
Guolin Ke's avatar
Guolin Ke committed
2746
2747
2748
2749
2750
2751
2752
2753
2754
  iter_fun_ = IterateFunctionFromCSC(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, col_idx);
}

double CSC_RowIterator::Get(int idx) {
  while (idx > cur_idx_ && !is_end_) {
    auto ret = iter_fun_(nonzero_idx_);
    if (ret.first < 0) {
      is_end_ = true;
      break;
2755
    }
Guolin Ke's avatar
Guolin Ke committed
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
    cur_idx_ = ret.first;
    cur_val_ = ret.second;
    ++nonzero_idx_;
  }
  if (idx == cur_idx_) {
    return cur_val_;
  } else {
    return 0.0f;
  }
}

std::pair<int, double> CSC_RowIterator::NextNonZero() {
  if (!is_end_) {
    auto ret = iter_fun_(nonzero_idx_);
    ++nonzero_idx_;
    if (ret.first < 0) {
      is_end_ = true;
2773
    }
Guolin Ke's avatar
Guolin Ke committed
2774
2775
2776
    return ret;
  } else {
    return std::make_pair(-1, 0.0);
2777
  }
Guolin Ke's avatar
Guolin Ke committed
2778
}