c_api.cpp 54.4 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
    CHECK(train_data->num_features() > 0);
Guolin Ke's avatar
Guolin Ke committed
56
    auto param = Config::Str2Map(parameters);
wxchan's avatar
wxchan committed
57
    config_.Set(param);
58
59
60
    if (config_.num_threads > 0) {
      omp_set_num_threads(config_.num_threads);
    }
Guolin Ke's avatar
Guolin Ke committed
61
    // create boosting
Guolin Ke's avatar
Guolin Ke committed
62
    if (config_.input_model.size() > 0) {
63
64
      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
65
    }
Guolin Ke's avatar
Guolin Ke committed
66

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

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

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

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

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

Guolin Ke's avatar
Guolin Ke committed
91
  }
92

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

  void ResetTrainingData(const Dataset* train_data) {
    if (train_data != train_data_) {
Guolin Ke's avatar
Guolin Ke committed
119
      CHECK(train_data->num_features() > 0);
120
121
122
123
124
125
126
      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
127
128
129
  }

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

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

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

Guolin Ke's avatar
Guolin Ke committed
162
    boosting_->ResetConfig(&config_);
Guolin Ke's avatar
Guolin Ke committed
163

wxchan's avatar
wxchan committed
164
165
166
167
168
  }

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

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

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

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

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

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

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

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

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

267
268
  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
269
  }
270

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

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

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

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

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

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

297
298
299
300
301
  void ShuffleModels() {
    std::lock_guard<std::mutex> lock(mutex_);
    boosting_->ShuffleModels();
  }

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

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

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

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

Guolin Ke's avatar
Guolin Ke committed
332
private:
333

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

}
Guolin Ke's avatar
Guolin Ke committed
349
350
351

using namespace LightGBM;

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

// 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,
368
                  const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx);
Guolin Ke's avatar
Guolin Ke committed
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
  ~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
384
const char* LGBM_GetLastError() {
wxchan's avatar
wxchan committed
385
  return LastErrorMsg();
Guolin Ke's avatar
Guolin Ke committed
386
387
}

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

413

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

436

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

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

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

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

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

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

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

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

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

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

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

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

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

Guolin Ke's avatar
Guolin Ke committed
864
int LGBM_DatasetGetNumData(DatasetHandle handle,
865
                           int* out) {
866
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
867
868
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_data();
869
  API_END();
870
871
}

Guolin Ke's avatar
Guolin Ke committed
872
int LGBM_DatasetGetNumFeature(DatasetHandle handle,
873
                              int* out) {
874
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
875
876
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_total_features();
877
  API_END();
Guolin Ke's avatar
Guolin Ke committed
878
}
879
880
881

// ---- start of booster

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

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

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

915
#pragma warning(disable : 4702)
Guolin Ke's avatar
Guolin Ke committed
916
int LGBM_BoosterFree(BoosterHandle handle) {
917
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
918
  delete reinterpret_cast<Booster*>(handle);
919
  API_END();
920
921
}

922
923
924
925
926
927
928
int LGBM_BoosterShuffleModels(BoosterHandle handle) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->ShuffleModels();
  API_END();
}

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

Guolin Ke's avatar
Guolin Ke committed
963
int LGBM_BoosterGetNumClasses(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
964
965
966
967
968
969
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->NumberOfClasses();
  API_END();
}

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

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

Guolin Ke's avatar
Guolin Ke committed
1006
int LGBM_BoosterRollbackOneIter(BoosterHandle handle) {
wxchan's avatar
wxchan committed
1007
1008
1009
1010
1011
1012
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->RollbackOneIter();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1013
int LGBM_BoosterGetCurrentIteration(BoosterHandle handle, int* out_iteration) {
wxchan's avatar
wxchan committed
1014
1015
1016
1017
1018
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_iteration = ref_booster->GetBoosting()->GetCurrentIteration();
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
1019

Guolin Ke's avatar
Guolin Ke committed
1020
int LGBM_BoosterGetEvalCounts(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1021
1022
1023
1024
1025
1026
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalCounts();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1027
int LGBM_BoosterGetEvalNames(BoosterHandle handle, int* out_len, char** out_strs) {
wxchan's avatar
wxchan committed
1028
1029
1030
1031
1032
1033
  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
1034
int LGBM_BoosterGetFeatureNames(BoosterHandle handle, int* out_len, char** out_strs) {
wxchan's avatar
wxchan committed
1035
1036
1037
1038
1039
1040
  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
1041
int LGBM_BoosterGetNumFeature(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
1042
1043
1044
1045
1046
1047
  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
1048
int LGBM_BoosterGetEval(BoosterHandle handle,
1049
1050
1051
                        int data_idx,
                        int* out_len,
                        double* out_results) {
1052
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1053
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1054
  auto boosting = ref_booster->GetBoosting();
wxchan's avatar
wxchan committed
1055
  auto result_buf = boosting->GetEvalAt(data_idx);
Guolin Ke's avatar
Guolin Ke committed
1056
  *out_len = static_cast<int>(result_buf.size());
1057
  for (size_t i = 0; i < result_buf.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
1058
    (out_results)[i] = static_cast<double>(result_buf[i]);
1059
  }
1060
  API_END();
1061
1062
}

Guolin Ke's avatar
Guolin Ke committed
1063
int LGBM_BoosterGetNumPredict(BoosterHandle handle,
1064
1065
                              int data_idx,
                              int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
1066
1067
1068
1069
1070
1071
  API_BEGIN();
  auto boosting = reinterpret_cast<Booster*>(handle)->GetBoosting();
  *out_len = boosting->GetNumPredictAt(data_idx);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1072
int LGBM_BoosterGetPredict(BoosterHandle handle,
1073
1074
1075
                           int data_idx,
                           int64_t* out_len,
                           double* out_result) {
1076
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1077
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1078
  ref_booster->GetPredictAt(data_idx, out_result, out_len);
1079
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1080
1081
}

Guolin Ke's avatar
Guolin Ke committed
1082
int LGBM_BoosterPredictForFile(BoosterHandle handle,
1083
1084
1085
1086
                               const char* data_filename,
                               int data_has_header,
                               int predict_type,
                               int num_iteration,
1087
                               const char* parameter,
1088
                               const char* result_filename) {
1089
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1090
1091
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1092
1093
1094
1095
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1096
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
cbecker's avatar
cbecker committed
1097
  ref_booster->Predict(num_iteration, predict_type, data_filename, data_has_header,
Guolin Ke's avatar
Guolin Ke committed
1098
                       config, result_filename);
1099
  API_END();
1100
1101
}

Guolin Ke's avatar
Guolin Ke committed
1102
int LGBM_BoosterCalcNumPredict(BoosterHandle handle,
1103
1104
1105
1106
                               int num_row,
                               int predict_type,
                               int num_iteration,
                               int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
1107
1108
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1109
1110
  *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
1111
1112
1113
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1114
int LGBM_BoosterPredictForCSR(BoosterHandle handle,
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
                              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,
1125
                              const char* parameter,
1126
1127
                              int64_t* out_len,
                              double* out_result) {
1128
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1129
1130
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1131
1132
1133
1134
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1135
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1136
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
1137
  int nrow = static_cast<int>(nindptr - 1);
cbecker's avatar
cbecker committed
1138
  ref_booster->Predict(num_iteration, predict_type, nrow, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
1139
                       config, out_result, out_len);
1140
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1141
}
1142

Guolin Ke's avatar
Guolin Ke committed
1143
int LGBM_BoosterPredictForCSC(BoosterHandle handle,
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
                              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,
1154
                              const char* parameter,
1155
1156
                              int64_t* out_len,
                              double* out_result) {
Guolin Ke's avatar
Guolin Ke committed
1157
1158
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1159
1160
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
  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
1171
  int ncol = static_cast<int>(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
1172
1173
1174
1175
1176
  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
1177
1178
  }
  std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun =
1179
    [&iterators, ncol] (int i) {
Guolin Ke's avatar
Guolin Ke committed
1180
    std::vector<std::pair<int, double>> one_row;
Guolin Ke's avatar
Guolin Ke committed
1181
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1182
    for (int j = 0; j < ncol; ++j) {
Guolin Ke's avatar
Guolin Ke committed
1183
      auto val = iterators[tid][j].Get(i);
Guolin Ke's avatar
Guolin Ke committed
1184
      if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
Guolin Ke's avatar
Guolin Ke committed
1185
        one_row.emplace_back(j, val);
Guolin Ke's avatar
Guolin Ke committed
1186
1187
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1188
1189
    return one_row;
  };
Guolin Ke's avatar
Guolin Ke committed
1190
  ref_booster->Predict(num_iteration, predict_type, static_cast<int>(num_row), get_row_fun, config,
cbecker's avatar
cbecker committed
1191
                       out_result, out_len);
Guolin Ke's avatar
Guolin Ke committed
1192
1193
1194
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1195
int LGBM_BoosterPredictForMat(BoosterHandle handle,
1196
1197
1198
1199
1200
1201
1202
                              const void* data,
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              int predict_type,
                              int num_iteration,
1203
                              const char* parameter,
1204
1205
                              int64_t* out_len,
                              double* out_result) {
1206
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1207
1208
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
1209
1210
1211
1212
  config.Set(param);
  if (config.num_threads > 0) {
    omp_set_num_threads(config.num_threads);
  }
Guolin Ke's avatar
Guolin Ke committed
1213
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1214
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
cbecker's avatar
cbecker committed
1215
  ref_booster->Predict(num_iteration, predict_type, nrow, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
1216
                       config, out_result, out_len);
1217
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1218
}
1219

Guolin Ke's avatar
Guolin Ke committed
1220
int LGBM_BoosterSaveModel(BoosterHandle handle,
1221
                          int start_iteration,
1222
1223
                          int num_iteration,
                          const char* filename) {
1224
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1225
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1226
  ref_booster->SaveModelToFile(start_iteration, num_iteration, filename);
wxchan's avatar
wxchan committed
1227
1228
1229
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1230
int LGBM_BoosterSaveModelToString(BoosterHandle handle,
1231
                                  int start_iteration,
1232
                                  int num_iteration,
1233
1234
                                  int64_t buffer_len, 
                                  int64_t* out_len,
1235
                                  char* out_str) {
1236
1237
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1238
  std::string model = ref_booster->SaveModelToString(start_iteration, num_iteration);
1239
  *out_len = static_cast<int64_t>(model.size()) + 1;
1240
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
1241
    std::memcpy(out_str, model.c_str(), *out_len);
1242
1243
1244
1245
  }
  API_END();
}

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

Guolin Ke's avatar
Guolin Ke committed
1262
int LGBM_BoosterGetLeafValue(BoosterHandle handle,
1263
1264
1265
                             int tree_idx,
                             int leaf_idx,
                             double* out_val) {
Guolin Ke's avatar
Guolin Ke committed
1266
1267
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1268
  *out_val = static_cast<double>(ref_booster->GetLeafValue(tree_idx, leaf_idx));
Guolin Ke's avatar
Guolin Ke committed
1269
1270
1271
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1272
int LGBM_BoosterSetLeafValue(BoosterHandle handle,
1273
1274
1275
                             int tree_idx,
                             int leaf_idx,
                             double val) {
Guolin Ke's avatar
Guolin Ke committed
1276
1277
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
1278
  ref_booster->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
1279
1280
1281
  API_END();
}

1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
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();
}

1295
1296
1297
1298
1299
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
1300
  Config config;
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
  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();
}

1317
1318
1319
int LGBM_NetworkInitWithFunctions(int num_machines, int rank,
                                  void* reduce_scatter_ext_fun,
                                  void* allgather_ext_fun) {
ww's avatar
ww committed
1320
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1321
  if (num_machines > 1) {
1322
    Network::Init(num_machines, rank, (ReduceScatterFunction)reduce_scatter_ext_fun, (AllgatherFunction)allgather_ext_fun);
ww's avatar
ww committed
1323
1324
1325
  }
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
1326

Guolin Ke's avatar
Guolin Ke committed
1327
// ---- start of some help functions
1328
1329
1330

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
1331
  if (data_type == C_API_DTYPE_FLOAT32) {
1332
1333
    const float* data_ptr = reinterpret_cast<const float*>(data);
    if (is_row_major) {
1334
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1335
        std::vector<double> ret(num_col);
1336
        auto tmp_ptr = data_ptr + static_cast<size_t>(num_col) * row_idx;
1337
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1338
          ret[i] = static_cast<double>(*(tmp_ptr + i));
1339
1340
1341
1342
        }
        return ret;
      };
    } else {
1343
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1344
        std::vector<double> ret(num_col);
1345
        for (int i = 0; i < num_col; ++i) {
1346
          ret[i] = static_cast<double>(*(data_ptr + static_cast<size_t>(num_row) * i + row_idx));
1347
1348
1349
1350
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
1351
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1352
1353
    const double* data_ptr = reinterpret_cast<const double*>(data);
    if (is_row_major) {
1354
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1355
        std::vector<double> ret(num_col);
1356
        auto tmp_ptr = data_ptr + static_cast<size_t>(num_col) * row_idx;
1357
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1358
          ret[i] = static_cast<double>(*(tmp_ptr + i));
1359
1360
1361
1362
        }
        return ret;
      };
    } else {
1363
      return [=] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1364
        std::vector<double> ret(num_col);
1365
        for (int i = 0; i < num_col; ++i) {
1366
          ret[i] = static_cast<double>(*(data_ptr + static_cast<size_t>(num_row) * i + row_idx));
1367
1368
1369
1370
1371
        }
        return ret;
      };
    }
  }
1372
  throw std::runtime_error("Unknown data type in RowFunctionFromDenseMatric");
1373
1374
1375
1376
}

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
1377
1378
  auto inner_function = RowFunctionFromDenseMatric(data, num_row, num_col, data_type, is_row_major);
  if (inner_function != nullptr) {
1379
    return [inner_function] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
1380
1381
1382
      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
1383
        if (std::fabs(raw_values[i]) > kZeroThreshold || std::isnan(raw_values[i])) {
Guolin Ke's avatar
Guolin Ke committed
1384
          ret.emplace_back(i, raw_values[i]);
1385
        }
Guolin Ke's avatar
Guolin Ke committed
1386
1387
1388
      }
      return ret;
    };
1389
  }
Guolin Ke's avatar
Guolin Ke committed
1390
  return nullptr;
1391
1392
1393
}

std::function<std::vector<std::pair<int, double>>(int idx)>
1394
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
1395
  if (data_type == C_API_DTYPE_FLOAT32) {
1396
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
1397
    if (indptr_type == C_API_DTYPE_INT32) {
1398
      const int32_t* ptr_indptr = reinterpret_cast<const int32_t*>(indptr);
1399
      return [=] (int idx) {
1400
1401
1402
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1403
1404
1405
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1406
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1407
          ret.emplace_back(indices[i], data_ptr[i]);
1408
1409
1410
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1411
    } else if (indptr_type == C_API_DTYPE_INT64) {
1412
      const int64_t* ptr_indptr = reinterpret_cast<const int64_t*>(indptr);
1413
      return [=] (int idx) {
1414
1415
1416
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1417
1418
1419
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1420
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1421
          ret.emplace_back(indices[i], data_ptr[i]);
1422
1423
1424
1425
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
1426
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1427
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
1428
    if (indptr_type == C_API_DTYPE_INT32) {
1429
      const int32_t* ptr_indptr = reinterpret_cast<const int32_t*>(indptr);
1430
      return [=] (int idx) {
1431
1432
1433
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1434
1435
1436
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1437
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1438
          ret.emplace_back(indices[i], data_ptr[i]);
1439
1440
1441
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1442
    } else if (indptr_type == C_API_DTYPE_INT64) {
1443
      const int64_t* ptr_indptr = reinterpret_cast<const int64_t*>(indptr);
1444
      return [=] (int idx) {
1445
1446
1447
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
1448
1449
1450
        if (end - start > 0)  {
          ret.reserve(end - start);
        }
Guolin Ke's avatar
Guolin Ke committed
1451
        for (int64_t i = start; i < end; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1452
          ret.emplace_back(indices[i], data_ptr[i]);
1453
1454
1455
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
1456
1457
    }
  }
1458
  throw std::runtime_error("Unknown data type in RowFunctionFromCSR");
1459
1460
}

Guolin Ke's avatar
Guolin Ke committed
1461
std::function<std::pair<int, double>(int idx)>
1462
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
1463
  CHECK(col_idx < ncol_ptr && col_idx >= 0);
Guolin Ke's avatar
Guolin Ke committed
1464
  if (data_type == C_API_DTYPE_FLOAT32) {
1465
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
1466
    if (col_ptr_type == C_API_DTYPE_INT32) {
1467
      const int32_t* ptr_col_ptr = reinterpret_cast<const int32_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1468
1469
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1470
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1471
1472
1473
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1474
        }
Guolin Ke's avatar
Guolin Ke committed
1475
1476
1477
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1478
      };
Guolin Ke's avatar
Guolin Ke committed
1479
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
1480
      const int64_t* ptr_col_ptr = reinterpret_cast<const int64_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1481
1482
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1483
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1484
1485
1486
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1487
        }
Guolin Ke's avatar
Guolin Ke committed
1488
1489
1490
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1491
      };
Guolin Ke's avatar
Guolin Ke committed
1492
    }
Guolin Ke's avatar
Guolin Ke committed
1493
  } else if (data_type == C_API_DTYPE_FLOAT64) {
1494
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
1495
    if (col_ptr_type == C_API_DTYPE_INT32) {
1496
      const int32_t* ptr_col_ptr = reinterpret_cast<const int32_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1497
1498
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1499
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1500
1501
1502
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1503
        }
Guolin Ke's avatar
Guolin Ke committed
1504
1505
1506
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1507
      };
Guolin Ke's avatar
Guolin Ke committed
1508
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
1509
      const int64_t* ptr_col_ptr = reinterpret_cast<const int64_t*>(col_ptr);
Guolin Ke's avatar
Guolin Ke committed
1510
1511
      int64_t start = ptr_col_ptr[col_idx];
      int64_t end = ptr_col_ptr[col_idx + 1];
1512
      return [=] (int bias) {
Guolin Ke's avatar
Guolin Ke committed
1513
1514
1515
        int64_t i = static_cast<int64_t>(start + bias);
        if (i >= end) {
          return std::make_pair(-1, 0.0);
1516
        }
Guolin Ke's avatar
Guolin Ke committed
1517
1518
1519
        int idx = static_cast<int>(indices[i]);
        double val = static_cast<double>(data_ptr[i]);
        return std::make_pair(idx, val);
1520
      };
Guolin Ke's avatar
Guolin Ke committed
1521
1522
    }
  }
1523
  throw std::runtime_error("Unknown data type in CSC matrix");
1524
1525
}

Guolin Ke's avatar
Guolin Ke committed
1526
CSC_RowIterator::CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
1527
                                 const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx) {
Guolin Ke's avatar
Guolin Ke committed
1528
1529
1530
1531
1532
1533
1534
1535
1536
  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;
1537
    }
Guolin Ke's avatar
Guolin Ke committed
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
    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;
1555
    }
Guolin Ke's avatar
Guolin Ke committed
1556
1557
1558
    return ret;
  } else {
    return std::make_pair(-1, 0.0);
1559
  }
Guolin Ke's avatar
Guolin Ke committed
1560
}