c_api.cpp 55.1 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
46
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
47
48
class Booster {
public:
Guolin Ke's avatar
Guolin Ke committed
49
  explicit Booster(const char* filename) {
50
    boosting_.reset(Boosting::CreateBoosting("gbdt", filename));
51
52
  }

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

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

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

wxchan's avatar
wxchan committed
81
82
83
84
85
  }

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

  ~Booster() {
Guolin Ke's avatar
Guolin Ke committed
89

Guolin Ke's avatar
Guolin Ke committed
90
  }
91

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

  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
125
126
127
  }

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

    config_.Set(param);
141
142
143
    if (config_.num_threads > 0) {
      omp_set_num_threads(config_.num_threads);
    }
Guolin Ke's avatar
Guolin Ke committed
144
145
146

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

Guolin Ke's avatar
Guolin Ke committed
160
    boosting_->ResetConfig(&config_);
Guolin Ke's avatar
Guolin Ke committed
161

wxchan's avatar
wxchan committed
162
163
164
165
166
  }

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

178
  bool TrainOneIter() {
wxchan's avatar
wxchan committed
179
    std::lock_guard<std::mutex> lock(mutex_);
Guolin Ke's avatar
Guolin Ke committed
180
    return boosting_->TrainOneIter(nullptr, nullptr);
181
182
  }

Guolin Ke's avatar
Guolin Ke committed
183
184
185
186
187
188
189
190
191
192
193
  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);
  }

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

wxchan's avatar
wxchan committed
199
200
201
202
203
  void RollbackOneIter() {
    std::lock_guard<std::mutex> lock(mutex_);
    boosting_->RollbackOneIter();
  }

Guolin Ke's avatar
Guolin Ke committed
204
205
  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
206
               const Config& config,
Guolin Ke's avatar
Guolin Ke committed
207
               double* out_result, int64_t* out_len) {
wxchan's avatar
wxchan committed
208
    std::lock_guard<std::mutex> lock(mutex_);
Guolin Ke's avatar
Guolin Ke committed
209
210
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
211
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
212
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
Guolin Ke's avatar
Guolin Ke committed
213
      is_predict_leaf = true;
Guolin Ke's avatar
Guolin Ke committed
214
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
Guolin Ke's avatar
Guolin Ke committed
215
      is_raw_score = true;
216
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
217
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
218
219
    } else {
      is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
220
    }
Guolin Ke's avatar
Guolin Ke committed
221

Guolin Ke's avatar
Guolin Ke committed
222
    Predictor predictor(boosting_.get(), num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
223
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin);
Guolin Ke's avatar
Guolin Ke committed
224
    int64_t num_pred_in_one_row = boosting_->NumPredictOneRow(num_iteration, is_predict_leaf, predict_contrib);
Guolin Ke's avatar
Guolin Ke committed
225
    auto pred_fun = predictor.GetPredictFunction();
226
227
    OMP_INIT_EX();
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
228
    for (int i = 0; i < nrow; ++i) {
229
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
230
      auto one_row = get_row_fun(i);
Tony-Y's avatar
Tony-Y committed
231
      auto pred_wrt_ptr = out_result + static_cast<size_t>(num_pred_in_one_row) * i;
Guolin Ke's avatar
Guolin Ke committed
232
      pred_fun(one_row, pred_wrt_ptr);
233
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
234
    }
235
    OMP_THROW_EX();
236
    *out_len = num_pred_in_one_row * nrow;
Guolin Ke's avatar
Guolin Ke committed
237
238
239
  }

  void Predict(int num_iteration, int predict_type, const char* data_filename,
Guolin Ke's avatar
Guolin Ke committed
240
               int data_has_header, const Config& config,
cbecker's avatar
cbecker committed
241
               const char* result_filename) {
Guolin Ke's avatar
Guolin Ke committed
242
243
244
    std::lock_guard<std::mutex> lock(mutex_);
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
245
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
246
247
248
249
    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;
250
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
251
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
252
253
254
    } else {
      is_raw_score = false;
    }
Guolin Ke's avatar
Guolin Ke committed
255
    Predictor predictor(boosting_.get(), num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
256
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin);
Guolin Ke's avatar
Guolin Ke committed
257
258
    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
259
260
  }

Guolin Ke's avatar
Guolin Ke committed
261
  void GetPredictAt(int data_idx, double* out_result, int64_t* out_len) {
wxchan's avatar
wxchan committed
262
263
264
    boosting_->GetPredictAt(data_idx, out_result, out_len);
  }

265
266
  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
267
  }
268

269
  void LoadModelFromString(const char* model_str) {
270
271
    size_t len = std::strlen(model_str);
    boosting_->LoadModelFromString(model_str, len);
272
273
  }

274
275
  std::string SaveModelToString(int start_iteration, int num_iteration) {
    return boosting_->SaveModelToString(start_iteration, num_iteration);
276
277
  }

278
279
  std::string DumpModel(int start_iteration,int num_iteration) {
    return boosting_->DumpModel(start_iteration, num_iteration);
wxchan's avatar
wxchan committed
280
  }
281

282
283
284
285
  std::vector<double> FeatureImportance(int num_iteration, int importance_type) {
    return boosting_->FeatureImportance(num_iteration, importance_type);
  }

Guolin Ke's avatar
Guolin Ke committed
286
  double GetLeafValue(int tree_idx, int leaf_idx) const {
Guolin Ke's avatar
Guolin Ke committed
287
    return dynamic_cast<GBDTBase*>(boosting_.get())->GetLeafValue(tree_idx, leaf_idx);
Guolin Ke's avatar
Guolin Ke committed
288
289
290
291
  }

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

295
  void ShuffleModels(int start_iter, int end_iter) {
296
    std::lock_guard<std::mutex> lock(mutex_);
297
    boosting_->ShuffleModels(start_iter, end_iter);
298
299
  }

wxchan's avatar
wxchan committed
300
301
302
303
304
305
306
  int GetEvalCounts() const {
    int ret = 0;
    for (const auto& metric : train_metric_) {
      ret += static_cast<int>(metric->GetName().size());
    }
    return ret;
  }
307

wxchan's avatar
wxchan committed
308
309
310
311
  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
312
        std::memcpy(out_strs[idx], name.c_str(), name.size() + 1);
wxchan's avatar
wxchan committed
313
314
315
316
317
318
        ++idx;
      }
    }
    return idx;
  }

wxchan's avatar
wxchan committed
319
320
321
  int GetFeatureNames(char** out_strs) const {
    int idx = 0;
    for (const auto& name : boosting_->FeatureNames()) {
Guolin Ke's avatar
Guolin Ke committed
322
      std::memcpy(out_strs[idx], name.c_str(), name.size() + 1);
wxchan's avatar
wxchan committed
323
324
325
326
327
      ++idx;
    }
    return idx;
  }

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

Guolin Ke's avatar
Guolin Ke committed
330
private:
331

wxchan's avatar
wxchan committed
332
  const Dataset* train_data_;
Guolin Ke's avatar
Guolin Ke committed
333
  std::unique_ptr<Boosting> boosting_;
Guolin Ke's avatar
Guolin Ke committed
334
  /*! \brief All configs */
Guolin Ke's avatar
Guolin Ke committed
335
  Config config_;
Guolin Ke's avatar
Guolin Ke committed
336
  /*! \brief Metric for training data */
Guolin Ke's avatar
Guolin Ke committed
337
  std::vector<std::unique_ptr<Metric>> train_metric_;
Guolin Ke's avatar
Guolin Ke committed
338
  /*! \brief Metrics for validation data */
Guolin Ke's avatar
Guolin Ke committed
339
  std::vector<std::vector<std::unique_ptr<Metric>>> valid_metrics_;
Guolin Ke's avatar
Guolin Ke committed
340
  /*! \brief Training objective function */
Guolin Ke's avatar
Guolin Ke committed
341
  std::unique_ptr<ObjectiveFunction> objective_fun_;
wxchan's avatar
wxchan committed
342
343
  /*! \brief mutex for threading safe call */
  std::mutex mutex_;
Guolin Ke's avatar
Guolin Ke committed
344
345
346
};

}
Guolin Ke's avatar
Guolin Ke committed
347
348
349

using namespace LightGBM;

Guolin Ke's avatar
Guolin Ke committed
350
351
352
353
354
355
356
357
358
359
// 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,
360
                   const void* data, int data_type, int64_t nindptr, int64_t nelem);
Guolin Ke's avatar
Guolin Ke committed
361
362
363
364
365

// Row iterator of on column for CSC matrix
class CSC_RowIterator {
public:
  CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
366
                  const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx);
Guolin Ke's avatar
Guolin Ke committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
  ~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();
private:
  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
382
const char* LGBM_GetLastError() {
wxchan's avatar
wxchan committed
383
  return LastErrorMsg();
Guolin Ke's avatar
Guolin Ke committed
384
385
}

Guolin Ke's avatar
Guolin Ke committed
386
int LGBM_DatasetCreateFromFile(const char* filename,
387
388
389
                               const char* parameters,
                               const DatasetHandle reference,
                               DatasetHandle* out) {
390
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
391
392
  auto param = Config::Str2Map(parameters);
  Config config;
393
394
395
396
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
397
  DatasetLoader loader(config,nullptr, 1, filename);
Guolin Ke's avatar
Guolin Ke committed
398
  if (reference == nullptr) {
399
400
401
402
403
    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
404
  } else {
405
    *out = loader.LoadFromFileAlignWithOtherDataset(filename, "",
406
                                                    reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
407
  }
408
  API_END();
Guolin Ke's avatar
Guolin Ke committed
409
410
}

411

Guolin Ke's avatar
Guolin Ke committed
412
int LGBM_DatasetCreateFromSampledColumn(double** sample_data,
413
414
415
416
417
418
419
                                        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) {
420
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
421
422
  auto param = Config::Str2Map(parameters);
  Config config;
423
424
425
426
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
427
  DatasetLoader loader(config, nullptr, 1, nullptr);
428
429
430
431
  *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
432
433
}

434

Guolin Ke's avatar
Guolin Ke committed
435
int LGBM_DatasetCreateByReference(const DatasetHandle reference,
436
437
                                  int64_t num_total_row,
                                  DatasetHandle* out) {
Guolin Ke's avatar
Guolin Ke committed
438
439
440
441
442
443
444
445
  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
446
int LGBM_DatasetPushRows(DatasetHandle dataset,
447
448
449
450
451
                         const void* data,
                         int data_type,
                         int32_t nrow,
                         int32_t ncol,
                         int32_t start_row) {
Guolin Ke's avatar
Guolin Ke committed
452
453
454
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, 1);
455
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
456
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
457
  for (int i = 0; i < nrow; ++i) {
458
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
459
460
461
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(tid, start_row + i, one_row);
462
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
463
  }
464
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
465
466
467
468
469
470
  if (start_row + nrow == p_dataset->num_data()) {
    p_dataset->FinishLoad();
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
471
int LGBM_DatasetPushRowsByCSR(DatasetHandle dataset,
472
473
474
475
476
477
478
479
480
                              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
481
482
483
484
  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);
485
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
486
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
487
  for (int i = 0; i < nrow; ++i) {
488
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
489
490
491
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(tid,
492
                          static_cast<data_size_t>(start_row + i), one_row);
493
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
494
  }
495
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
496
497
498
499
500
501
  if (start_row + nrow == static_cast<int64_t>(p_dataset->num_data())) {
    p_dataset->FinishLoad();
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
502
int LGBM_DatasetCreateFromMat(const void* data,
503
504
505
506
507
508
509
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
  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) {
531
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
532
533
  auto param = Config::Str2Map(parameters);
  Config config;
534
535
536
537
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
538
  std::unique_ptr<Dataset> ret;
539
540
541
542
543
544
545
546
547
548
  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));
  }
  
Guolin Ke's avatar
Guolin Ke committed
549
550
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
551
    Random rand(config.data_random_seed);
552
553
    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);
554
    sample_cnt = static_cast<int>(sample_indices.size());
555
    std::vector<std::vector<double>> sample_values(ncol);
Guolin Ke's avatar
Guolin Ke committed
556
    std::vector<std::vector<int>> sample_idx(ncol);
557
558
559

    int offset = 0;
    int j = 0;
Guolin Ke's avatar
Guolin Ke committed
560
    for (size_t i = 0; i < sample_indices.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
561
      auto idx = sample_indices[i];
562
563
564
565
566
567
568
569
570
571
      while ((idx - offset) >= nrow[j]) {
        offset += nrow[j];
        ++j;
      }
      
      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
572
        }
Guolin Ke's avatar
Guolin Ke committed
573
574
      }
    }
Guolin Ke's avatar
Guolin Ke committed
575
    DatasetLoader loader(config, nullptr, 1, nullptr);
Guolin Ke's avatar
Guolin Ke committed
576
577
    ret.reset(loader.CostructFromSampleData(Common::Vector2Ptr<double>(sample_values).data(),
                                            Common::Vector2Ptr<int>(sample_idx).data(),
578
579
                                            static_cast<int>(sample_values.size()),
                                            Common::VectorSize<double>(sample_values).data(),
580
                                            sample_cnt, total_nrow));
Guolin Ke's avatar
Guolin Ke committed
581
  } else {
582
    ret.reset(new Dataset(total_nrow));
Guolin Ke's avatar
Guolin Ke committed
583
    ret->CreateValid(
584
      reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
585
  }
586
587
588
589
590
591
592
593
594
595
596
597
598
599
  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
600
601
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
602
  *out = ret.release();
603
  API_END();
604
605
}

Guolin Ke's avatar
Guolin Ke committed
606
int LGBM_DatasetCreateFromCSR(const void* indptr,
607
608
609
610
611
612
613
614
615
616
                              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) {
617
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
618
619
  auto param = Config::Str2Map(parameters);
  Config config;
620
621
622
623
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
624
  std::unique_ptr<Dataset> ret;
625
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
626
627
628
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
629
630
    Random rand(config.data_random_seed);
    int sample_cnt = static_cast<int>(nrow < config.bin_construct_sample_cnt ? nrow : config.bin_construct_sample_cnt);
631
    auto sample_indices = rand.Sample(nrow, sample_cnt);
632
    sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
633
634
    std::vector<std::vector<double>> sample_values(num_col);
    std::vector<std::vector<int>> sample_idx(num_col);
635
636
637
638
    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
639
        CHECK(inner_data.first < num_col);
Guolin Ke's avatar
Guolin Ke committed
640
        if (std::fabs(inner_data.second) > kZeroThreshold || std::isnan(inner_data.second)) {
Guolin Ke's avatar
Guolin Ke committed
641
642
          sample_values[inner_data.first].emplace_back(inner_data.second);
          sample_idx[inner_data.first].emplace_back(static_cast<int>(i));
643
644
645
        }
      }
    }
Guolin Ke's avatar
Guolin Ke committed
646
    DatasetLoader loader(config, nullptr, 1, nullptr);
Guolin Ke's avatar
Guolin Ke committed
647
648
    ret.reset(loader.CostructFromSampleData(Common::Vector2Ptr<double>(sample_values).data(),
                                            Common::Vector2Ptr<int>(sample_idx).data(),
649
650
651
                                            static_cast<int>(sample_values.size()),
                                            Common::VectorSize<double>(sample_values).data(),
                                            sample_cnt, nrow));
652
  } else {
653
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
654
    ret->CreateValid(
655
      reinterpret_cast<const Dataset*>(reference));
656
  }
657
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
658
  #pragma omp parallel for schedule(static)
659
  for (int i = 0; i < nindptr - 1; ++i) {
660
    OMP_LOOP_EX_BEGIN();
661
662
663
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    ret->PushOneRow(tid, i, one_row);
664
    OMP_LOOP_EX_END();
665
  }
666
  OMP_THROW_EX();
667
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
668
  *out = ret.release();
669
  API_END();
670
671
}

Guolin Ke's avatar
Guolin Ke committed
672
int LGBM_DatasetCreateFromCSC(const void* col_ptr,
673
674
675
676
677
678
679
680
681
682
                              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) {
683
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
684
685
  auto param = Config::Str2Map(parameters);
  Config config;
686
687
688
689
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
690
  std::unique_ptr<Dataset> ret;
Guolin Ke's avatar
Guolin Ke committed
691
692
693
  int32_t nrow = static_cast<int32_t>(num_row);
  if (reference == nullptr) {
    // sample data first
Guolin Ke's avatar
Guolin Ke committed
694
695
    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
696
    auto sample_indices = rand.Sample(nrow, sample_cnt);
697
    sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
698
    std::vector<std::vector<double>> sample_values(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
699
    std::vector<std::vector<int>> sample_idx(ncol_ptr - 1);
700
    OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
701
    #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
702
    for (int i = 0; i < static_cast<int>(sample_values.size()); ++i) {
703
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
704
705
706
      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
707
        if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
Guolin Ke's avatar
Guolin Ke committed
708
709
          sample_values[i].emplace_back(val);
          sample_idx[i].emplace_back(j);
Guolin Ke's avatar
Guolin Ke committed
710
711
        }
      }
712
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
713
    }
714
    OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
715
    DatasetLoader loader(config, nullptr, 1, nullptr);
Guolin Ke's avatar
Guolin Ke committed
716
717
    ret.reset(loader.CostructFromSampleData(Common::Vector2Ptr<double>(sample_values).data(),
                                            Common::Vector2Ptr<int>(sample_idx).data(),
718
719
720
                                            static_cast<int>(sample_values.size()),
                                            Common::VectorSize<double>(sample_values).data(),
                                            sample_cnt, nrow));
Guolin Ke's avatar
Guolin Ke committed
721
  } else {
722
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
723
    ret->CreateValid(
724
      reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
725
  }
726
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
727
  #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
728
  for (int i = 0; i < ncol_ptr - 1; ++i) {
729
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
730
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
731
    int feature_idx = ret->InnerFeatureIndex(i);
Guolin Ke's avatar
Guolin Ke committed
732
    if (feature_idx < 0) { continue; }
Guolin Ke's avatar
Guolin Ke committed
733
734
    int group = ret->Feature2Group(feature_idx);
    int sub_feature = ret->Feture2SubFeature(feature_idx);
Guolin Ke's avatar
Guolin Ke committed
735
736
737
738
739
740
741
    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
742
      ret->PushOneData(tid, row_idx, group, sub_feature, pair.second);
Guolin Ke's avatar
Guolin Ke committed
743
    }
744
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
745
  }
746
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
747
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
748
  *out = ret.release();
749
  API_END();
Guolin Ke's avatar
Guolin Ke committed
750
751
}

Guolin Ke's avatar
Guolin Ke committed
752
int LGBM_DatasetGetSubset(
753
  const DatasetHandle handle,
wxchan's avatar
wxchan committed
754
755
756
  const int32_t* used_row_indices,
  int32_t num_used_row_indices,
  const char* parameters,
Guolin Ke's avatar
typo  
Guolin Ke committed
757
  DatasetHandle* out) {
wxchan's avatar
wxchan committed
758
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
759
760
  auto param = Config::Str2Map(parameters);
  Config config;
761
762
763
764
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
765
  auto full_dataset = reinterpret_cast<const Dataset*>(handle);
Guolin Ke's avatar
Guolin Ke committed
766
  CHECK(num_used_row_indices > 0);
767
768
769
  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
770
  auto ret = std::unique_ptr<Dataset>(new Dataset(num_used_row_indices));
771
  ret->CopyFeatureMapperFrom(full_dataset);
Guolin Ke's avatar
Guolin Ke committed
772
  ret->CopySubset(full_dataset, used_row_indices, num_used_row_indices, true);
wxchan's avatar
wxchan committed
773
774
775
776
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
777
int LGBM_DatasetSetFeatureNames(
Guolin Ke's avatar
typo  
Guolin Ke committed
778
  DatasetHandle handle,
Guolin Ke's avatar
Guolin Ke committed
779
  const char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
780
  int num_feature_names) {
Guolin Ke's avatar
Guolin Ke committed
781
782
783
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  std::vector<std::string> feature_names_str;
Guolin Ke's avatar
Guolin Ke committed
784
  for (int i = 0; i < num_feature_names; ++i) {
Guolin Ke's avatar
Guolin Ke committed
785
786
787
788
789
790
    feature_names_str.emplace_back(feature_names[i]);
  }
  dataset->set_feature_names(feature_names_str);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
791
int LGBM_DatasetGetFeatureNames(
792
793
  DatasetHandle handle,
  char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
794
  int* num_feature_names) {
795
796
797
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  auto inside_feature_name = dataset->feature_names();
Guolin Ke's avatar
Guolin Ke committed
798
799
  *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
800
    std::memcpy(feature_names[i], inside_feature_name[i].c_str(), inside_feature_name[i].size() + 1);
801
802
803
804
  }
  API_END();
}

805
#pragma warning(disable : 4702)
Guolin Ke's avatar
Guolin Ke committed
806
int LGBM_DatasetFree(DatasetHandle handle) {
807
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
808
  delete reinterpret_cast<Dataset*>(handle);
809
  API_END();
810
811
}

Guolin Ke's avatar
Guolin Ke committed
812
int LGBM_DatasetSaveBinary(DatasetHandle handle,
813
                           const char* filename) {
814
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
815
816
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->SaveBinaryFile(filename);
817
  API_END();
818
819
}

Guolin Ke's avatar
Guolin Ke committed
820
int LGBM_DatasetSetField(DatasetHandle handle,
821
822
823
824
                         const char* field_name,
                         const void* field_data,
                         int num_element,
                         int type) {
825
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
826
  auto dataset = reinterpret_cast<Dataset*>(handle);
827
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
828
  if (type == C_API_DTYPE_FLOAT32) {
Guolin Ke's avatar
Guolin Ke committed
829
    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
830
  } else if (type == C_API_DTYPE_INT32) {
Guolin Ke's avatar
Guolin Ke committed
831
    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
832
833
  } 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));
834
  }
835
  if (!is_success) { throw std::runtime_error("Input data type error or field not found"); }
836
  API_END();
837
838
}

Guolin Ke's avatar
Guolin Ke committed
839
int LGBM_DatasetGetField(DatasetHandle handle,
840
841
842
843
                         const char* field_name,
                         int* out_len,
                         const void** out_ptr,
                         int* out_type) {
844
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
845
  auto dataset = reinterpret_cast<Dataset*>(handle);
846
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
847
  if (dataset->GetFloatField(field_name, out_len, reinterpret_cast<const float**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
848
    *out_type = C_API_DTYPE_FLOAT32;
849
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
850
  } else if (dataset->GetIntField(field_name, out_len, reinterpret_cast<const int**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
851
    *out_type = C_API_DTYPE_INT32;
852
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
853
854
855
  } else if (dataset->GetDoubleField(field_name, out_len, reinterpret_cast<const double**>(out_ptr))) {
    *out_type = C_API_DTYPE_FLOAT64;
    is_success = true;
856
  }
857
  if (!is_success) { throw std::runtime_error("Field not found"); }
wxchan's avatar
wxchan committed
858
  if (*out_ptr == nullptr) { *out_len = 0; }
859
  API_END();
860
861
}

862
863
864
865
866
867
868
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
869
int LGBM_DatasetGetNumData(DatasetHandle handle,
870
                           int* out) {
871
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
872
873
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_data();
874
  API_END();
875
876
}

Guolin Ke's avatar
Guolin Ke committed
877
int LGBM_DatasetGetNumFeature(DatasetHandle handle,
878
                              int* out) {
879
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
880
881
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_total_features();
882
  API_END();
Guolin Ke's avatar
Guolin Ke committed
883
}
884
885
886

// ---- start of booster

Guolin Ke's avatar
Guolin Ke committed
887
int LGBM_BoosterCreate(const DatasetHandle train_data,
888
889
                       const char* parameters,
                       BoosterHandle* out) {
890
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
891
  const Dataset* p_train_data = reinterpret_cast<const Dataset*>(train_data);
wxchan's avatar
wxchan committed
892
893
  auto ret = std::unique_ptr<Booster>(new Booster(p_train_data, parameters));
  *out = ret.release();
894
  API_END();
895
896
}

Guolin Ke's avatar
Guolin Ke committed
897
int LGBM_BoosterCreateFromModelfile(
898
  const char* filename,
Guolin Ke's avatar
Guolin Ke committed
899
  int* out_num_iterations,
900
  BoosterHandle* out) {
901
  API_BEGIN();
wxchan's avatar
wxchan committed
902
  auto ret = std::unique_ptr<Booster>(new Booster(filename));
Guolin Ke's avatar
Guolin Ke committed
903
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
wxchan's avatar
wxchan committed
904
  *out = ret.release();
905
  API_END();
906
907
}

Guolin Ke's avatar
Guolin Ke committed
908
int LGBM_BoosterLoadModelFromString(
909
910
911
912
  const char* model_str,
  int* out_num_iterations,
  BoosterHandle* out) {
  API_BEGIN();
wxchan's avatar
wxchan committed
913
  auto ret = std::unique_ptr<Booster>(new Booster(nullptr));
914
915
916
917
918
919
  ret->LoadModelFromString(model_str);
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
  *out = ret.release();
  API_END();
}

920
#pragma warning(disable : 4702)
Guolin Ke's avatar
Guolin Ke committed
921
int LGBM_BoosterFree(BoosterHandle handle) {
922
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
923
  delete reinterpret_cast<Booster*>(handle);
924
  API_END();
925
926
}

927
int LGBM_BoosterShuffleModels(BoosterHandle handle, int start_iter, int end_iter) {
928
929
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
930
  ref_booster->ShuffleModels(start_iter, end_iter);
931
932
933
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
934
int LGBM_BoosterMerge(BoosterHandle handle,
935
                      BoosterHandle other_handle) {
wxchan's avatar
wxchan committed
936
937
938
939
940
941
942
  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
943
int LGBM_BoosterAddValidData(BoosterHandle handle,
944
                             const DatasetHandle valid_data) {
wxchan's avatar
wxchan committed
945
946
947
948
949
950
951
  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
952
int LGBM_BoosterResetTrainingData(BoosterHandle handle,
953
                                  const DatasetHandle train_data) {
wxchan's avatar
wxchan committed
954
955
956
957
958
959
960
  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
961
int LGBM_BoosterResetParameter(BoosterHandle handle, const char* parameters) {
wxchan's avatar
wxchan committed
962
963
964
965
966
967
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->ResetConfig(parameters);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
968
int LGBM_BoosterGetNumClasses(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
969
970
971
972
973
974
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->NumberOfClasses();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
975
976
977
978
979
980
981
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
982
int LGBM_BoosterUpdateOneIter(BoosterHandle handle, int* is_finished) {
983
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
984
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
985
986
987
988
989
  if (ref_booster->TrainOneIter()) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
990
  API_END();
991
992
}

Guolin Ke's avatar
Guolin Ke committed
993
int LGBM_BoosterUpdateOneIterCustom(BoosterHandle handle,
994
995
996
                                    const float* grad,
                                    const float* hess,
                                    int* is_finished) {
997
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
998
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
999
  #ifdef SCORE_T_USE_DOUBLE
1000
  Log::Fatal("Don't support custom loss function when SCORE_T_USE_DOUBLE is enabled");
1001
  #else
1002
1003
1004
1005
1006
  if (ref_booster->TrainOneIter(grad, hess)) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
1007
  #endif
1008
  API_END();
1009
1010
}

Guolin Ke's avatar
Guolin Ke committed
1011
int LGBM_BoosterRollbackOneIter(BoosterHandle handle) {
wxchan's avatar
wxchan committed
1012
1013
1014
1015
1016
1017
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->RollbackOneIter();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1018
int LGBM_BoosterGetCurrentIteration(BoosterHandle handle, int* out_iteration) {
wxchan's avatar
wxchan committed
1019
1020
1021
1022
1023
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_iteration = ref_booster->GetBoosting()->GetCurrentIteration();
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
1024

1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
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
1039
int LGBM_BoosterGetEvalCounts(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1040
1041
1042
1043
1044
1045
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalCounts();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1046
int LGBM_BoosterGetEvalNames(BoosterHandle handle, int* out_len, char** out_strs) {
wxchan's avatar
wxchan committed
1047
1048
1049
1050
1051
1052
  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
1053
int LGBM_BoosterGetFeatureNames(BoosterHandle handle, int* out_len, char** out_strs) {
wxchan's avatar
wxchan committed
1054
1055
1056
1057
1058
1059
  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
1060
int LGBM_BoosterGetNumFeature(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1061
1062
1063
1064
1065
1066
  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
1067
int LGBM_BoosterGetEval(BoosterHandle handle,
1068
1069
1070
                        int data_idx,
                        int* out_len,
                        double* out_results) {
1071
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1072
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1073
  auto boosting = ref_booster->GetBoosting();
wxchan's avatar
wxchan committed
1074
  auto result_buf = boosting->GetEvalAt(data_idx);
Guolin Ke's avatar
Guolin Ke committed
1075
  *out_len = static_cast<int>(result_buf.size());
1076
  for (size_t i = 0; i < result_buf.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
1077
    (out_results)[i] = static_cast<double>(result_buf[i]);
1078
  }
1079
  API_END();
1080
1081
}

Guolin Ke's avatar
Guolin Ke committed
1082
int LGBM_BoosterGetNumPredict(BoosterHandle handle,
1083
1084
                              int data_idx,
                              int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
1085
1086
1087
1088
1089
1090
  API_BEGIN();
  auto boosting = reinterpret_cast<Booster*>(handle)->GetBoosting();
  *out_len = boosting->GetNumPredictAt(data_idx);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1091
int LGBM_BoosterGetPredict(BoosterHandle handle,
1092
1093
1094
                           int data_idx,
                           int64_t* out_len,
                           double* out_result) {
1095
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1096
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1097
  ref_booster->GetPredictAt(data_idx, out_result, out_len);
1098
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1099
1100
}

Guolin Ke's avatar
Guolin Ke committed
1101
int LGBM_BoosterPredictForFile(BoosterHandle handle,
1102
1103
1104
1105
                               const char* data_filename,
                               int data_has_header,
                               int predict_type,
                               int num_iteration,
1106
                               const char* parameter,
1107
                               const char* result_filename) {
1108
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1109
1110
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1111
1112
1113
1114
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1115
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
cbecker's avatar
cbecker committed
1116
  ref_booster->Predict(num_iteration, predict_type, data_filename, data_has_header,
Guolin Ke's avatar
Guolin Ke committed
1117
                       config, result_filename);
1118
  API_END();
1119
1120
}

Guolin Ke's avatar
Guolin Ke committed
1121
int LGBM_BoosterCalcNumPredict(BoosterHandle handle,
1122
1123
1124
1125
                               int num_row,
                               int predict_type,
                               int num_iteration,
                               int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
1126
1127
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1128
1129
  *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
1130
1131
1132
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1133
int LGBM_BoosterPredictForCSR(BoosterHandle handle,
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
                              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,
1144
                              const char* parameter,
1145
1146
                              int64_t* out_len,
                              double* out_result) {
1147
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1148
1149
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1150
1151
1152
1153
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1154
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1155
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
1156
  int nrow = static_cast<int>(nindptr - 1);
cbecker's avatar
cbecker committed
1157
  ref_booster->Predict(num_iteration, predict_type, nrow, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
1158
                       config, out_result, out_len);
1159
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1160
}
1161

Guolin Ke's avatar
Guolin Ke committed
1162
int LGBM_BoosterPredictForCSC(BoosterHandle handle,
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
                              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,
1173
                              const char* parameter,
1174
1175
                              int64_t* out_len,
                              double* out_result) {
Guolin Ke's avatar
Guolin Ke committed
1176
1177
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1178
1179
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
  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
1190
  int ncol = static_cast<int>(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
1191
1192
1193
1194
1195
  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
1196
1197
  }
  std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun =
1198
    [&iterators, ncol] (int i) {
Guolin Ke's avatar
Guolin Ke committed
1199
    std::vector<std::pair<int, double>> one_row;
Guolin Ke's avatar
Guolin Ke committed
1200
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1201
    for (int j = 0; j < ncol; ++j) {
Guolin Ke's avatar
Guolin Ke committed
1202
      auto val = iterators[tid][j].Get(i);
Guolin Ke's avatar
Guolin Ke committed
1203
      if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
Guolin Ke's avatar
Guolin Ke committed
1204
        one_row.emplace_back(j, val);
Guolin Ke's avatar
Guolin Ke committed
1205
1206
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1207
1208
    return one_row;
  };
Guolin Ke's avatar
Guolin Ke committed
1209
  ref_booster->Predict(num_iteration, predict_type, static_cast<int>(num_row), get_row_fun, config,
cbecker's avatar
cbecker committed
1210
                       out_result, out_len);
Guolin Ke's avatar
Guolin Ke committed
1211
1212
1213
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1214
int LGBM_BoosterPredictForMat(BoosterHandle handle,
1215
1216
1217
1218
1219
1220
1221
                              const void* data,
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              int predict_type,
                              int num_iteration,
1222
                              const char* parameter,
1223
1224
                              int64_t* out_len,
                              double* out_result) {
1225
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1226
1227
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1228
1229
1230
1231
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1232
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1233
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
cbecker's avatar
cbecker committed
1234
  ref_booster->Predict(num_iteration, predict_type, nrow, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
1235
                       config, out_result, out_len);
1236
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1237
}
1238

Guolin Ke's avatar
Guolin Ke committed
1239
int LGBM_BoosterSaveModel(BoosterHandle handle,
1240
                          int start_iteration,
1241
1242
                          int num_iteration,
                          const char* filename) {
1243
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1244
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1245
  ref_booster->SaveModelToFile(start_iteration, num_iteration, filename);
wxchan's avatar
wxchan committed
1246
1247
1248
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1249
int LGBM_BoosterSaveModelToString(BoosterHandle handle,
1250
                                  int start_iteration,
1251
                                  int num_iteration,
1252
1253
                                  int64_t buffer_len, 
                                  int64_t* out_len,
1254
                                  char* out_str) {
1255
1256
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1257
  std::string model = ref_booster->SaveModelToString(start_iteration, num_iteration);
1258
  *out_len = static_cast<int64_t>(model.size()) + 1;
1259
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
1260
    std::memcpy(out_str, model.c_str(), *out_len);
1261
1262
1263
1264
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1265
int LGBM_BoosterDumpModel(BoosterHandle handle,
1266
                          int start_iteration,
1267
                          int num_iteration,
1268
1269
                          int64_t buffer_len,
                          int64_t* out_len,
1270
                          char* out_str) {
wxchan's avatar
wxchan committed
1271
1272
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1273
  std::string model = ref_booster->DumpModel(start_iteration, num_iteration);
1274
  *out_len = static_cast<int64_t>(model.size()) + 1;
wxchan's avatar
wxchan committed
1275
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
1276
    std::memcpy(out_str, model.c_str(), *out_len);
wxchan's avatar
wxchan committed
1277
  }
1278
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1279
}
1280

Guolin Ke's avatar
Guolin Ke committed
1281
int LGBM_BoosterGetLeafValue(BoosterHandle handle,
1282
1283
1284
                             int tree_idx,
                             int leaf_idx,
                             double* out_val) {
Guolin Ke's avatar
Guolin Ke committed
1285
1286
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1287
  *out_val = static_cast<double>(ref_booster->GetLeafValue(tree_idx, leaf_idx));
Guolin Ke's avatar
Guolin Ke committed
1288
1289
1290
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1291
int LGBM_BoosterSetLeafValue(BoosterHandle handle,
1292
1293
1294
                             int tree_idx,
                             int leaf_idx,
                             double val) {
Guolin Ke's avatar
Guolin Ke committed
1295
1296
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1297
  ref_booster->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
1298
1299
1300
  API_END();
}

1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
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();
}

1314
1315
1316
1317
1318
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
1319
  Config config;
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
  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();
}

1336
1337
1338
int LGBM_NetworkInitWithFunctions(int num_machines, int rank,
                                  void* reduce_scatter_ext_fun,
                                  void* allgather_ext_fun) {
ww's avatar
ww committed
1339
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1340
  if (num_machines > 1) {
1341
    Network::Init(num_machines, rank, (ReduceScatterFunction)reduce_scatter_ext_fun, (AllgatherFunction)allgather_ext_fun);
ww's avatar
ww committed
1342
1343
1344
  }
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
1345

Guolin Ke's avatar
Guolin Ke committed
1346
// ---- start of some help functions
1347
1348
1349

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
1350
  if (data_type == C_API_DTYPE_FLOAT32) {
1351
1352
    const float* data_ptr = reinterpret_cast<const float*>(data);
    if (is_row_major) {
1353
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1354
        std::vector<double> ret(num_col);
1355
        auto tmp_ptr = data_ptr + static_cast<size_t>(num_col) * row_idx;
1356
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1357
          ret[i] = static_cast<double>(*(tmp_ptr + i));
1358
1359
1360
1361
        }
        return ret;
      };
    } else {
1362
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1363
        std::vector<double> ret(num_col);
1364
        for (int i = 0; i < num_col; ++i) {
1365
          ret[i] = static_cast<double>(*(data_ptr + static_cast<size_t>(num_row) * i + row_idx));
1366
1367
1368
1369
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
1370
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1371
1372
    const double* data_ptr = reinterpret_cast<const double*>(data);
    if (is_row_major) {
1373
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1374
        std::vector<double> ret(num_col);
1375
        auto tmp_ptr = data_ptr + static_cast<size_t>(num_col) * row_idx;
1376
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1377
          ret[i] = static_cast<double>(*(tmp_ptr + i));
1378
1379
1380
1381
        }
        return ret;
      };
    } else {
1382
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1383
        std::vector<double> ret(num_col);
1384
        for (int i = 0; i < num_col; ++i) {
1385
          ret[i] = static_cast<double>(*(data_ptr + static_cast<size_t>(num_row) * i + row_idx));
1386
1387
1388
1389
1390
        }
        return ret;
      };
    }
  }
1391
  throw std::runtime_error("Unknown data type in RowFunctionFromDenseMatric");
1392
1393
1394
1395
}

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
1396
1397
  auto inner_function = RowFunctionFromDenseMatric(data, num_row, num_col, data_type, is_row_major);
  if (inner_function != nullptr) {
1398
    return [inner_function] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1399
1400
1401
      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
1402
        if (std::fabs(raw_values[i]) > kZeroThreshold || std::isnan(raw_values[i])) {
Guolin Ke's avatar
Guolin Ke committed
1403
          ret.emplace_back(i, raw_values[i]);
1404
        }
Guolin Ke's avatar
Guolin Ke committed
1405
1406
1407
      }
      return ret;
    };
1408
  }
Guolin Ke's avatar
Guolin Ke committed
1409
  return nullptr;
1410
1411
1412
}

std::function<std::vector<std::pair<int, double>>(int idx)>
1413
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
1414
  if (data_type == C_API_DTYPE_FLOAT32) {
1415
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
1416
    if (indptr_type == C_API_DTYPE_INT32) {
1417
      const int32_t* ptr_indptr = reinterpret_cast<const int32_t*>(indptr);
1418
      return [=] (int idx) {
1419
1420
1421
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1422
1423
1424
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1425
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1426
          ret.emplace_back(indices[i], data_ptr[i]);
1427
1428
1429
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1430
    } else if (indptr_type == C_API_DTYPE_INT64) {
1431
      const int64_t* ptr_indptr = reinterpret_cast<const int64_t*>(indptr);
1432
      return [=] (int idx) {
1433
1434
1435
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1436
1437
1438
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1439
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1440
          ret.emplace_back(indices[i], data_ptr[i]);
1441
1442
1443
1444
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
1445
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1446
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
1447
    if (indptr_type == C_API_DTYPE_INT32) {
1448
      const int32_t* ptr_indptr = reinterpret_cast<const int32_t*>(indptr);
1449
      return [=] (int idx) {
1450
1451
1452
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1453
1454
1455
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1456
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1457
          ret.emplace_back(indices[i], data_ptr[i]);
1458
1459
1460
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1461
    } else if (indptr_type == C_API_DTYPE_INT64) {
1462
      const int64_t* ptr_indptr = reinterpret_cast<const int64_t*>(indptr);
1463
      return [=] (int idx) {
1464
1465
1466
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1467
1468
1469
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1470
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1471
          ret.emplace_back(indices[i], data_ptr[i]);
1472
1473
1474
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1475
1476
    }
  }
1477
  throw std::runtime_error("Unknown data type in RowFunctionFromCSR");
1478
1479
}

Guolin Ke's avatar
Guolin Ke committed
1480
std::function<std::pair<int, double>(int idx)>
1481
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
1482
  CHECK(col_idx < ncol_ptr && col_idx >= 0);
Guolin Ke's avatar
Guolin Ke committed
1483
  if (data_type == C_API_DTYPE_FLOAT32) {
1484
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
1485
    if (col_ptr_type == C_API_DTYPE_INT32) {
1486
      const int32_t* ptr_col_ptr = reinterpret_cast<const int32_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1487
1488
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1489
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1490
1491
1492
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1493
        }
Guolin Ke's avatar
Guolin Ke committed
1494
1495
1496
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1497
      };
Guolin Ke's avatar
Guolin Ke committed
1498
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
1499
      const int64_t* ptr_col_ptr = reinterpret_cast<const int64_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1500
1501
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1502
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1503
1504
1505
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1506
        }
Guolin Ke's avatar
Guolin Ke committed
1507
1508
1509
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1510
      };
Guolin Ke's avatar
Guolin Ke committed
1511
    }
Guolin Ke's avatar
Guolin Ke committed
1512
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1513
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
1514
    if (col_ptr_type == C_API_DTYPE_INT32) {
1515
      const int32_t* ptr_col_ptr = reinterpret_cast<const int32_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1516
1517
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1518
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1519
1520
1521
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1522
        }
Guolin Ke's avatar
Guolin Ke committed
1523
1524
1525
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1526
      };
Guolin Ke's avatar
Guolin Ke committed
1527
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
1528
      const int64_t* ptr_col_ptr = reinterpret_cast<const int64_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1529
1530
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1531
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1532
1533
1534
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1535
        }
Guolin Ke's avatar
Guolin Ke committed
1536
1537
1538
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1539
      };
Guolin Ke's avatar
Guolin Ke committed
1540
1541
    }
  }
1542
  throw std::runtime_error("Unknown data type in CSC matrix");
1543
1544
}

Guolin Ke's avatar
Guolin Ke committed
1545
CSC_RowIterator::CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
1546
                                 const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx) {
Guolin Ke's avatar
Guolin Ke committed
1547
1548
1549
1550
1551
1552
1553
1554
1555
  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;
1556
    }
Guolin Ke's avatar
Guolin Ke committed
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
    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;
1574
    }
Guolin Ke's avatar
Guolin Ke committed
1575
1576
1577
    return ret;
  } else {
    return std::make_pair(-1, 0.0);
1578
  }
Guolin Ke's avatar
Guolin Ke committed
1579
}