c_api.cpp 95.9 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
15
16
17
18
19
#include <LightGBM/objective_function.h>
#include <LightGBM/prediction_early_stop.h>
#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
20

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

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

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

Guolin Ke's avatar
Guolin Ke committed
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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;

51
52
53
54
55
56
#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);

57
58
59
60
61
62
63
64
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;

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

89
  ~SingleRowPredictor() {}
90

Guolin Ke's avatar
Guolin Ke committed
91
  bool IsPredictorEqual(const Config& config, int iter, Boosting* boosting) {
92
93
94
95
96
    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();
97
  }
Guolin Ke's avatar
Guolin Ke committed
98

99
100
101
102
103
104
105
106
107
 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
108
class Booster {
Nikita Titov's avatar
Nikita Titov committed
109
 public:
Guolin Ke's avatar
Guolin Ke committed
110
  explicit Booster(const char* filename) {
111
    boosting_.reset(Boosting::CreateBoosting("gbdt", filename));
112
113
  }

Guolin Ke's avatar
Guolin Ke committed
114
  Booster(const Dataset* train_data,
115
          const char* parameters) {
Guolin Ke's avatar
Guolin Ke committed
116
    auto param = Config::Str2Map(parameters);
wxchan's avatar
wxchan committed
117
    config_.Set(param);
118
119
120
    if (config_.num_threads > 0) {
      omp_set_num_threads(config_.num_threads);
    }
Guolin Ke's avatar
Guolin Ke committed
121
    // create boosting
Guolin Ke's avatar
Guolin Ke committed
122
    if (config_.input_model.size() > 0) {
123
124
      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
125
    }
Guolin Ke's avatar
Guolin Ke committed
126

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

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

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

  ~Booster() {
  }
150

151
  void CreateObjectiveAndMetrics() {
Guolin Ke's avatar
Guolin Ke committed
152
    // create objective function
Guolin Ke's avatar
Guolin Ke committed
153
154
    objective_fun_.reset(ObjectiveFunction::CreateObjectiveFunction(config_.objective,
                                                                    config_));
Guolin Ke's avatar
Guolin Ke committed
155
156
157
158
159
160
161
162
163
164
    if (objective_fun_ == nullptr) {
      Log::Warning("Using self-defined objective function");
    }
    // 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
165
    for (auto metric_type : config_.metric) {
Guolin Ke's avatar
Guolin Ke committed
166
      auto metric = std::unique_ptr<Metric>(
Guolin Ke's avatar
Guolin Ke committed
167
        Metric::CreateMetric(metric_type, config_));
Guolin Ke's avatar
Guolin Ke committed
168
169
170
171
172
      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();
173
174
175
176
  }

  void ResetTrainingData(const Dataset* train_data) {
    if (train_data != train_data_) {
177
      UNIQUE_LOCK(mutex_)
178
179
180
181
182
183
      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
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
289
290
291
  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`.");
    }
292
    if (new_param.count("linear_tree") && (new_config.linear_tree != old_config.linear_tree)) {
293
      Log::Fatal("Cannot change linear_tree after constructed Dataset handle.");
294
    }
295
296
  }

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

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

315
316
317
    if (config_.num_threads > 0) {
      omp_set_num_threads(config_.num_threads);
    }
Guolin Ke's avatar
Guolin Ke committed
318
319
320

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

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

  void AddValidData(const Dataset* valid_data) {
338
    UNIQUE_LOCK(mutex_)
wxchan's avatar
wxchan committed
339
    valid_metrics_.emplace_back();
Guolin Ke's avatar
Guolin Ke committed
340
341
    for (auto metric_type : config_.metric) {
      auto metric = std::unique_ptr<Metric>(Metric::CreateMetric(metric_type, config_));
wxchan's avatar
wxchan committed
342
343
344
345
346
347
      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,
348
                               Common::ConstPtrInVectorWrapper<Metric>(valid_metrics_.back()));
wxchan's avatar
wxchan committed
349
  }
Guolin Ke's avatar
Guolin Ke committed
350

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

Guolin Ke's avatar
Guolin Ke committed
356
  void Refit(const int32_t* leaf_preds, int32_t nrow, int32_t ncol) {
357
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
358
359
360
    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) {
361
        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
362
363
364
365
366
      }
    }
    boosting_->RefitTree(v_leaf_preds);
  }

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

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

377
  void SetSingleRowPredictor(int start_iteration, int num_iteration, int predict_type, const Config& config) {
378
379
380
381
      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(),
382
                                                                         config, start_iteration, num_iteration));
383
384
385
386
      }
  }

  void PredictSingleRow(int predict_type, int ncol,
387
388
               std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun,
               const Config& config,
389
               double* out_result, int64_t* out_len) const {
390
391
392
    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);
393
    }
394
395
    SHARED_LOCK(mutex_)
    const auto& single_row_predictor = single_row_predictor_[predict_type];
396
397
    auto one_row = get_row_fun(0);
    auto pred_wrt_ptr = out_result;
398
    single_row_predictor->predict_function(one_row, pred_wrt_ptr);
399

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

403
  Predictor CreatePredictor(int start_iteration, int num_iteration, int predict_type, int ncol, const Config& config) const {
404
405
406
    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);
407
    }
Guolin Ke's avatar
Guolin Ke committed
408
409
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
410
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
411
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
Guolin Ke's avatar
Guolin Ke committed
412
      is_predict_leaf = true;
Guolin Ke's avatar
Guolin Ke committed
413
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
Guolin Ke's avatar
Guolin Ke committed
414
      is_raw_score = true;
415
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
416
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
417
418
    } else {
      is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
419
    }
Guolin Ke's avatar
Guolin Ke committed
420

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

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

454
  void PredictSparse(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
455
456
457
458
                     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,
459
                     bool* is_data_float32_ptr, int num_matrices) const {
460
    auto predictor = CreatePredictor(start_iteration, num_iteration, predict_type, ncol, config);
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
494
495
    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];
  }

496
  void PredictSparseCSR(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
497
498
499
                        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,
500
501
                        int32_t** out_indices, void** out_data, int data_type) const {
    SHARED_LOCK(mutex_);
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
    // 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;
519
    PredictSparse(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, &elements_size, &agg,
520
521
522
                  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);
523
    std::vector<int64_t> matrix_offsets(num_matrices);
524
525
526
527
528
529
530
531
532
533
534
535
536
537
    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++;
      }
538
539
540
541
542
543
      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]);
      }
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
    }
    // 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;
561
        int64_t element_index = row_matrix_offsets[row_start_index] + matrix_offsets[m];
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
        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;
  }

587
  void PredictSparseCSC(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
588
589
590
                        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,
591
592
                        int32_t** out_indices, void** out_data, int data_type) const {
    SHARED_LOCK(mutex_);
593
594
    // Get the number of trees per iteration (for multiclass scenario we output multiple sparse matrices)
    int num_matrices = boosting_->NumModelPerIteration();
595
    auto predictor = CreatePredictor(start_iteration, num_iteration, predict_type, ncol, config);
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
    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;
613
    PredictSparse(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, &elements_size, &agg,
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
659
660
                  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;
      }
661
662
      if (m + 1 < num_matrices) {
        matrix_start_indices[m + 1] = matrix_start_indices[m] + last_column_start_index + last_column_size;
663
      }
664
      col_ptr_index++;
665
    }
666
667
668
    // 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)
669
    for (int m = 0; m < num_matrices; ++m) {
670
      OMP_LOOP_EX_BEGIN();
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
      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;
          }
        }
      }
689
      OMP_LOOP_EX_END();
690
    }
691
    OMP_THROW_EX();
692
693
694
695
    out_len[0] = elements_size;
    out_len[1] = col_ptr_size;
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

781
  int GetEvalNames(char** out_strs, const int len, const size_t buffer_len, size_t *out_buffer_len) const {
782
    SHARED_LOCK(mutex_)
783
    *out_buffer_len = 0;
wxchan's avatar
wxchan committed
784
785
786
    int idx = 0;
    for (const auto& metric : train_metric_) {
      for (const auto& name : metric->GetName()) {
787
788
789
790
791
        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
792
793
794
795
796
797
        ++idx;
      }
    }
    return idx;
  }

798
  int GetFeatureNames(char** out_strs, const int len, const size_t buffer_len, size_t *out_buffer_len) const {
799
    SHARED_LOCK(mutex_)
800
    *out_buffer_len = 0;
wxchan's avatar
wxchan committed
801
802
    int idx = 0;
    for (const auto& name : boosting_->FeatureNames()) {
803
804
805
806
807
      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
808
809
810
811
812
      ++idx;
    }
    return idx;
  }

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

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

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

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

834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
// 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
851

Guolin Ke's avatar
Guolin Ke committed
852
853
854
855
856
857
858
859
// 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);

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

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

// Row iterator of on column for CSC matrix
class CSC_RowIterator {
Nikita Titov's avatar
Nikita Titov committed
870
 public:
Guolin Ke's avatar
Guolin Ke committed
871
  CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
872
                  const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx);
Guolin Ke's avatar
Guolin Ke committed
873
874
875
876
877
  ~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
878
879

 private:
Guolin Ke's avatar
Guolin Ke committed
880
881
882
883
884
885
886
887
888
  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
889
const char* LGBM_GetLastError() {
wxchan's avatar
wxchan committed
890
  return LastErrorMsg();
Guolin Ke's avatar
Guolin Ke committed
891
892
}

893
894
895
896
897
898
int LGBM_RegisterLogCallback(void (*callback)(const char*)) {
  API_BEGIN();
  Log::ResetCallBack(callback);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
899
int LGBM_DatasetCreateFromFile(const char* filename,
900
901
902
                               const char* parameters,
                               const DatasetHandle reference,
                               DatasetHandle* out) {
903
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
904
905
  auto param = Config::Str2Map(parameters);
  Config config;
906
907
908
909
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
910
  DatasetLoader loader(config, nullptr, 1, filename);
Guolin Ke's avatar
Guolin Ke committed
911
  if (reference == nullptr) {
912
    if (Network::num_machines() == 1) {
913
      *out = loader.LoadFromFile(filename);
914
    } else {
915
      *out = loader.LoadFromFile(filename, Network::rank(), Network::num_machines());
916
    }
Guolin Ke's avatar
Guolin Ke committed
917
  } else {
918
    *out = loader.LoadFromFileAlignWithOtherDataset(filename,
919
                                                    reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
920
  }
921
  API_END();
Guolin Ke's avatar
Guolin Ke committed
922
923
}

924

Guolin Ke's avatar
Guolin Ke committed
925
int LGBM_DatasetCreateFromSampledColumn(double** sample_data,
926
927
928
929
930
931
932
                                        int** sample_indices,
                                        int32_t ncol,
                                        const int* num_per_col,
                                        int32_t num_sample_row,
                                        int32_t num_total_row,
                                        const char* parameters,
                                        DatasetHandle* out) {
933
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
934
935
  auto param = Config::Str2Map(parameters);
  Config config;
936
937
938
939
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
940
  DatasetLoader loader(config, nullptr, 1, nullptr);
941
942
943
  *out = loader.ConstructFromSampleData(sample_data, sample_indices, ncol, num_per_col,
                                        num_sample_row,
                                        static_cast<data_size_t>(num_total_row));
944
  API_END();
Guolin Ke's avatar
Guolin Ke committed
945
946
}

947

Guolin Ke's avatar
Guolin Ke committed
948
int LGBM_DatasetCreateByReference(const DatasetHandle reference,
949
950
                                  int64_t num_total_row,
                                  DatasetHandle* out) {
Guolin Ke's avatar
Guolin Ke committed
951
952
953
954
955
956
957
958
  API_BEGIN();
  std::unique_ptr<Dataset> ret;
  ret.reset(new Dataset(static_cast<data_size_t>(num_total_row)));
  ret->CreateValid(reinterpret_cast<const Dataset*>(reference));
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
959
int LGBM_DatasetPushRows(DatasetHandle dataset,
960
961
962
963
964
                         const void* data,
                         int data_type,
                         int32_t nrow,
                         int32_t ncol,
                         int32_t start_row) {
Guolin Ke's avatar
Guolin Ke committed
965
966
967
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, 1);
968
969
970
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }
971
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
972
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
973
  for (int i = 0; i < nrow; ++i) {
974
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
975
976
977
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(tid, start_row + i, one_row);
978
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
979
  }
980
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
981
982
983
984
985
986
  if (start_row + nrow == p_dataset->num_data()) {
    p_dataset->FinishLoad();
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
987
int LGBM_DatasetPushRowsByCSR(DatasetHandle dataset,
988
989
990
991
992
993
994
995
996
                              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
997
998
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
999
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
1000
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
1001
1002
1003
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }
1004
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1005
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1006
  for (int i = 0; i < nrow; ++i) {
1007
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1008
1009
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
1010
    p_dataset->PushOneRow(tid, static_cast<data_size_t>(start_row + i), one_row);
1011
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1012
  }
1013
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
1014
1015
1016
1017
1018
1019
  if (start_row + nrow == static_cast<int64_t>(p_dataset->num_data())) {
    p_dataset->FinishLoad();
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1020
int LGBM_DatasetCreateFromMat(const void* data,
1021
1022
1023
1024
1025
1026
1027
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
  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) {
1049
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1050
1051
  auto param = Config::Str2Map(parameters);
  Config config;
1052
1053
1054
1055
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1056
  std::unique_ptr<Dataset> ret;
1057
1058
1059
1060
1061
1062
1063
1064
1065
  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));
  }
1066

Guolin Ke's avatar
Guolin Ke committed
1067
1068
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
1069
    Random rand(config.data_random_seed);
1070
1071
    int sample_cnt = static_cast<int>(total_nrow < config.bin_construct_sample_cnt ? total_nrow : config.bin_construct_sample_cnt);
    auto sample_indices = rand.Sample(total_nrow, sample_cnt);
1072
    sample_cnt = static_cast<int>(sample_indices.size());
1073
    std::vector<std::vector<double>> sample_values(ncol);
Guolin Ke's avatar
Guolin Ke committed
1074
    std::vector<std::vector<int>> sample_idx(ncol);
1075
1076
1077

    int offset = 0;
    int j = 0;
Guolin Ke's avatar
Guolin Ke committed
1078
    for (size_t i = 0; i < sample_indices.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
1079
      auto idx = sample_indices[i];
1080
1081
1082
1083
      while ((idx - offset) >= nrow[j]) {
        offset += nrow[j];
        ++j;
      }
1084

1085
1086
1087
1088
1089
      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
1090
        }
Guolin Ke's avatar
Guolin Ke committed
1091
1092
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1093
    DatasetLoader loader(config, nullptr, 1, nullptr);
1094
1095
1096
1097
1098
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             ncol,
                                             VectorSize<double>(sample_values).data(),
                                             sample_cnt, total_nrow));
Guolin Ke's avatar
Guolin Ke committed
1099
  } else {
1100
    ret.reset(new Dataset(total_nrow));
Guolin Ke's avatar
Guolin Ke committed
1101
    ret->CreateValid(
1102
      reinterpret_cast<const Dataset*>(reference));
1103
1104
1105
    if (ret->has_raw()) {
      ret->ResizeRaw(total_nrow);
    }
Guolin Ke's avatar
Guolin Ke committed
1106
  }
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
  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
1121
1122
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1123
  *out = ret.release();
1124
  API_END();
1125
1126
}

Guolin Ke's avatar
Guolin Ke committed
1127
int LGBM_DatasetCreateFromCSR(const void* indptr,
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
                              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) {
1138
  API_BEGIN();
1139
1140
1141
1142
1143
  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
1144
1145
  auto param = Config::Str2Map(parameters);
  Config config;
1146
1147
1148
1149
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1150
  std::unique_ptr<Dataset> ret;
1151
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
1152
1153
1154
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
1155
1156
    Random rand(config.data_random_seed);
    int sample_cnt = static_cast<int>(nrow < config.bin_construct_sample_cnt ? nrow : config.bin_construct_sample_cnt);
1157
    auto sample_indices = rand.Sample(nrow, sample_cnt);
1158
    sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
1159
1160
    std::vector<std::vector<double>> sample_values(num_col);
    std::vector<std::vector<int>> sample_idx(num_col);
1161
1162
1163
1164
    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
1165
        CHECK_LT(inner_data.first, num_col);
Guolin Ke's avatar
Guolin Ke committed
1166
        if (std::fabs(inner_data.second) > kZeroThreshold || std::isnan(inner_data.second)) {
Guolin Ke's avatar
Guolin Ke committed
1167
1168
          sample_values[inner_data.first].emplace_back(inner_data.second);
          sample_idx[inner_data.first].emplace_back(static_cast<int>(i));
1169
1170
1171
        }
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1172
    DatasetLoader loader(config, nullptr, 1, nullptr);
1173
1174
1175
1176
1177
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             static_cast<int>(num_col),
                                             VectorSize<double>(sample_values).data(),
                                             sample_cnt, nrow));
1178
  } else {
1179
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
1180
    ret->CreateValid(
1181
      reinterpret_cast<const Dataset*>(reference));
1182
1183
1184
    if (ret->has_raw()) {
      ret->ResizeRaw(nrow);
    }
1185
  }
1186
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1187
  #pragma omp parallel for schedule(static)
1188
  for (int i = 0; i < nindptr - 1; ++i) {
1189
    OMP_LOOP_EX_BEGIN();
1190
1191
1192
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    ret->PushOneRow(tid, i, one_row);
1193
    OMP_LOOP_EX_END();
1194
  }
1195
  OMP_THROW_EX();
1196
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1197
  *out = ret.release();
1198
  API_END();
1199
1200
}

1201
int LGBM_DatasetCreateFromCSRFunc(void* get_row_funptr,
1202
1203
1204
1205
1206
                                  int num_rows,
                                  int64_t num_col,
                                  const char* parameters,
                                  const DatasetHandle reference,
                                  DatasetHandle* out) {
1207
  API_BEGIN();
1208
1209
1210
1211
1212
  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.");
  }
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
  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);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
  std::unique_ptr<Dataset> ret;
  int32_t nrow = num_rows;
  if (reference == nullptr) {
    // sample data first
    Random rand(config.data_random_seed);
    int sample_cnt = static_cast<int>(nrow < config.bin_construct_sample_cnt ? nrow : config.bin_construct_sample_cnt);
    auto sample_indices = rand.Sample(nrow, sample_cnt);
    sample_cnt = static_cast<int>(sample_indices.size());
    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
1236
        CHECK_LT(inner_data.first, num_col);
1237
1238
1239
1240
1241
1242
1243
        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);
1244
1245
1246
1247
1248
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             static_cast<int>(num_col),
                                             VectorSize<double>(sample_values).data(),
                                             sample_cnt, nrow));
1249
1250
1251
1252
  } else {
    ret.reset(new Dataset(nrow));
    ret->CreateValid(
      reinterpret_cast<const Dataset*>(reference));
1253
1254
1255
    if (ret->has_raw()) {
      ret->ResizeRaw(nrow);
    }
1256
  }
1257

1258
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1259
1260
  std::vector<std::pair<int, double>> thread_buffer;
  #pragma omp parallel for schedule(static) private(thread_buffer)
1261
1262
1263
  for (int i = 0; i < num_rows; ++i) {
    OMP_LOOP_EX_BEGIN();
    {
1264
      const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1265
1266
      get_row_fun(i, thread_buffer);
      ret->PushOneRow(tid, i, thread_buffer);
1267
1268
1269
1270
1271
1272
1273
1274
1275
    }
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();
  ret->FinishLoad();
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1276
int LGBM_DatasetCreateFromCSC(const void* col_ptr,
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
                              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) {
1287
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1288
1289
  auto param = Config::Str2Map(parameters);
  Config config;
1290
1291
1292
1293
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1294
  std::unique_ptr<Dataset> ret;
Guolin Ke's avatar
Guolin Ke committed
1295
1296
1297
  int32_t nrow = static_cast<int32_t>(num_row);
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
1298
1299
    Random rand(config.data_random_seed);
    int sample_cnt = static_cast<int>(nrow < config.bin_construct_sample_cnt ? nrow : config.bin_construct_sample_cnt);
Guolin Ke's avatar
Guolin Ke committed
1300
    auto sample_indices = rand.Sample(nrow, sample_cnt);
1301
    sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
1302
    std::vector<std::vector<double>> sample_values(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
1303
    std::vector<std::vector<int>> sample_idx(ncol_ptr - 1);
1304
    OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1305
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1306
    for (int i = 0; i < static_cast<int>(sample_values.size()); ++i) {
1307
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1308
1309
1310
      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
1311
        if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
Guolin Ke's avatar
Guolin Ke committed
1312
1313
          sample_values[i].emplace_back(val);
          sample_idx[i].emplace_back(j);
Guolin Ke's avatar
Guolin Ke committed
1314
1315
        }
      }
1316
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1317
    }
1318
    OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
1319
    DatasetLoader loader(config, nullptr, 1, nullptr);
1320
1321
1322
1323
1324
    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(),
                                             sample_cnt, nrow));
Guolin Ke's avatar
Guolin Ke committed
1325
  } else {
1326
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
1327
    ret->CreateValid(
1328
      reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
1329
  }
1330
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1331
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1332
  for (int i = 0; i < ncol_ptr - 1; ++i) {
1333
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1334
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1335
    int feature_idx = ret->InnerFeatureIndex(i);
Guolin Ke's avatar
Guolin Ke committed
1336
    if (feature_idx < 0) { continue; }
Guolin Ke's avatar
Guolin Ke committed
1337
1338
    int group = ret->Feature2Group(feature_idx);
    int sub_feature = ret->Feture2SubFeature(feature_idx);
Guolin Ke's avatar
Guolin Ke committed
1339
    CSC_RowIterator col_it(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, i);
Guolin Ke's avatar
Guolin Ke committed
1340
1341
1342
1343
1344
1345
1346
1347
    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; }
1348
        ret->PushOneData(tid, row_idx, group, feature_idx, sub_feature, pair.second);
Guolin Ke's avatar
Guolin Ke committed
1349
1350
1351
1352
      }
    } else {
      for (int row_idx = 0; row_idx < nrow; ++row_idx) {
        auto val = col_it.Get(row_idx);
1353
        ret->PushOneData(tid, row_idx, group, feature_idx, sub_feature, val);
Guolin Ke's avatar
Guolin Ke committed
1354
      }
Guolin Ke's avatar
Guolin Ke committed
1355
    }
1356
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1357
  }
1358
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
1359
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1360
  *out = ret.release();
1361
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1362
1363
}

Guolin Ke's avatar
Guolin Ke committed
1364
int LGBM_DatasetGetSubset(
1365
  const DatasetHandle handle,
wxchan's avatar
wxchan committed
1366
1367
1368
  const int32_t* used_row_indices,
  int32_t num_used_row_indices,
  const char* parameters,
Guolin Ke's avatar
typo  
Guolin Ke committed
1369
  DatasetHandle* out) {
wxchan's avatar
wxchan committed
1370
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1371
1372
  auto param = Config::Str2Map(parameters);
  Config config;
1373
1374
1375
1376
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
1377
  auto full_dataset = reinterpret_cast<const Dataset*>(handle);
1378
  CHECK_GT(num_used_row_indices, 0);
1379
1380
  const int32_t lower = 0;
  const int32_t upper = full_dataset->num_data() - 1;
1381
  CheckElementsIntervalClosed(used_row_indices, lower, upper, num_used_row_indices, "Used indices of subset");
1382
1383
1384
  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
1385
  auto ret = std::unique_ptr<Dataset>(new Dataset(num_used_row_indices));
1386
  ret->CopyFeatureMapperFrom(full_dataset);
1387
  ret->CopySubrow(full_dataset, used_row_indices, num_used_row_indices, true);
wxchan's avatar
wxchan committed
1388
1389
1390
1391
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1392
int LGBM_DatasetSetFeatureNames(
Guolin Ke's avatar
typo  
Guolin Ke committed
1393
  DatasetHandle handle,
Guolin Ke's avatar
Guolin Ke committed
1394
  const char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
1395
  int num_feature_names) {
Guolin Ke's avatar
Guolin Ke committed
1396
1397
1398
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  std::vector<std::string> feature_names_str;
Guolin Ke's avatar
Guolin Ke committed
1399
  for (int i = 0; i < num_feature_names; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1400
1401
1402
1403
1404
1405
    feature_names_str.emplace_back(feature_names[i]);
  }
  dataset->set_feature_names(feature_names_str);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1406
int LGBM_DatasetGetFeatureNames(
1407
1408
1409
1410
1411
1412
    DatasetHandle handle,
    const int len,
    int* num_feature_names,
    const size_t buffer_len,
    size_t* out_buffer_len,
    char** feature_names) {
1413
  API_BEGIN();
1414
  *out_buffer_len = 0;
1415
1416
  auto dataset = reinterpret_cast<Dataset*>(handle);
  auto inside_feature_name = dataset->feature_names();
Guolin Ke's avatar
Guolin Ke committed
1417
1418
  *num_feature_names = static_cast<int>(inside_feature_name.size());
  for (int i = 0; i < *num_feature_names; ++i) {
1419
1420
1421
1422
1423
    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);
1424
1425
1426
1427
  }
  API_END();
}

1428
1429
1430
#ifdef _MSC_VER
  #pragma warning(disable : 4702)
#endif
Guolin Ke's avatar
Guolin Ke committed
1431
int LGBM_DatasetFree(DatasetHandle handle) {
1432
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1433
  delete reinterpret_cast<Dataset*>(handle);
1434
  API_END();
1435
1436
}

Guolin Ke's avatar
Guolin Ke committed
1437
int LGBM_DatasetSaveBinary(DatasetHandle handle,
1438
                           const char* filename) {
1439
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1440
1441
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->SaveBinaryFile(filename);
1442
  API_END();
1443
1444
}

1445
1446
1447
1448
1449
1450
1451
1452
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
1453
int LGBM_DatasetSetField(DatasetHandle handle,
1454
1455
1456
1457
                         const char* field_name,
                         const void* field_data,
                         int num_element,
                         int type) {
1458
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1459
  auto dataset = reinterpret_cast<Dataset*>(handle);
1460
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
1461
  if (type == C_API_DTYPE_FLOAT32) {
Guolin Ke's avatar
Guolin Ke committed
1462
    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
1463
  } else if (type == C_API_DTYPE_INT32) {
Guolin Ke's avatar
Guolin Ke committed
1464
    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
1465
1466
  } 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));
1467
  }
1468
  if (!is_success) { Log::Fatal("Input data type error or field not found"); }
1469
  API_END();
1470
1471
}

Guolin Ke's avatar
Guolin Ke committed
1472
int LGBM_DatasetGetField(DatasetHandle handle,
1473
1474
1475
1476
                         const char* field_name,
                         int* out_len,
                         const void** out_ptr,
                         int* out_type) {
1477
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1478
  auto dataset = reinterpret_cast<Dataset*>(handle);
1479
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
1480
  if (dataset->GetFloatField(field_name, out_len, reinterpret_cast<const float**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
1481
    *out_type = C_API_DTYPE_FLOAT32;
1482
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
1483
  } else if (dataset->GetIntField(field_name, out_len, reinterpret_cast<const int**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
1484
    *out_type = C_API_DTYPE_INT32;
1485
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
1486
1487
1488
  } 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
1489
  }
1490
  if (!is_success) { Log::Fatal("Field not found"); }
wxchan's avatar
wxchan committed
1491
  if (*out_ptr == nullptr) { *out_len = 0; }
1492
  API_END();
1493
1494
}

1495
int LGBM_DatasetUpdateParamChecking(const char* old_parameters, const char* new_parameters) {
1496
  API_BEGIN();
1497
1498
1499
1500
1501
  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);
1502
1503
1504
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1505
int LGBM_DatasetGetNumData(DatasetHandle handle,
1506
                           int* out) {
1507
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1508
1509
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_data();
1510
  API_END();
1511
1512
}

Guolin Ke's avatar
Guolin Ke committed
1513
int LGBM_DatasetGetNumFeature(DatasetHandle handle,
1514
                              int* out) {
1515
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1516
1517
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_total_features();
1518
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1519
}
1520

1521
1522
1523
1524
1525
int LGBM_DatasetAddFeaturesFrom(DatasetHandle target,
                                DatasetHandle source) {
  API_BEGIN();
  auto target_d = reinterpret_cast<Dataset*>(target);
  auto source_d = reinterpret_cast<Dataset*>(source);
1526
  target_d->AddFeaturesFrom(source_d);
1527
1528
1529
  API_END();
}

1530
1531
// ---- start of booster

Guolin Ke's avatar
Guolin Ke committed
1532
int LGBM_BoosterCreate(const DatasetHandle train_data,
1533
1534
                       const char* parameters,
                       BoosterHandle* out) {
1535
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1536
  const Dataset* p_train_data = reinterpret_cast<const Dataset*>(train_data);
wxchan's avatar
wxchan committed
1537
1538
  auto ret = std::unique_ptr<Booster>(new Booster(p_train_data, parameters));
  *out = ret.release();
1539
  API_END();
1540
1541
}

Guolin Ke's avatar
Guolin Ke committed
1542
int LGBM_BoosterCreateFromModelfile(
1543
  const char* filename,
Guolin Ke's avatar
Guolin Ke committed
1544
  int* out_num_iterations,
1545
  BoosterHandle* out) {
1546
  API_BEGIN();
wxchan's avatar
wxchan committed
1547
  auto ret = std::unique_ptr<Booster>(new Booster(filename));
Guolin Ke's avatar
Guolin Ke committed
1548
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
wxchan's avatar
wxchan committed
1549
  *out = ret.release();
1550
  API_END();
1551
1552
}

Guolin Ke's avatar
Guolin Ke committed
1553
int LGBM_BoosterLoadModelFromString(
1554
1555
1556
1557
  const char* model_str,
  int* out_num_iterations,
  BoosterHandle* out) {
  API_BEGIN();
wxchan's avatar
wxchan committed
1558
  auto ret = std::unique_ptr<Booster>(new Booster(nullptr));
1559
1560
1561
1562
1563
1564
  ret->LoadModelFromString(model_str);
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
  *out = ret.release();
  API_END();
}

1565
1566
1567
#ifdef _MSC_VER
  #pragma warning(disable : 4702)
#endif
Guolin Ke's avatar
Guolin Ke committed
1568
int LGBM_BoosterFree(BoosterHandle handle) {
1569
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1570
  delete reinterpret_cast<Booster*>(handle);
1571
  API_END();
1572
1573
}

1574
int LGBM_BoosterShuffleModels(BoosterHandle handle, int start_iter, int end_iter) {
1575
1576
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1577
  ref_booster->ShuffleModels(start_iter, end_iter);
1578
1579
1580
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1581
int LGBM_BoosterMerge(BoosterHandle handle,
1582
                      BoosterHandle other_handle) {
wxchan's avatar
wxchan committed
1583
1584
1585
1586
1587
1588
1589
  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
1590
int LGBM_BoosterAddValidData(BoosterHandle handle,
1591
                             const DatasetHandle valid_data) {
wxchan's avatar
wxchan committed
1592
1593
1594
1595
1596
1597
1598
  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
1599
int LGBM_BoosterResetTrainingData(BoosterHandle handle,
1600
                                  const DatasetHandle train_data) {
wxchan's avatar
wxchan committed
1601
1602
1603
1604
1605
1606
1607
  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
1608
int LGBM_BoosterResetParameter(BoosterHandle handle, const char* parameters) {
wxchan's avatar
wxchan committed
1609
1610
1611
1612
1613
1614
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->ResetConfig(parameters);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1615
int LGBM_BoosterGetNumClasses(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1616
1617
1618
1619
1620
1621
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->NumberOfClasses();
  API_END();
}

1622
1623
1624
1625
1626
1627
1628
int LGBM_BoosterGetLinear(BoosterHandle handle, bool* out) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out = ref_booster->GetBoosting()->IsLinear();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1629
1630
1631
1632
1633
1634
1635
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
1636
int LGBM_BoosterUpdateOneIter(BoosterHandle handle, int* is_finished) {
1637
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1638
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1639
1640
1641
1642
1643
  if (ref_booster->TrainOneIter()) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
1644
  API_END();
1645
1646
}

Guolin Ke's avatar
Guolin Ke committed
1647
int LGBM_BoosterUpdateOneIterCustom(BoosterHandle handle,
1648
1649
1650
                                    const float* grad,
                                    const float* hess,
                                    int* is_finished) {
1651
  API_BEGIN();
1652
  #ifdef SCORE_T_USE_DOUBLE
1653
1654
1655
1656
  (void) handle;       // UNUSED VARIABLE
  (void) grad;         // UNUSED VARIABLE
  (void) hess;         // UNUSED VARIABLE
  (void) is_finished;  // UNUSED VARIABLE
1657
  Log::Fatal("Don't support custom loss function when SCORE_T_USE_DOUBLE is enabled");
1658
  #else
1659
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1660
1661
1662
1663
1664
  if (ref_booster->TrainOneIter(grad, hess)) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
1665
  #endif
1666
  API_END();
1667
1668
}

Guolin Ke's avatar
Guolin Ke committed
1669
int LGBM_BoosterRollbackOneIter(BoosterHandle handle) {
wxchan's avatar
wxchan committed
1670
1671
1672
1673
1674
1675
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->RollbackOneIter();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1676
int LGBM_BoosterGetCurrentIteration(BoosterHandle handle, int* out_iteration) {
wxchan's avatar
wxchan committed
1677
1678
1679
1680
1681
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_iteration = ref_booster->GetBoosting()->GetCurrentIteration();
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
1682

1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
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
1697
int LGBM_BoosterGetEvalCounts(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1698
1699
1700
1701
1702
1703
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalCounts();
  API_END();
}

1704
1705
1706
1707
1708
1709
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
1710
1711
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1712
  *out_len = ref_booster->GetEvalNames(out_strs, len, buffer_len, out_buffer_len);
wxchan's avatar
wxchan committed
1713
1714
1715
  API_END();
}

1716
1717
1718
1719
1720
1721
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
1722
1723
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1724
  *out_len = ref_booster->GetFeatureNames(out_strs, len, buffer_len, out_buffer_len);
wxchan's avatar
wxchan committed
1725
1726
1727
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1728
int LGBM_BoosterGetNumFeature(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1729
1730
1731
1732
1733
1734
  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
1735
int LGBM_BoosterGetEval(BoosterHandle handle,
1736
1737
1738
                        int data_idx,
                        int* out_len,
                        double* out_results) {
1739
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1740
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1741
  auto boosting = ref_booster->GetBoosting();
wxchan's avatar
wxchan committed
1742
  auto result_buf = boosting->GetEvalAt(data_idx);
Guolin Ke's avatar
Guolin Ke committed
1743
  *out_len = static_cast<int>(result_buf.size());
1744
  for (size_t i = 0; i < result_buf.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
1745
    (out_results)[i] = static_cast<double>(result_buf[i]);
1746
  }
1747
  API_END();
1748
1749
}

Guolin Ke's avatar
Guolin Ke committed
1750
int LGBM_BoosterGetNumPredict(BoosterHandle handle,
1751
1752
                              int data_idx,
                              int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
1753
1754
1755
1756
1757
1758
  API_BEGIN();
  auto boosting = reinterpret_cast<Booster*>(handle)->GetBoosting();
  *out_len = boosting->GetNumPredictAt(data_idx);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1759
int LGBM_BoosterGetPredict(BoosterHandle handle,
1760
1761
1762
                           int data_idx,
                           int64_t* out_len,
                           double* out_result) {
1763
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1764
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1765
  ref_booster->GetPredictAt(data_idx, out_result, out_len);
1766
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1767
1768
}

Guolin Ke's avatar
Guolin Ke committed
1769
int LGBM_BoosterPredictForFile(BoosterHandle handle,
1770
1771
1772
                               const char* data_filename,
                               int data_has_header,
                               int predict_type,
1773
                               int start_iteration,
1774
                               int num_iteration,
1775
                               const char* parameter,
1776
                               const char* result_filename) {
1777
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1778
1779
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1780
1781
1782
1783
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1784
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1785
  ref_booster->Predict(start_iteration, num_iteration, predict_type, data_filename, data_has_header,
Guolin Ke's avatar
Guolin Ke committed
1786
                       config, result_filename);
1787
  API_END();
1788
1789
}

Guolin Ke's avatar
Guolin Ke committed
1790
int LGBM_BoosterCalcNumPredict(BoosterHandle handle,
1791
1792
                               int num_row,
                               int predict_type,
1793
                               int start_iteration,
1794
1795
                               int num_iteration,
                               int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
1796
1797
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1798
  *out_len = static_cast<int64_t>(num_row) * ref_booster->GetBoosting()->NumPredictOneRow(start_iteration,
1799
    num_iteration, predict_type == C_API_PREDICT_LEAF_INDEX, predict_type == C_API_PREDICT_CONTRIB);
Guolin Ke's avatar
Guolin Ke committed
1800
1801
1802
  API_END();
}

1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
/*!
 * \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,
1816
             const int predict_type_,
1817
             const int data_type_,
1818
             const int32_t num_cols) : booster(booster_ptr), predict_type(predict_type_), data_type(data_type_), ncol(num_cols) {
1819
1820
1821
1822
1823
    config.Set(Config::Str2Map(parameter));
  }

  Booster* const booster;
  Config config;
1824
  const int predict_type;
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
  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
1835
int LGBM_BoosterPredictForCSR(BoosterHandle handle,
1836
1837
1838
1839
1840
1841
1842
                              const void* indptr,
                              int indptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t nindptr,
                              int64_t nelem,
1843
                              int64_t num_col,
1844
                              int predict_type,
1845
                              int start_iteration,
1846
                              int num_iteration,
1847
                              const char* parameter,
1848
1849
                              int64_t* out_len,
                              double* out_result) {
1850
  API_BEGIN();
1851
1852
1853
1854
1855
  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
1856
1857
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1858
1859
1860
1861
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1862
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1863
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
1864
  int nrow = static_cast<int>(nindptr - 1);
1865
  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
1866
                       config, out_result, out_len);
1867
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1868
}
1869

1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
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,
1880
                                    int start_iteration,
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
                                    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);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
  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;
1904
    ref_booster->PredictSparseCSR(start_iteration, num_iteration, predict_type, nrow, static_cast<int>(num_col_or_row), get_row_fun,
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
                                  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;
    };
1928
    ref_booster->PredictSparseCSC(start_iteration, num_iteration, predict_type, num_col_or_row, ncol, get_row_fun, config,
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
                                  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) {
    delete reinterpret_cast<int32_t*>(indptr);
  } else if (indptr_type == C_API_DTYPE_INT64) {
    delete reinterpret_cast<int64_t*>(indptr);
  } else {
    Log::Fatal("Unknown indptr type in LGBM_BoosterFreePredictSparse");
  }
  delete indices;
  if (data_type == C_API_DTYPE_FLOAT32) {
    delete reinterpret_cast<float*>(data);
  } else if (data_type == C_API_DTYPE_FLOAT64) {
    delete reinterpret_cast<double*>(data);
  } else {
    Log::Fatal("Unknown data type in LGBM_BoosterFreePredictSparse");
  }
  API_END();
}

1956
int LGBM_BoosterPredictForCSRSingleRow(BoosterHandle handle,
1957
1958
1959
1960
1961
1962
1963
                                       const void* indptr,
                                       int indptr_type,
                                       const int32_t* indices,
                                       const void* data,
                                       int data_type,
                                       int64_t nindptr,
                                       int64_t nelem,
1964
                                       int64_t num_col,
1965
                                       int predict_type,
1966
                                       int start_iteration,
1967
1968
1969
1970
                                       int num_iteration,
                                       const char* parameter,
                                       int64_t* out_len,
                                       double* out_result) {
1971
  API_BEGIN();
1972
1973
1974
1975
1976
  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.");
  }
1977
1978
1979
1980
1981
1982
1983
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1984
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
1985
  ref_booster->SetSingleRowPredictor(start_iteration, num_iteration, predict_type, config);
1986
  ref_booster->PredictSingleRow(predict_type, static_cast<int32_t>(num_col), get_row_fun, config, out_result, out_len);
1987
1988
1989
  API_END();
}

1990
int LGBM_BoosterPredictForCSRSingleRowFastInit(BoosterHandle handle,
1991
                                               const int predict_type,
1992
                                               const int start_iteration,
1993
                                               const int num_iteration,
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
                                               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,
2008
    predict_type,
2009
2010
2011
2012
2013
2014
2015
    data_type,
    static_cast<int32_t>(num_col)));

  if (fastConfig_ptr->config.num_threads > 0) {
    omp_set_num_threads(fastConfig_ptr->config.num_threads);
  }

2016
  fastConfig_ptr->booster->SetSingleRowPredictor(start_iteration, num_iteration, predict_type, fastConfig_ptr->config);
2017

2018
2019
2020
2021
2022
2023
  *out_fastConfig = fastConfig_ptr.release();
  API_END();
}

int LGBM_BoosterPredictForCSRSingleRowFast(FastConfigHandle fastConfig_handle,
                                           const void* indptr,
2024
                                           const int indptr_type,
2025
2026
                                           const int32_t* indices,
                                           const void* data,
2027
2028
                                           const int64_t nindptr,
                                           const int64_t nelem,
2029
2030
2031
2032
2033
                                           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);
2034
  fastConfig->booster->PredictSingleRow(fastConfig->predict_type, fastConfig->ncol,
2035
2036
2037
2038
                                        get_row_fun, fastConfig->config, out_result, out_len);
  API_END();
}

2039

Guolin Ke's avatar
Guolin Ke committed
2040
int LGBM_BoosterPredictForCSC(BoosterHandle handle,
2041
2042
2043
2044
2045
2046
2047
2048
2049
                              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,
2050
                              int start_iteration,
2051
                              int num_iteration,
2052
                              const char* parameter,
2053
2054
                              int64_t* out_len,
                              double* out_result) {
Guolin Ke's avatar
Guolin Ke committed
2055
2056
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2057
2058
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2059
2060
2061
2062
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
2063
  int num_threads = OMP_NUM_THREADS();
Guolin Ke's avatar
Guolin Ke committed
2064
  int ncol = static_cast<int>(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
2065
2066
2067
2068
2069
  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
2070
2071
  }
  std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun =
Guolin Ke's avatar
Guolin Ke committed
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
      [&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;
      };
2084
  ref_booster->Predict(start_iteration, num_iteration, predict_type, static_cast<int>(num_row), ncol, get_row_fun, config,
cbecker's avatar
cbecker committed
2085
                       out_result, out_len);
Guolin Ke's avatar
Guolin Ke committed
2086
2087
2088
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2089
int LGBM_BoosterPredictForMat(BoosterHandle handle,
2090
2091
2092
2093
2094
2095
                              const void* data,
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              int predict_type,
2096
                              int start_iteration,
2097
                              int num_iteration,
2098
                              const char* parameter,
2099
2100
                              int64_t* out_len,
                              double* out_result) {
2101
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2102
2103
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2104
2105
2106
2107
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
2108
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2109
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
2110
  ref_booster->Predict(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
2111
                       config, out_result, out_len);
2112
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2113
}
2114

2115
int LGBM_BoosterPredictForMatSingleRow(BoosterHandle handle,
2116
2117
2118
2119
2120
                                       const void* data,
                                       int data_type,
                                       int32_t ncol,
                                       int is_row_major,
                                       int predict_type,
2121
                                       int start_iteration,
2122
2123
2124
2125
                                       int num_iteration,
                                       const char* parameter,
                                       int64_t* out_len,
                                       double* out_result) {
2126
2127
2128
2129
2130
2131
2132
2133
2134
  API_BEGIN();
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, 1, ncol, data_type, is_row_major);
2135
  ref_booster->SetSingleRowPredictor(start_iteration, num_iteration, predict_type, config);
2136
  ref_booster->PredictSingleRow(predict_type, ncol, get_row_fun, config, out_result, out_len);
2137
2138
2139
  API_END();
}

2140
int LGBM_BoosterPredictForMatSingleRowFastInit(BoosterHandle handle,
2141
                                               const int predict_type,
2142
                                               const int start_iteration,
2143
                                               const int num_iteration,
2144
2145
2146
2147
2148
2149
2150
2151
                                               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,
2152
    predict_type,
2153
2154
2155
2156
2157
2158
2159
    data_type,
    ncol));

  if (fastConfig_ptr->config.num_threads > 0) {
    omp_set_num_threads(fastConfig_ptr->config.num_threads);
  }

2160
  fastConfig_ptr->booster->SetSingleRowPredictor(start_iteration, num_iteration, predict_type, fastConfig_ptr->config);
2161

2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
  *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);
2174
  fastConfig->booster->PredictSingleRow(fastConfig->predict_type, fastConfig->ncol,
2175
2176
2177
2178
2179
                                        get_row_fun, fastConfig->config,
                                        out_result, out_len);
  API_END();
}

2180

2181
2182
2183
2184
2185
2186
int LGBM_BoosterPredictForMats(BoosterHandle handle,
                               const void** data,
                               int data_type,
                               int32_t nrow,
                               int32_t ncol,
                               int predict_type,
2187
                               int start_iteration,
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
                               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);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  auto get_row_fun = RowPairFunctionFromDenseRows(data, ncol, data_type);
2201
  ref_booster->Predict(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, out_result, out_len);
2202
2203
2204
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2205
int LGBM_BoosterSaveModel(BoosterHandle handle,
2206
                          int start_iteration,
2207
                          int num_iteration,
2208
                          int feature_importance_type,
2209
                          const char* filename) {
2210
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2211
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2212
2213
  ref_booster->SaveModelToFile(start_iteration, num_iteration,
                               feature_importance_type, filename);
wxchan's avatar
wxchan committed
2214
2215
2216
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2217
int LGBM_BoosterSaveModelToString(BoosterHandle handle,
2218
                                  int start_iteration,
2219
                                  int num_iteration,
2220
                                  int feature_importance_type,
2221
                                  int64_t buffer_len,
2222
                                  int64_t* out_len,
2223
                                  char* out_str) {
2224
2225
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2226
2227
  std::string model = ref_booster->SaveModelToString(
      start_iteration, num_iteration, feature_importance_type);
2228
  *out_len = static_cast<int64_t>(model.size()) + 1;
2229
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
2230
    std::memcpy(out_str, model.c_str(), *out_len);
2231
2232
2233
2234
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2235
int LGBM_BoosterDumpModel(BoosterHandle handle,
2236
                          int start_iteration,
2237
                          int num_iteration,
2238
                          int feature_importance_type,
2239
2240
                          int64_t buffer_len,
                          int64_t* out_len,
2241
                          char* out_str) {
wxchan's avatar
wxchan committed
2242
2243
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2244
2245
  std::string model = ref_booster->DumpModel(start_iteration, num_iteration,
                                             feature_importance_type);
2246
  *out_len = static_cast<int64_t>(model.size()) + 1;
wxchan's avatar
wxchan committed
2247
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
2248
    std::memcpy(out_str, model.c_str(), *out_len);
wxchan's avatar
wxchan committed
2249
  }
2250
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2251
}
2252

Guolin Ke's avatar
Guolin Ke committed
2253
int LGBM_BoosterGetLeafValue(BoosterHandle handle,
2254
2255
2256
                             int tree_idx,
                             int leaf_idx,
                             double* out_val) {
Guolin Ke's avatar
Guolin Ke committed
2257
2258
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2259
  *out_val = static_cast<double>(ref_booster->GetLeafValue(tree_idx, leaf_idx));
Guolin Ke's avatar
Guolin Ke committed
2260
2261
2262
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2263
int LGBM_BoosterSetLeafValue(BoosterHandle handle,
2264
2265
2266
                             int tree_idx,
                             int leaf_idx,
                             double val) {
Guolin Ke's avatar
Guolin Ke committed
2267
2268
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2269
  ref_booster->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
2270
2271
2272
  API_END();
}

2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
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();
}

2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
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();
}

2304
2305
2306
2307
2308
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
2309
  Config config;
2310
  config.machines = RemoveQuotationSymbol(std::string(machines));
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
  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();
}

2326
2327
2328
int LGBM_NetworkInitWithFunctions(int num_machines, int rank,
                                  void* reduce_scatter_ext_fun,
                                  void* allgather_ext_fun) {
ww's avatar
ww committed
2329
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2330
  if (num_machines > 1) {
2331
    Network::Init(num_machines, rank, (ReduceScatterFunction)reduce_scatter_ext_fun, (AllgatherFunction)allgather_ext_fun);
ww's avatar
ww committed
2332
2333
2334
  }
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
2335

Guolin Ke's avatar
Guolin Ke committed
2336
// ---- start of some help functions
2337

2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362

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

2363
2364
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
2365
  if (data_type == C_API_DTYPE_FLOAT32) {
2366
    return RowFunctionFromDenseMatric_helper<float>(data, num_row, num_col, is_row_major);
Guolin Ke's avatar
Guolin Ke committed
2367
  } else if (data_type == C_API_DTYPE_FLOAT64) {
2368
    return RowFunctionFromDenseMatric_helper<double>(data, num_row, num_col, is_row_major);
2369
  }
2370
  Log::Fatal("Unknown data type in RowFunctionFromDenseMatric");
2371
  return nullptr;
2372
2373
2374
2375
}

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
2376
2377
  auto inner_function = RowFunctionFromDenseMatric(data, num_row, num_col, data_type, is_row_major);
  if (inner_function != nullptr) {
2378
    return [inner_function] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
2379
2380
      auto raw_values = inner_function(row_idx);
      std::vector<std::pair<int, double>> ret;
Guolin Ke's avatar
Guolin Ke committed
2381
      ret.reserve(raw_values.size());
Guolin Ke's avatar
Guolin Ke committed
2382
      for (int i = 0; i < static_cast<int>(raw_values.size()); ++i) {
Guolin Ke's avatar
Guolin Ke committed
2383
        if (std::fabs(raw_values[i]) > kZeroThreshold || std::isnan(raw_values[i])) {
Guolin Ke's avatar
Guolin Ke committed
2384
          ret.emplace_back(i, raw_values[i]);
2385
        }
Guolin Ke's avatar
Guolin Ke committed
2386
2387
2388
      }
      return ret;
    };
2389
  }
Guolin Ke's avatar
Guolin Ke committed
2390
  return nullptr;
2391
2392
}

2393
2394
2395
2396
2397
2398
2399
// 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
2400
    ret.reserve(raw_values.size());
2401
2402
2403
2404
2405
2406
2407
2408
2409
    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;
  };
}

2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
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;
  };
}

2429
2430
template<typename T>
std::function<std::vector<std::pair<int, double>>(T idx)>
2431
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
2432
2433
  if (data_type == C_API_DTYPE_FLOAT32) {
    if (indptr_type == C_API_DTYPE_INT32) {
2434
     return RowFunctionFromCSR_helper<T, float, int32_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2435
    } else if (indptr_type == C_API_DTYPE_INT64) {
2436
     return RowFunctionFromCSR_helper<T, float, int64_t>(indptr, indices, data);
2437
    }
Guolin Ke's avatar
Guolin Ke committed
2438
2439
  } else if (data_type == C_API_DTYPE_FLOAT64) {
    if (indptr_type == C_API_DTYPE_INT32) {
2440
     return RowFunctionFromCSR_helper<T, double, int32_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2441
    } else if (indptr_type == C_API_DTYPE_INT64) {
2442
     return RowFunctionFromCSR_helper<T, double, int64_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2443
2444
    }
  }
2445
  Log::Fatal("Unknown data type in RowFunctionFromCSR");
2446
  return nullptr;
2447
2448
}

2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467


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
2468
std::function<std::pair<int, double>(int idx)>
2469
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
2470
  CHECK(col_idx < ncol_ptr && col_idx >= 0);
Guolin Ke's avatar
Guolin Ke committed
2471
2472
  if (data_type == C_API_DTYPE_FLOAT32) {
    if (col_ptr_type == C_API_DTYPE_INT32) {
2473
      return IterateFunctionFromCSC_helper<float, int32_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2474
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
2475
      return IterateFunctionFromCSC_helper<float, int64_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2476
    }
Guolin Ke's avatar
Guolin Ke committed
2477
2478
  } else if (data_type == C_API_DTYPE_FLOAT64) {
    if (col_ptr_type == C_API_DTYPE_INT32) {
2479
      return IterateFunctionFromCSC_helper<double, int32_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2480
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
2481
      return IterateFunctionFromCSC_helper<double, int64_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2482
2483
    }
  }
2484
  Log::Fatal("Unknown data type in CSC matrix");
2485
  return nullptr;
2486
2487
}

Guolin Ke's avatar
Guolin Ke committed
2488
CSC_RowIterator::CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
2489
                                 const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx) {
Guolin Ke's avatar
Guolin Ke committed
2490
2491
2492
2493
2494
2495
2496
2497
2498
  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;
2499
    }
Guolin Ke's avatar
Guolin Ke committed
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
    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;
2517
    }
Guolin Ke's avatar
Guolin Ke committed
2518
2519
2520
    return ret;
  } else {
    return std::make_pair(-1, 0.0);
2521
  }
Guolin Ke's avatar
Guolin Ke committed
2522
}