c_api.cpp 62.2 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
#include <LightGBM/c_api.h>
Guolin Ke's avatar
Guolin Ke committed
2

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

#include <cstdio>
#include <vector>
#include <string>
#include <cstring>
Guolin Ke's avatar
Guolin Ke committed
21
#include <memory>
Guolin Ke's avatar
Guolin Ke committed
22
#include <stdexcept>
wxchan's avatar
wxchan committed
23
#include <mutex>
Guolin Ke's avatar
Guolin Ke committed
24
#include <functional>
Guolin Ke's avatar
Guolin Ke committed
25

Guolin Ke's avatar
Guolin Ke committed
26
27
#include "./application/predictor.hpp"

Guolin Ke's avatar
Guolin Ke committed
28
29
namespace LightGBM {

Guolin Ke's avatar
Guolin Ke committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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;

Guolin Ke's avatar
Guolin Ke committed
46
class Booster {
Nikita Titov's avatar
Nikita Titov committed
47
 public:
Guolin Ke's avatar
Guolin Ke committed
48
  explicit Booster(const char* filename) {
49
    boosting_.reset(Boosting::CreateBoosting("gbdt", filename));
50
51
  }

Guolin Ke's avatar
Guolin Ke committed
52
  Booster(const Dataset* train_data,
53
          const char* parameters) {
Guolin Ke's avatar
Guolin Ke committed
54
    auto param = Config::Str2Map(parameters);
wxchan's avatar
wxchan committed
55
    config_.Set(param);
56
57
58
    if (config_.num_threads > 0) {
      omp_set_num_threads(config_.num_threads);
    }
Guolin Ke's avatar
Guolin Ke committed
59
    // create boosting
Guolin Ke's avatar
Guolin Ke committed
60
    if (config_.input_model.size() > 0) {
61
62
      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
63
    }
Guolin Ke's avatar
Guolin Ke committed
64

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

67
68
    train_data_ = train_data;
    CreateObjectiveAndMetrics();
Guolin Ke's avatar
Guolin Ke committed
69
    // initialize the boosting
Guolin Ke's avatar
Guolin Ke committed
70
    if (config_.tree_learner == std::string("feature")) {
71
      Log::Fatal("Do not support feature parallel in c api");
72
    }
Guolin Ke's avatar
Guolin Ke committed
73
    if (Network::num_machines() == 1 && config_.tree_learner != std::string("serial")) {
74
      Log::Warning("Only find one worker, will switch to serial tree learner");
Guolin Ke's avatar
Guolin Ke committed
75
      config_.tree_learner = "serial";
76
    }
Guolin Ke's avatar
Guolin Ke committed
77
    boosting_->Init(&config_, train_data_, objective_fun_.get(),
78
                    Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
wxchan's avatar
wxchan committed
79
80
81
82
83
  }

  void MergeFrom(const Booster* other) {
    std::lock_guard<std::mutex> lock(mutex_);
    boosting_->MergeFrom(other->boosting_.get());
Guolin Ke's avatar
Guolin Ke committed
84
85
86
87
  }

  ~Booster() {
  }
88

89
  void CreateObjectiveAndMetrics() {
Guolin Ke's avatar
Guolin Ke committed
90
    // create objective function
Guolin Ke's avatar
Guolin Ke committed
91
92
    objective_fun_.reset(ObjectiveFunction::CreateObjectiveFunction(config_.objective,
                                                                    config_));
Guolin Ke's avatar
Guolin Ke committed
93
94
95
96
97
98
99
100
101
102
    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
103
    for (auto metric_type : config_.metric) {
Guolin Ke's avatar
Guolin Ke committed
104
      auto metric = std::unique_ptr<Metric>(
Guolin Ke's avatar
Guolin Ke committed
105
        Metric::CreateMetric(metric_type, config_));
Guolin Ke's avatar
Guolin Ke committed
106
107
108
109
110
      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();
111
112
113
114
115
116
117
118
119
120
121
  }

  void ResetTrainingData(const Dataset* train_data) {
    if (train_data != train_data_) {
      std::lock_guard<std::mutex> lock(mutex_);
      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
122
123
124
  }

  void ResetConfig(const char* parameters) {
Guolin Ke's avatar
Guolin Ke committed
125
    std::lock_guard<std::mutex> lock(mutex_);
Guolin Ke's avatar
Guolin Ke committed
126
    auto param = Config::Str2Map(parameters);
wxchan's avatar
wxchan committed
127
    if (param.count("num_class")) {
128
      Log::Fatal("Cannot change num_class during training");
wxchan's avatar
wxchan committed
129
    }
Guolin Ke's avatar
Guolin Ke committed
130
131
    if (param.count("boosting")) {
      Log::Fatal("Cannot change boosting during training");
wxchan's avatar
wxchan committed
132
    }
Guolin Ke's avatar
Guolin Ke committed
133
    if (param.count("metric")) {
134
      Log::Fatal("Cannot change metric during training");
Guolin Ke's avatar
Guolin Ke committed
135
    }
Guolin Ke's avatar
Guolin Ke committed
136
137

    config_.Set(param);
138
139
140
    if (config_.num_threads > 0) {
      omp_set_num_threads(config_.num_threads);
    }
Guolin Ke's avatar
Guolin Ke committed
141
142
143

    if (param.count("objective")) {
      // create objective function
Guolin Ke's avatar
Guolin Ke committed
144
145
      objective_fun_.reset(ObjectiveFunction::CreateObjectiveFunction(config_.objective,
                                                                      config_));
Guolin Ke's avatar
Guolin Ke committed
146
147
148
149
150
151
152
      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());
      }
153
154
      boosting_->ResetTrainingData(train_data_,
                                   objective_fun_.get(), Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
wxchan's avatar
wxchan committed
155
    }
Guolin Ke's avatar
Guolin Ke committed
156

Guolin Ke's avatar
Guolin Ke committed
157
    boosting_->ResetConfig(&config_);
wxchan's avatar
wxchan committed
158
159
160
161
162
  }

  void AddValidData(const Dataset* valid_data) {
    std::lock_guard<std::mutex> lock(mutex_);
    valid_metrics_.emplace_back();
Guolin Ke's avatar
Guolin Ke committed
163
164
    for (auto metric_type : config_.metric) {
      auto metric = std::unique_ptr<Metric>(Metric::CreateMetric(metric_type, config_));
wxchan's avatar
wxchan committed
165
166
167
168
169
170
      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,
171
                               Common::ConstPtrInVectorWrapper<Metric>(valid_metrics_.back()));
wxchan's avatar
wxchan committed
172
  }
Guolin Ke's avatar
Guolin Ke committed
173

174
  bool TrainOneIter() {
wxchan's avatar
wxchan committed
175
    std::lock_guard<std::mutex> lock(mutex_);
Guolin Ke's avatar
Guolin Ke committed
176
    return boosting_->TrainOneIter(nullptr, nullptr);
177
178
  }

Guolin Ke's avatar
Guolin Ke committed
179
180
181
182
183
184
185
186
187
188
189
  void Refit(const int32_t* leaf_preds, int32_t nrow, int32_t ncol) {
    std::lock_guard<std::mutex> lock(mutex_);
    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) {
        v_leaf_preds[i][j] = leaf_preds[i * ncol + j];
      }
    }
    boosting_->RefitTree(v_leaf_preds);
  }

190
  bool TrainOneIter(const score_t* gradients, const score_t* hessians) {
wxchan's avatar
wxchan committed
191
    std::lock_guard<std::mutex> lock(mutex_);
Guolin Ke's avatar
Guolin Ke committed
192
    return boosting_->TrainOneIter(gradients, hessians);
193
194
  }

wxchan's avatar
wxchan committed
195
196
197
198
199
  void RollbackOneIter() {
    std::lock_guard<std::mutex> lock(mutex_);
    boosting_->RollbackOneIter();
  }

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
  void PredictSingleRow(int num_iteration, int predict_type,
               std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun,
               const Config& config,
               double* out_result, int64_t* out_len) {
    std::lock_guard<std::mutex> lock(mutex_);

    if (single_row_predictor_.get() == nullptr) {
      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;
      }

      // TODO: config could be optimized away... (maybe using lambda callback?)
      single_row_predictor_.reset(new Predictor(boosting_.get(), num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin));
      single_row_num_pred_in_one_row_ = boosting_->NumPredictOneRow(num_iteration, is_predict_leaf, predict_contrib);
      single_row_predict_function_ = single_row_predictor_->GetPredictFunction();
    }

    auto one_row = get_row_fun(0);
    auto pred_wrt_ptr = out_result;
    single_row_predict_function_(one_row, pred_wrt_ptr);

    *out_len = single_row_num_pred_in_one_row_;
  }


Guolin Ke's avatar
Guolin Ke committed
235
236
  void Predict(int num_iteration, int predict_type, int nrow,
               std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
237
               const Config& config,
Guolin Ke's avatar
Guolin Ke committed
238
               double* out_result, int64_t* out_len) {
wxchan's avatar
wxchan committed
239
    std::lock_guard<std::mutex> lock(mutex_);
Guolin Ke's avatar
Guolin Ke committed
240
241
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
242
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
243
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
Guolin Ke's avatar
Guolin Ke committed
244
      is_predict_leaf = true;
Guolin Ke's avatar
Guolin Ke committed
245
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
Guolin Ke's avatar
Guolin Ke committed
246
      is_raw_score = true;
247
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
248
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
249
250
    } else {
      is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
251
    }
Guolin Ke's avatar
Guolin Ke committed
252

Guolin Ke's avatar
Guolin Ke committed
253
    Predictor predictor(boosting_.get(), num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
254
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin);
Guolin Ke's avatar
Guolin Ke committed
255
    int64_t num_pred_in_one_row = boosting_->NumPredictOneRow(num_iteration, is_predict_leaf, predict_contrib);
Guolin Ke's avatar
Guolin Ke committed
256
    auto pred_fun = predictor.GetPredictFunction();
257
258
    OMP_INIT_EX();
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
259
    for (int i = 0; i < nrow; ++i) {
260
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
261
      auto one_row = get_row_fun(i);
Tony-Y's avatar
Tony-Y committed
262
      auto pred_wrt_ptr = out_result + static_cast<size_t>(num_pred_in_one_row) * i;
Guolin Ke's avatar
Guolin Ke committed
263
      pred_fun(one_row, pred_wrt_ptr);
264
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
265
    }
266
    OMP_THROW_EX();
267
    *out_len = num_pred_in_one_row * nrow;
Guolin Ke's avatar
Guolin Ke committed
268
269
270
  }

  void Predict(int num_iteration, int predict_type, const char* data_filename,
Guolin Ke's avatar
Guolin Ke committed
271
               int data_has_header, const Config& config,
cbecker's avatar
cbecker committed
272
               const char* result_filename) {
Guolin Ke's avatar
Guolin Ke committed
273
274
275
    std::lock_guard<std::mutex> lock(mutex_);
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
276
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
277
278
279
280
    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;
281
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
282
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
283
284
285
    } else {
      is_raw_score = false;
    }
Guolin Ke's avatar
Guolin Ke committed
286
    Predictor predictor(boosting_.get(), num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
287
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin);
Guolin Ke's avatar
Guolin Ke committed
288
289
    bool bool_data_has_header = data_has_header > 0 ? true : false;
    predictor.Predict(data_filename, result_filename, bool_data_has_header);
Guolin Ke's avatar
Guolin Ke committed
290
291
  }

Guolin Ke's avatar
Guolin Ke committed
292
  void GetPredictAt(int data_idx, double* out_result, int64_t* out_len) {
wxchan's avatar
wxchan committed
293
294
295
    boosting_->GetPredictAt(data_idx, out_result, out_len);
  }

296
297
  void SaveModelToFile(int start_iteration, int num_iteration, const char* filename) {
    boosting_->SaveModelToFile(start_iteration, num_iteration, filename);
Guolin Ke's avatar
Guolin Ke committed
298
  }
299

300
  void LoadModelFromString(const char* model_str) {
301
302
    size_t len = std::strlen(model_str);
    boosting_->LoadModelFromString(model_str, len);
303
304
  }

305
306
  std::string SaveModelToString(int start_iteration, int num_iteration) {
    return boosting_->SaveModelToString(start_iteration, num_iteration);
307
308
  }

309
  std::string DumpModel(int start_iteration, int num_iteration) {
310
    return boosting_->DumpModel(start_iteration, num_iteration);
wxchan's avatar
wxchan committed
311
  }
312

313
314
315
316
  std::vector<double> FeatureImportance(int num_iteration, int importance_type) {
    return boosting_->FeatureImportance(num_iteration, importance_type);
  }

Guolin Ke's avatar
Guolin Ke committed
317
  double GetLeafValue(int tree_idx, int leaf_idx) const {
Guolin Ke's avatar
Guolin Ke committed
318
    return dynamic_cast<GBDTBase*>(boosting_.get())->GetLeafValue(tree_idx, leaf_idx);
Guolin Ke's avatar
Guolin Ke committed
319
320
321
322
  }

  void SetLeafValue(int tree_idx, int leaf_idx, double val) {
    std::lock_guard<std::mutex> lock(mutex_);
Guolin Ke's avatar
Guolin Ke committed
323
    dynamic_cast<GBDTBase*>(boosting_.get())->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
324
325
  }

326
  void ShuffleModels(int start_iter, int end_iter) {
327
    std::lock_guard<std::mutex> lock(mutex_);
328
    boosting_->ShuffleModels(start_iter, end_iter);
329
330
  }

wxchan's avatar
wxchan committed
331
332
333
334
335
336
337
  int GetEvalCounts() const {
    int ret = 0;
    for (const auto& metric : train_metric_) {
      ret += static_cast<int>(metric->GetName().size());
    }
    return ret;
  }
338

wxchan's avatar
wxchan committed
339
340
341
342
  int GetEvalNames(char** out_strs) const {
    int idx = 0;
    for (const auto& metric : train_metric_) {
      for (const auto& name : metric->GetName()) {
Guolin Ke's avatar
Guolin Ke committed
343
        std::memcpy(out_strs[idx], name.c_str(), name.size() + 1);
wxchan's avatar
wxchan committed
344
345
346
347
348
349
        ++idx;
      }
    }
    return idx;
  }

wxchan's avatar
wxchan committed
350
351
352
  int GetFeatureNames(char** out_strs) const {
    int idx = 0;
    for (const auto& name : boosting_->FeatureNames()) {
Guolin Ke's avatar
Guolin Ke committed
353
      std::memcpy(out_strs[idx], name.c_str(), name.size() + 1);
wxchan's avatar
wxchan committed
354
355
356
357
358
      ++idx;
    }
    return idx;
  }

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

Nikita Titov's avatar
Nikita Titov committed
361
 private:
wxchan's avatar
wxchan committed
362
  const Dataset* train_data_;
Guolin Ke's avatar
Guolin Ke committed
363
  std::unique_ptr<Boosting> boosting_;
364
365
366
367
  std::unique_ptr<Predictor> single_row_predictor_;
  PredictFunction single_row_predict_function_;
  int64_t single_row_num_pred_in_one_row_;

Guolin Ke's avatar
Guolin Ke committed
368
  /*! \brief All configs */
Guolin Ke's avatar
Guolin Ke committed
369
  Config config_;
Guolin Ke's avatar
Guolin Ke committed
370
  /*! \brief Metric for training data */
Guolin Ke's avatar
Guolin Ke committed
371
  std::vector<std::unique_ptr<Metric>> train_metric_;
Guolin Ke's avatar
Guolin Ke committed
372
  /*! \brief Metrics for validation data */
Guolin Ke's avatar
Guolin Ke committed
373
  std::vector<std::vector<std::unique_ptr<Metric>>> valid_metrics_;
Guolin Ke's avatar
Guolin Ke committed
374
  /*! \brief Training objective function */
Guolin Ke's avatar
Guolin Ke committed
375
  std::unique_ptr<ObjectiveFunction> objective_fun_;
wxchan's avatar
wxchan committed
376
377
  /*! \brief mutex for threading safe call */
  std::mutex mutex_;
Guolin Ke's avatar
Guolin Ke committed
378
379
};

380
}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
381
382
383

using namespace LightGBM;

Guolin Ke's avatar
Guolin Ke committed
384
385
386
387
388
389
390
391
392
393
// 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);

std::function<std::vector<std::pair<int, double>>(int idx)>
RowFunctionFromCSR(const void* indptr, int indptr_type, const int32_t* indices,
394
                   const void* data, int data_type, int64_t nindptr, int64_t nelem);
Guolin Ke's avatar
Guolin Ke committed
395
396
397

// Row iterator of on column for CSC matrix
class CSC_RowIterator {
Nikita Titov's avatar
Nikita Titov committed
398
 public:
Guolin Ke's avatar
Guolin Ke committed
399
  CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
400
                  const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx);
Guolin Ke's avatar
Guolin Ke committed
401
402
403
404
405
  ~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
406
407

 private:
Guolin Ke's avatar
Guolin Ke committed
408
409
410
411
412
413
414
415
416
  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
417
const char* LGBM_GetLastError() {
wxchan's avatar
wxchan committed
418
  return LastErrorMsg();
Guolin Ke's avatar
Guolin Ke committed
419
420
}

Guolin Ke's avatar
Guolin Ke committed
421
int LGBM_DatasetCreateFromFile(const char* filename,
422
423
424
                               const char* parameters,
                               const DatasetHandle reference,
                               DatasetHandle* out) {
425
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
426
427
  auto param = Config::Str2Map(parameters);
  Config config;
428
429
430
431
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
432
  DatasetLoader loader(config, nullptr, 1, filename);
Guolin Ke's avatar
Guolin Ke committed
433
  if (reference == nullptr) {
434
435
436
437
438
    if (Network::num_machines() == 1) {
      *out = loader.LoadFromFile(filename, "");
    } else {
      *out = loader.LoadFromFile(filename, "", Network::rank(), Network::num_machines());
    }
Guolin Ke's avatar
Guolin Ke committed
439
  } else {
440
    *out = loader.LoadFromFileAlignWithOtherDataset(filename, "",
441
                                                    reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
442
  }
443
  API_END();
Guolin Ke's avatar
Guolin Ke committed
444
445
}

446

Guolin Ke's avatar
Guolin Ke committed
447
int LGBM_DatasetCreateFromSampledColumn(double** sample_data,
448
449
450
451
452
453
454
                                        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) {
455
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
456
457
  auto param = Config::Str2Map(parameters);
  Config config;
458
459
460
461
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
462
  DatasetLoader loader(config, nullptr, 1, nullptr);
463
464
465
466
  *out = loader.CostructFromSampleData(sample_data, sample_indices, ncol, num_per_col,
                                       num_sample_row,
                                       static_cast<data_size_t>(num_total_row));
  API_END();
Guolin Ke's avatar
Guolin Ke committed
467
468
}

469

Guolin Ke's avatar
Guolin Ke committed
470
int LGBM_DatasetCreateByReference(const DatasetHandle reference,
471
472
                                  int64_t num_total_row,
                                  DatasetHandle* out) {
Guolin Ke's avatar
Guolin Ke committed
473
474
475
476
477
478
479
480
  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
481
int LGBM_DatasetPushRows(DatasetHandle dataset,
482
483
484
485
486
                         const void* data,
                         int data_type,
                         int32_t nrow,
                         int32_t ncol,
                         int32_t start_row) {
Guolin Ke's avatar
Guolin Ke committed
487
488
489
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, 1);
490
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
491
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
492
  for (int i = 0; i < nrow; ++i) {
493
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
494
495
496
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(tid, start_row + i, one_row);
497
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
498
  }
499
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
500
501
502
503
504
505
  if (start_row + nrow == p_dataset->num_data()) {
    p_dataset->FinishLoad();
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
506
int LGBM_DatasetPushRowsByCSR(DatasetHandle dataset,
507
508
509
510
511
512
513
514
515
                              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
516
517
518
519
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
520
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
521
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
522
  for (int i = 0; i < nrow; ++i) {
523
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
524
525
526
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(tid,
527
                          static_cast<data_size_t>(start_row + i), one_row);
528
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
529
  }
530
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
531
532
533
534
535
536
  if (start_row + nrow == static_cast<int64_t>(p_dataset->num_data())) {
    p_dataset->FinishLoad();
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
537
int LGBM_DatasetCreateFromMat(const void* data,
538
539
540
541
542
543
544
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
  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) {
566
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
567
568
  auto param = Config::Str2Map(parameters);
  Config config;
569
570
571
572
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
573
  std::unique_ptr<Dataset> ret;
574
575
576
577
578
579
580
581
582
  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));
  }
583

Guolin Ke's avatar
Guolin Ke committed
584
585
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
586
    Random rand(config.data_random_seed);
587
588
    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);
589
    sample_cnt = static_cast<int>(sample_indices.size());
590
    std::vector<std::vector<double>> sample_values(ncol);
Guolin Ke's avatar
Guolin Ke committed
591
    std::vector<std::vector<int>> sample_idx(ncol);
592
593
594

    int offset = 0;
    int j = 0;
Guolin Ke's avatar
Guolin Ke committed
595
    for (size_t i = 0; i < sample_indices.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
596
      auto idx = sample_indices[i];
597
598
599
600
      while ((idx - offset) >= nrow[j]) {
        offset += nrow[j];
        ++j;
      }
601

602
603
604
605
606
      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
607
        }
Guolin Ke's avatar
Guolin Ke committed
608
609
      }
    }
Guolin Ke's avatar
Guolin Ke committed
610
    DatasetLoader loader(config, nullptr, 1, nullptr);
Guolin Ke's avatar
Guolin Ke committed
611
612
    ret.reset(loader.CostructFromSampleData(Common::Vector2Ptr<double>(sample_values).data(),
                                            Common::Vector2Ptr<int>(sample_idx).data(),
613
614
                                            static_cast<int>(sample_values.size()),
                                            Common::VectorSize<double>(sample_values).data(),
615
                                            sample_cnt, total_nrow));
Guolin Ke's avatar
Guolin Ke committed
616
  } else {
617
    ret.reset(new Dataset(total_nrow));
Guolin Ke's avatar
Guolin Ke committed
618
    ret->CreateValid(
619
      reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
620
  }
621
622
623
624
625
626
627
628
629
630
631
632
633
634
  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
635
636
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
637
  *out = ret.release();
638
  API_END();
639
640
}

Guolin Ke's avatar
Guolin Ke committed
641
int LGBM_DatasetCreateFromCSR(const void* indptr,
642
643
644
645
646
647
648
649
650
651
                              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) {
652
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
653
654
  auto param = Config::Str2Map(parameters);
  Config config;
655
656
657
658
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
659
  std::unique_ptr<Dataset> ret;
660
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
661
662
663
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
664
665
    Random rand(config.data_random_seed);
    int sample_cnt = static_cast<int>(nrow < config.bin_construct_sample_cnt ? nrow : config.bin_construct_sample_cnt);
666
    auto sample_indices = rand.Sample(nrow, sample_cnt);
667
    sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
668
669
    std::vector<std::vector<double>> sample_values(num_col);
    std::vector<std::vector<int>> sample_idx(num_col);
670
671
672
673
    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) {
Guolin Ke's avatar
Guolin Ke committed
674
        CHECK(inner_data.first < num_col);
Guolin Ke's avatar
Guolin Ke committed
675
        if (std::fabs(inner_data.second) > kZeroThreshold || std::isnan(inner_data.second)) {
Guolin Ke's avatar
Guolin Ke committed
676
677
          sample_values[inner_data.first].emplace_back(inner_data.second);
          sample_idx[inner_data.first].emplace_back(static_cast<int>(i));
678
679
680
        }
      }
    }
Guolin Ke's avatar
Guolin Ke committed
681
    DatasetLoader loader(config, nullptr, 1, nullptr);
Guolin Ke's avatar
Guolin Ke committed
682
683
    ret.reset(loader.CostructFromSampleData(Common::Vector2Ptr<double>(sample_values).data(),
                                            Common::Vector2Ptr<int>(sample_idx).data(),
684
685
686
                                            static_cast<int>(sample_values.size()),
                                            Common::VectorSize<double>(sample_values).data(),
                                            sample_cnt, nrow));
687
  } else {
688
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
689
    ret->CreateValid(
690
      reinterpret_cast<const Dataset*>(reference));
691
  }
692
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
693
  #pragma omp parallel for schedule(static)
694
  for (int i = 0; i < nindptr - 1; ++i) {
695
    OMP_LOOP_EX_BEGIN();
696
697
698
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    ret->PushOneRow(tid, i, one_row);
699
    OMP_LOOP_EX_END();
700
  }
701
  OMP_THROW_EX();
702
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
703
  *out = ret.release();
704
  API_END();
705
706
}

707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
int LGBM_DatasetCreateFromCSRFunc(void* get_row_funptr,
                              int num_rows,
                              int64_t num_col,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {

  API_BEGIN();

  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) {
        CHECK(inner_data.first < num_col);
        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);
    ret.reset(loader.CostructFromSampleData(Common::Vector2Ptr<double>(sample_values).data(),
                                            Common::Vector2Ptr<int>(sample_idx).data(),
                                            static_cast<int>(sample_values.size()),
                                            Common::VectorSize<double>(sample_values).data(),
                                            sample_cnt, nrow));
  } else {
    ret.reset(new Dataset(nrow));
    ret->CreateValid(
      reinterpret_cast<const Dataset*>(reference));
  }
  
  OMP_INIT_EX();
  std::vector<std::pair<int, double>> threadBuffer;
  #pragma omp parallel for schedule(static) private(threadBuffer)
  for (int i = 0; i < num_rows; ++i) {
    OMP_LOOP_EX_BEGIN();
    {
            const int tid = omp_get_thread_num();
            get_row_fun(i, threadBuffer);

            ret->PushOneRow(tid, i, threadBuffer);
    }
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();
  ret->FinishLoad();
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
778
int LGBM_DatasetCreateFromCSC(const void* col_ptr,
779
780
781
782
783
784
785
786
787
788
                              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) {
789
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
790
791
  auto param = Config::Str2Map(parameters);
  Config config;
792
793
794
795
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
796
  std::unique_ptr<Dataset> ret;
Guolin Ke's avatar
Guolin Ke committed
797
798
799
  int32_t nrow = static_cast<int32_t>(num_row);
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
800
801
    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
802
    auto sample_indices = rand.Sample(nrow, sample_cnt);
803
    sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
804
    std::vector<std::vector<double>> sample_values(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
805
    std::vector<std::vector<int>> sample_idx(ncol_ptr - 1);
806
    OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
807
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
808
    for (int i = 0; i < static_cast<int>(sample_values.size()); ++i) {
809
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
810
811
812
      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
813
        if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
Guolin Ke's avatar
Guolin Ke committed
814
815
          sample_values[i].emplace_back(val);
          sample_idx[i].emplace_back(j);
Guolin Ke's avatar
Guolin Ke committed
816
817
        }
      }
818
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
819
    }
820
    OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
821
    DatasetLoader loader(config, nullptr, 1, nullptr);
Guolin Ke's avatar
Guolin Ke committed
822
823
    ret.reset(loader.CostructFromSampleData(Common::Vector2Ptr<double>(sample_values).data(),
                                            Common::Vector2Ptr<int>(sample_idx).data(),
824
825
826
                                            static_cast<int>(sample_values.size()),
                                            Common::VectorSize<double>(sample_values).data(),
                                            sample_cnt, nrow));
Guolin Ke's avatar
Guolin Ke committed
827
  } else {
828
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
829
    ret->CreateValid(
830
      reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
831
  }
832
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
833
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
834
  for (int i = 0; i < ncol_ptr - 1; ++i) {
835
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
836
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
837
    int feature_idx = ret->InnerFeatureIndex(i);
Guolin Ke's avatar
Guolin Ke committed
838
    if (feature_idx < 0) { continue; }
Guolin Ke's avatar
Guolin Ke committed
839
840
    int group = ret->Feature2Group(feature_idx);
    int sub_feature = ret->Feture2SubFeature(feature_idx);
Guolin Ke's avatar
Guolin Ke committed
841
842
843
844
845
846
847
    CSC_RowIterator col_it(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, i);
    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; }
Guolin Ke's avatar
Guolin Ke committed
848
      ret->PushOneData(tid, row_idx, group, sub_feature, pair.second);
Guolin Ke's avatar
Guolin Ke committed
849
    }
850
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
851
  }
852
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
853
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
854
  *out = ret.release();
855
  API_END();
Guolin Ke's avatar
Guolin Ke committed
856
857
}

Guolin Ke's avatar
Guolin Ke committed
858
int LGBM_DatasetGetSubset(
859
  const DatasetHandle handle,
wxchan's avatar
wxchan committed
860
861
862
  const int32_t* used_row_indices,
  int32_t num_used_row_indices,
  const char* parameters,
Guolin Ke's avatar
typo  
Guolin Ke committed
863
  DatasetHandle* out) {
wxchan's avatar
wxchan committed
864
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
865
866
  auto param = Config::Str2Map(parameters);
  Config config;
867
868
869
870
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
871
  auto full_dataset = reinterpret_cast<const Dataset*>(handle);
Guolin Ke's avatar
Guolin Ke committed
872
  CHECK(num_used_row_indices > 0);
873
874
875
  const int32_t lower = 0;
  const int32_t upper = full_dataset->num_data() - 1;
  Common::CheckElementsIntervalClosed(used_row_indices, lower, upper, num_used_row_indices, "Used indices of subset");
Guolin Ke's avatar
Guolin Ke committed
876
  auto ret = std::unique_ptr<Dataset>(new Dataset(num_used_row_indices));
877
  ret->CopyFeatureMapperFrom(full_dataset);
Guolin Ke's avatar
Guolin Ke committed
878
  ret->CopySubset(full_dataset, used_row_indices, num_used_row_indices, true);
wxchan's avatar
wxchan committed
879
880
881
882
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
883
int LGBM_DatasetSetFeatureNames(
Guolin Ke's avatar
typo  
Guolin Ke committed
884
  DatasetHandle handle,
Guolin Ke's avatar
Guolin Ke committed
885
  const char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
886
  int num_feature_names) {
Guolin Ke's avatar
Guolin Ke committed
887
888
889
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  std::vector<std::string> feature_names_str;
Guolin Ke's avatar
Guolin Ke committed
890
  for (int i = 0; i < num_feature_names; ++i) {
Guolin Ke's avatar
Guolin Ke committed
891
892
893
894
895
896
    feature_names_str.emplace_back(feature_names[i]);
  }
  dataset->set_feature_names(feature_names_str);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
897
int LGBM_DatasetGetFeatureNames(
898
899
  DatasetHandle handle,
  char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
900
  int* num_feature_names) {
901
902
903
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  auto inside_feature_name = dataset->feature_names();
Guolin Ke's avatar
Guolin Ke committed
904
905
  *num_feature_names = static_cast<int>(inside_feature_name.size());
  for (int i = 0; i < *num_feature_names; ++i) {
Guolin Ke's avatar
Guolin Ke committed
906
    std::memcpy(feature_names[i], inside_feature_name[i].c_str(), inside_feature_name[i].size() + 1);
907
908
909
910
  }
  API_END();
}

911
#pragma warning(disable : 4702)
Guolin Ke's avatar
Guolin Ke committed
912
int LGBM_DatasetFree(DatasetHandle handle) {
913
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
914
  delete reinterpret_cast<Dataset*>(handle);
915
  API_END();
916
917
}

Guolin Ke's avatar
Guolin Ke committed
918
int LGBM_DatasetSaveBinary(DatasetHandle handle,
919
                           const char* filename) {
920
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
921
922
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->SaveBinaryFile(filename);
923
  API_END();
924
925
}

926
927
928
929
930
931
932
933
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
934
int LGBM_DatasetSetField(DatasetHandle handle,
935
936
937
938
                         const char* field_name,
                         const void* field_data,
                         int num_element,
                         int type) {
939
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
940
  auto dataset = reinterpret_cast<Dataset*>(handle);
941
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
942
  if (type == C_API_DTYPE_FLOAT32) {
Guolin Ke's avatar
Guolin Ke committed
943
    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
944
  } else if (type == C_API_DTYPE_INT32) {
Guolin Ke's avatar
Guolin Ke committed
945
    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
946
947
  } 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));
948
  }
949
  if (!is_success) { throw std::runtime_error("Input data type error or field not found"); }
950
  API_END();
951
952
}

Guolin Ke's avatar
Guolin Ke committed
953
int LGBM_DatasetGetField(DatasetHandle handle,
954
955
956
957
                         const char* field_name,
                         int* out_len,
                         const void** out_ptr,
                         int* out_type) {
958
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
959
  auto dataset = reinterpret_cast<Dataset*>(handle);
960
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
961
  if (dataset->GetFloatField(field_name, out_len, reinterpret_cast<const float**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
962
    *out_type = C_API_DTYPE_FLOAT32;
963
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
964
  } else if (dataset->GetIntField(field_name, out_len, reinterpret_cast<const int**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
965
    *out_type = C_API_DTYPE_INT32;
966
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
967
968
969
  } else if (dataset->GetDoubleField(field_name, out_len, reinterpret_cast<const double**>(out_ptr))) {
    *out_type = C_API_DTYPE_FLOAT64;
    is_success = true;
970
971
972
  } else if(dataset->GetInt8Field(field_name, out_len, reinterpret_cast<const int8_t**>(out_ptr))){
    *out_type = C_API_DTYPE_INT8;
    is_success = true;
973
  }
974
  if (!is_success) { throw std::runtime_error("Field not found"); }
wxchan's avatar
wxchan committed
975
  if (*out_ptr == nullptr) { *out_len = 0; }
976
  API_END();
977
978
}

979
980
981
982
983
984
985
int LGBM_DatasetUpdateParam(DatasetHandle handle, const char* parameters) {
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->ResetConfig(parameters);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
986
int LGBM_DatasetGetNumData(DatasetHandle handle,
987
                           int* out) {
988
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
989
990
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_data();
991
  API_END();
992
993
}

Guolin Ke's avatar
Guolin Ke committed
994
int LGBM_DatasetGetNumFeature(DatasetHandle handle,
995
                              int* out) {
996
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
997
998
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_total_features();
999
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1000
}
1001

1002
1003
1004
1005
1006
1007
1008
1009
1010
int LGBM_DatasetAddFeaturesFrom(DatasetHandle target,
                                DatasetHandle source) {
  API_BEGIN();
  auto target_d = reinterpret_cast<Dataset*>(target);
  auto source_d = reinterpret_cast<Dataset*>(source);
  target_d->addFeaturesFrom(source_d);
  API_END();
}

1011
1012
// ---- start of booster

Guolin Ke's avatar
Guolin Ke committed
1013
int LGBM_BoosterCreate(const DatasetHandle train_data,
1014
1015
                       const char* parameters,
                       BoosterHandle* out) {
1016
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1017
  const Dataset* p_train_data = reinterpret_cast<const Dataset*>(train_data);
wxchan's avatar
wxchan committed
1018
1019
  auto ret = std::unique_ptr<Booster>(new Booster(p_train_data, parameters));
  *out = ret.release();
1020
  API_END();
1021
1022
}

Guolin Ke's avatar
Guolin Ke committed
1023
int LGBM_BoosterCreateFromModelfile(
1024
  const char* filename,
Guolin Ke's avatar
Guolin Ke committed
1025
  int* out_num_iterations,
1026
  BoosterHandle* out) {
1027
  API_BEGIN();
wxchan's avatar
wxchan committed
1028
  auto ret = std::unique_ptr<Booster>(new Booster(filename));
Guolin Ke's avatar
Guolin Ke committed
1029
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
wxchan's avatar
wxchan committed
1030
  *out = ret.release();
1031
  API_END();
1032
1033
}

Guolin Ke's avatar
Guolin Ke committed
1034
int LGBM_BoosterLoadModelFromString(
1035
1036
1037
1038
  const char* model_str,
  int* out_num_iterations,
  BoosterHandle* out) {
  API_BEGIN();
wxchan's avatar
wxchan committed
1039
  auto ret = std::unique_ptr<Booster>(new Booster(nullptr));
1040
1041
1042
1043
1044
1045
  ret->LoadModelFromString(model_str);
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
  *out = ret.release();
  API_END();
}

1046
#pragma warning(disable : 4702)
Guolin Ke's avatar
Guolin Ke committed
1047
int LGBM_BoosterFree(BoosterHandle handle) {
1048
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1049
  delete reinterpret_cast<Booster*>(handle);
1050
  API_END();
1051
1052
}

1053
int LGBM_BoosterShuffleModels(BoosterHandle handle, int start_iter, int end_iter) {
1054
1055
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1056
  ref_booster->ShuffleModels(start_iter, end_iter);
1057
1058
1059
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1060
int LGBM_BoosterMerge(BoosterHandle handle,
1061
                      BoosterHandle other_handle) {
wxchan's avatar
wxchan committed
1062
1063
1064
1065
1066
1067
1068
  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
1069
int LGBM_BoosterAddValidData(BoosterHandle handle,
1070
                             const DatasetHandle valid_data) {
wxchan's avatar
wxchan committed
1071
1072
1073
1074
1075
1076
1077
  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
1078
int LGBM_BoosterResetTrainingData(BoosterHandle handle,
1079
                                  const DatasetHandle train_data) {
wxchan's avatar
wxchan committed
1080
1081
1082
1083
1084
1085
1086
  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
1087
int LGBM_BoosterResetParameter(BoosterHandle handle, const char* parameters) {
wxchan's avatar
wxchan committed
1088
1089
1090
1091
1092
1093
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->ResetConfig(parameters);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1094
int LGBM_BoosterGetNumClasses(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1095
1096
1097
1098
1099
1100
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->NumberOfClasses();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1101
1102
1103
1104
1105
1106
1107
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
1108
int LGBM_BoosterUpdateOneIter(BoosterHandle handle, int* is_finished) {
1109
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1110
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1111
1112
1113
1114
1115
  if (ref_booster->TrainOneIter()) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
1116
  API_END();
1117
1118
}

Guolin Ke's avatar
Guolin Ke committed
1119
int LGBM_BoosterUpdateOneIterCustom(BoosterHandle handle,
1120
1121
1122
                                    const float* grad,
                                    const float* hess,
                                    int* is_finished) {
1123
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1124
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1125
  #ifdef SCORE_T_USE_DOUBLE
1126
  Log::Fatal("Don't support custom loss function when SCORE_T_USE_DOUBLE is enabled");
1127
  #else
1128
1129
1130
1131
1132
  if (ref_booster->TrainOneIter(grad, hess)) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
1133
  #endif
1134
  API_END();
1135
1136
}

Guolin Ke's avatar
Guolin Ke committed
1137
int LGBM_BoosterRollbackOneIter(BoosterHandle handle) {
wxchan's avatar
wxchan committed
1138
1139
1140
1141
1142
1143
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->RollbackOneIter();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1144
int LGBM_BoosterGetCurrentIteration(BoosterHandle handle, int* out_iteration) {
wxchan's avatar
wxchan committed
1145
1146
1147
1148
1149
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_iteration = ref_booster->GetBoosting()->GetCurrentIteration();
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
1150

1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
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
1165
int LGBM_BoosterGetEvalCounts(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1166
1167
1168
1169
1170
1171
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalCounts();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1172
int LGBM_BoosterGetEvalNames(BoosterHandle handle, int* out_len, char** out_strs) {
wxchan's avatar
wxchan committed
1173
1174
1175
1176
1177
1178
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalNames(out_strs);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1179
int LGBM_BoosterGetFeatureNames(BoosterHandle handle, int* out_len, char** out_strs) {
wxchan's avatar
wxchan committed
1180
1181
1182
1183
1184
1185
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetFeatureNames(out_strs);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1186
int LGBM_BoosterGetNumFeature(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1187
1188
1189
1190
1191
1192
  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
1193
int LGBM_BoosterGetEval(BoosterHandle handle,
1194
1195
1196
                        int data_idx,
                        int* out_len,
                        double* out_results) {
1197
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1198
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1199
  auto boosting = ref_booster->GetBoosting();
wxchan's avatar
wxchan committed
1200
  auto result_buf = boosting->GetEvalAt(data_idx);
Guolin Ke's avatar
Guolin Ke committed
1201
  *out_len = static_cast<int>(result_buf.size());
1202
  for (size_t i = 0; i < result_buf.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
1203
    (out_results)[i] = static_cast<double>(result_buf[i]);
1204
  }
1205
  API_END();
1206
1207
}

Guolin Ke's avatar
Guolin Ke committed
1208
int LGBM_BoosterGetNumPredict(BoosterHandle handle,
1209
1210
                              int data_idx,
                              int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
1211
1212
1213
1214
1215
1216
  API_BEGIN();
  auto boosting = reinterpret_cast<Booster*>(handle)->GetBoosting();
  *out_len = boosting->GetNumPredictAt(data_idx);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1217
int LGBM_BoosterGetPredict(BoosterHandle handle,
1218
1219
1220
                           int data_idx,
                           int64_t* out_len,
                           double* out_result) {
1221
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1222
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1223
  ref_booster->GetPredictAt(data_idx, out_result, out_len);
1224
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1225
1226
}

Guolin Ke's avatar
Guolin Ke committed
1227
int LGBM_BoosterPredictForFile(BoosterHandle handle,
1228
1229
1230
1231
                               const char* data_filename,
                               int data_has_header,
                               int predict_type,
                               int num_iteration,
1232
                               const char* parameter,
1233
                               const char* result_filename) {
1234
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1235
1236
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1237
1238
1239
1240
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1241
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
cbecker's avatar
cbecker committed
1242
  ref_booster->Predict(num_iteration, predict_type, data_filename, data_has_header,
Guolin Ke's avatar
Guolin Ke committed
1243
                       config, result_filename);
1244
  API_END();
1245
1246
}

Guolin Ke's avatar
Guolin Ke committed
1247
int LGBM_BoosterCalcNumPredict(BoosterHandle handle,
1248
1249
1250
1251
                               int num_row,
                               int predict_type,
                               int num_iteration,
                               int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
1252
1253
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1254
1255
  *out_len = static_cast<int64_t>(num_row) * ref_booster->GetBoosting()->NumPredictOneRow(
    num_iteration, predict_type == C_API_PREDICT_LEAF_INDEX, predict_type == C_API_PREDICT_CONTRIB);
Guolin Ke's avatar
Guolin Ke committed
1256
1257
1258
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1259
int LGBM_BoosterPredictForCSR(BoosterHandle handle,
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
                              const void* indptr,
                              int indptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t nindptr,
                              int64_t nelem,
                              int64_t,
                              int predict_type,
                              int num_iteration,
1270
                              const char* parameter,
1271
1272
                              int64_t* out_len,
                              double* out_result) {
1273
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1274
1275
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1276
1277
1278
1279
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1280
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1281
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
1282
  int nrow = static_cast<int>(nindptr - 1);
cbecker's avatar
cbecker committed
1283
  ref_booster->Predict(num_iteration, predict_type, nrow, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
1284
                       config, out_result, out_len);
1285
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1286
}
1287

1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
int LGBM_BoosterPredictForCSRSingleRow(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,
                              int predict_type,
                              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 = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
  ref_booster->PredictSingleRow(num_iteration, predict_type, get_row_fun,
                       config, out_result, out_len);
  API_END();
}


Guolin Ke's avatar
Guolin Ke committed
1317
int LGBM_BoosterPredictForCSC(BoosterHandle handle,
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
                              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,
                              int num_iteration,
1328
                              const char* parameter,
1329
1330
                              int64_t* out_len,
                              double* out_result) {
Guolin Ke's avatar
Guolin Ke committed
1331
1332
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1333
1334
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
  int num_threads = 1;
  #pragma omp parallel
  #pragma omp master
  {
    num_threads = omp_get_num_threads();
  }
Guolin Ke's avatar
Guolin Ke committed
1345
  int ncol = static_cast<int>(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
1346
1347
1348
1349
1350
  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
1351
1352
  }
  std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun =
1353
    [&iterators, ncol] (int i) {
Guolin Ke's avatar
Guolin Ke committed
1354
    std::vector<std::pair<int, double>> one_row;
Guolin Ke's avatar
Guolin Ke committed
1355
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1356
    for (int j = 0; j < ncol; ++j) {
Guolin Ke's avatar
Guolin Ke committed
1357
      auto val = iterators[tid][j].Get(i);
Guolin Ke's avatar
Guolin Ke committed
1358
      if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
Guolin Ke's avatar
Guolin Ke committed
1359
        one_row.emplace_back(j, val);
Guolin Ke's avatar
Guolin Ke committed
1360
1361
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1362
1363
    return one_row;
  };
Guolin Ke's avatar
Guolin Ke committed
1364
  ref_booster->Predict(num_iteration, predict_type, static_cast<int>(num_row), get_row_fun, config,
cbecker's avatar
cbecker committed
1365
                       out_result, out_len);
Guolin Ke's avatar
Guolin Ke committed
1366
1367
1368
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1369
int LGBM_BoosterPredictForMat(BoosterHandle handle,
1370
1371
1372
1373
1374
1375
1376
                              const void* data,
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              int predict_type,
                              int num_iteration,
1377
                              const char* parameter,
1378
1379
                              int64_t* out_len,
                              double* out_result) {
1380
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1381
1382
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1383
1384
1385
1386
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1387
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1388
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
cbecker's avatar
cbecker committed
1389
  ref_booster->Predict(num_iteration, predict_type, nrow, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
1390
                       config, out_result, out_len);
1391
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1392
}
1393

1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
int LGBM_BoosterPredictForMatSingleRow(BoosterHandle handle,
                              const void* data,
                              int data_type,
                              int32_t ncol,
                              int is_row_major,
                              int predict_type,
                              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 = RowPairFunctionFromDenseMatric(data, 1, ncol, data_type, is_row_major);
  ref_booster->PredictSingleRow(num_iteration, predict_type, get_row_fun,
                       config, out_result, out_len);
  API_END();
}


Guolin Ke's avatar
Guolin Ke committed
1419
int LGBM_BoosterSaveModel(BoosterHandle handle,
1420
                          int start_iteration,
1421
1422
                          int num_iteration,
                          const char* filename) {
1423
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1424
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1425
  ref_booster->SaveModelToFile(start_iteration, num_iteration, filename);
wxchan's avatar
wxchan committed
1426
1427
1428
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1429
int LGBM_BoosterSaveModelToString(BoosterHandle handle,
1430
                                  int start_iteration,
1431
                                  int num_iteration,
1432
                                  int64_t buffer_len,
1433
                                  int64_t* out_len,
1434
                                  char* out_str) {
1435
1436
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1437
  std::string model = ref_booster->SaveModelToString(start_iteration, num_iteration);
1438
  *out_len = static_cast<int64_t>(model.size()) + 1;
1439
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
1440
    std::memcpy(out_str, model.c_str(), *out_len);
1441
1442
1443
1444
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1445
int LGBM_BoosterDumpModel(BoosterHandle handle,
1446
                          int start_iteration,
1447
                          int num_iteration,
1448
1449
                          int64_t buffer_len,
                          int64_t* out_len,
1450
                          char* out_str) {
wxchan's avatar
wxchan committed
1451
1452
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1453
  std::string model = ref_booster->DumpModel(start_iteration, num_iteration);
1454
  *out_len = static_cast<int64_t>(model.size()) + 1;
wxchan's avatar
wxchan committed
1455
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
1456
    std::memcpy(out_str, model.c_str(), *out_len);
wxchan's avatar
wxchan committed
1457
  }
1458
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1459
}
1460

Guolin Ke's avatar
Guolin Ke committed
1461
int LGBM_BoosterGetLeafValue(BoosterHandle handle,
1462
1463
1464
                             int tree_idx,
                             int leaf_idx,
                             double* out_val) {
Guolin Ke's avatar
Guolin Ke committed
1465
1466
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1467
  *out_val = static_cast<double>(ref_booster->GetLeafValue(tree_idx, leaf_idx));
Guolin Ke's avatar
Guolin Ke committed
1468
1469
1470
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1471
int LGBM_BoosterSetLeafValue(BoosterHandle handle,
1472
1473
1474
                             int tree_idx,
                             int leaf_idx,
                             double val) {
Guolin Ke's avatar
Guolin Ke committed
1475
1476
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1477
  ref_booster->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
1478
1479
1480
  API_END();
}

1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
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();
}

1494
1495
1496
1497
1498
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
1499
  Config config;
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
  config.machines = Common::RemoveQuotationSymbol(std::string(machines));
  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();
}

1516
1517
1518
int LGBM_NetworkInitWithFunctions(int num_machines, int rank,
                                  void* reduce_scatter_ext_fun,
                                  void* allgather_ext_fun) {
ww's avatar
ww committed
1519
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1520
  if (num_machines > 1) {
1521
    Network::Init(num_machines, rank, (ReduceScatterFunction)reduce_scatter_ext_fun, (AllgatherFunction)allgather_ext_fun);
ww's avatar
ww committed
1522
1523
1524
  }
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
1525

Guolin Ke's avatar
Guolin Ke committed
1526
// ---- start of some help functions
1527
1528
1529

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
1530
  if (data_type == C_API_DTYPE_FLOAT32) {
1531
1532
    const float* data_ptr = reinterpret_cast<const float*>(data);
    if (is_row_major) {
1533
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1534
        std::vector<double> ret(num_col);
1535
        auto tmp_ptr = data_ptr + static_cast<size_t>(num_col) * row_idx;
1536
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1537
          ret[i] = static_cast<double>(*(tmp_ptr + i));
1538
1539
1540
1541
        }
        return ret;
      };
    } else {
1542
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1543
        std::vector<double> ret(num_col);
1544
        for (int i = 0; i < num_col; ++i) {
1545
          ret[i] = static_cast<double>(*(data_ptr + static_cast<size_t>(num_row) * i + row_idx));
1546
1547
1548
1549
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
1550
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1551
1552
    const double* data_ptr = reinterpret_cast<const double*>(data);
    if (is_row_major) {
1553
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1554
        std::vector<double> ret(num_col);
1555
        auto tmp_ptr = data_ptr + static_cast<size_t>(num_col) * row_idx;
1556
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1557
          ret[i] = static_cast<double>(*(tmp_ptr + i));
1558
1559
1560
1561
        }
        return ret;
      };
    } else {
1562
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1563
        std::vector<double> ret(num_col);
1564
        for (int i = 0; i < num_col; ++i) {
1565
          ret[i] = static_cast<double>(*(data_ptr + static_cast<size_t>(num_row) * i + row_idx));
1566
1567
1568
1569
1570
        }
        return ret;
      };
    }
  }
1571
  throw std::runtime_error("Unknown data type in RowFunctionFromDenseMatric");
1572
1573
1574
1575
}

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
1576
1577
  auto inner_function = RowFunctionFromDenseMatric(data, num_row, num_col, data_type, is_row_major);
  if (inner_function != nullptr) {
1578
    return [inner_function] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1579
1580
1581
      auto raw_values = inner_function(row_idx);
      std::vector<std::pair<int, double>> ret;
      for (int i = 0; i < static_cast<int>(raw_values.size()); ++i) {
Guolin Ke's avatar
Guolin Ke committed
1582
        if (std::fabs(raw_values[i]) > kZeroThreshold || std::isnan(raw_values[i])) {
Guolin Ke's avatar
Guolin Ke committed
1583
          ret.emplace_back(i, raw_values[i]);
1584
        }
Guolin Ke's avatar
Guolin Ke committed
1585
1586
1587
      }
      return ret;
    };
1588
  }
Guolin Ke's avatar
Guolin Ke committed
1589
  return nullptr;
1590
1591
1592
}

std::function<std::vector<std::pair<int, double>>(int idx)>
1593
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
1594
  if (data_type == C_API_DTYPE_FLOAT32) {
1595
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
1596
    if (indptr_type == C_API_DTYPE_INT32) {
1597
      const int32_t* ptr_indptr = reinterpret_cast<const int32_t*>(indptr);
1598
      return [=] (int idx) {
1599
1600
1601
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1602
1603
1604
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1605
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1606
          ret.emplace_back(indices[i], data_ptr[i]);
1607
1608
1609
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1610
    } else if (indptr_type == C_API_DTYPE_INT64) {
1611
      const int64_t* ptr_indptr = reinterpret_cast<const int64_t*>(indptr);
1612
      return [=] (int idx) {
1613
1614
1615
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1616
1617
1618
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1619
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1620
          ret.emplace_back(indices[i], data_ptr[i]);
1621
1622
1623
1624
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
1625
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1626
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
1627
    if (indptr_type == C_API_DTYPE_INT32) {
1628
      const int32_t* ptr_indptr = reinterpret_cast<const int32_t*>(indptr);
1629
      return [=] (int idx) {
1630
1631
1632
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1633
1634
1635
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1636
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1637
          ret.emplace_back(indices[i], data_ptr[i]);
1638
1639
1640
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1641
    } else if (indptr_type == C_API_DTYPE_INT64) {
1642
      const int64_t* ptr_indptr = reinterpret_cast<const int64_t*>(indptr);
1643
      return [=] (int idx) {
1644
1645
1646
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1647
1648
1649
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1650
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1651
          ret.emplace_back(indices[i], data_ptr[i]);
1652
1653
1654
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1655
1656
    }
  }
1657
  throw std::runtime_error("Unknown data type in RowFunctionFromCSR");
1658
1659
}

Guolin Ke's avatar
Guolin Ke committed
1660
std::function<std::pair<int, double>(int idx)>
1661
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
1662
  CHECK(col_idx < ncol_ptr && col_idx >= 0);
Guolin Ke's avatar
Guolin Ke committed
1663
  if (data_type == C_API_DTYPE_FLOAT32) {
1664
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
1665
    if (col_ptr_type == C_API_DTYPE_INT32) {
1666
      const int32_t* ptr_col_ptr = reinterpret_cast<const int32_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1667
1668
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1669
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1670
1671
1672
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1673
        }
Guolin Ke's avatar
Guolin Ke committed
1674
1675
1676
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1677
      };
Guolin Ke's avatar
Guolin Ke committed
1678
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
1679
      const int64_t* ptr_col_ptr = reinterpret_cast<const int64_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1680
1681
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1682
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1683
1684
1685
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1686
        }
Guolin Ke's avatar
Guolin Ke committed
1687
1688
1689
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1690
      };
Guolin Ke's avatar
Guolin Ke committed
1691
    }
Guolin Ke's avatar
Guolin Ke committed
1692
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1693
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
1694
    if (col_ptr_type == C_API_DTYPE_INT32) {
1695
      const int32_t* ptr_col_ptr = reinterpret_cast<const int32_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1696
1697
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1698
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1699
1700
1701
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1702
        }
Guolin Ke's avatar
Guolin Ke committed
1703
1704
1705
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1706
      };
Guolin Ke's avatar
Guolin Ke committed
1707
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
1708
      const int64_t* ptr_col_ptr = reinterpret_cast<const int64_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1709
1710
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1711
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1712
1713
1714
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1715
        }
Guolin Ke's avatar
Guolin Ke committed
1716
1717
1718
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1719
      };
Guolin Ke's avatar
Guolin Ke committed
1720
1721
    }
  }
1722
  throw std::runtime_error("Unknown data type in CSC matrix");
1723
1724
}

Guolin Ke's avatar
Guolin Ke committed
1725
CSC_RowIterator::CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
1726
                                 const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx) {
Guolin Ke's avatar
Guolin Ke committed
1727
1728
1729
1730
1731
1732
1733
1734
1735
  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;
1736
    }
Guolin Ke's avatar
Guolin Ke committed
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
    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;
1754
    }
Guolin Ke's avatar
Guolin Ke committed
1755
1756
1757
    return ret;
  } else {
    return std::make_pair(-1, 0.0);
1758
  }
Guolin Ke's avatar
Guolin Ke committed
1759
}