c_api.cpp 26.3 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
3
4
#include <omp.h>

#include <LightGBM/utils/common.h>
#include <LightGBM/utils/random.h>
Guolin Ke's avatar
Guolin Ke committed
5
#include <LightGBM/c_api.h>
Guolin Ke's avatar
Guolin Ke committed
6
#include <LightGBM/dataset_loader.h>
Guolin Ke's avatar
Guolin Ke committed
7
8
9
10
11
12
13
14
15
16
#include <LightGBM/dataset.h>
#include <LightGBM/boosting.h>
#include <LightGBM/objective_function.h>
#include <LightGBM/metric.h>
#include <LightGBM/config.h>

#include <cstdio>
#include <vector>
#include <string>
#include <cstring>
Guolin Ke's avatar
Guolin Ke committed
17
#include <memory>
Guolin Ke's avatar
Guolin Ke committed
18
#include <stdexcept>
Guolin Ke's avatar
Guolin Ke committed
19

Guolin Ke's avatar
Guolin Ke committed
20
21
#include "./application/predictor.hpp"

Guolin Ke's avatar
Guolin Ke committed
22
23
24
25
namespace LightGBM {

class Booster {
public:
Guolin Ke's avatar
Guolin Ke committed
26
27
  explicit Booster(const char* filename) {
    boosting_.reset(Boosting::CreateBoosting(filename));
Guolin Ke's avatar
Guolin Ke committed
28
29
30
31
32
33
  }

  Booster(const Dataset* train_data, 
    std::vector<const Dataset*> valid_data, 
    std::vector<std::string> valid_names,
    const char* parameters)
Guolin Ke's avatar
Guolin Ke committed
34
    :train_data_(train_data), valid_datas_(valid_data) {
Guolin Ke's avatar
Guolin Ke committed
35
36
37
    config_.LoadFromString(parameters);
    // create boosting
    if (config_.io_config.input_model.size() > 0) {
Guolin Ke's avatar
Guolin Ke committed
38
      Log::Warning("continued train from model is not support for c_api, \
Guolin Ke's avatar
Guolin Ke committed
39
40
        please use continued train with input score");
    }
Guolin Ke's avatar
Guolin Ke committed
41
    boosting_.reset(Boosting::CreateBoosting(config_.boosting_type, ""));
Guolin Ke's avatar
Guolin Ke committed
42
    // create objective function
Guolin Ke's avatar
Guolin Ke committed
43
44
45
46
47
    objective_fun_.reset(ObjectiveFunction::CreateObjectiveFunction(config_.objective_type,
      config_.objective_config));
    if (objective_fun_ == nullptr) {
      Log::Warning("Using self-defined objective functions");
    }
Guolin Ke's avatar
Guolin Ke committed
48
    // create training metric
Guolin Ke's avatar
Guolin Ke committed
49
    for (auto metric_type : config_.metric_types) {
Guolin Ke's avatar
Guolin Ke committed
50
51
      auto metric = std::unique_ptr<Metric>(
        Metric::CreateMetric(metric_type, config_.metric_config));
Guolin Ke's avatar
Guolin Ke committed
52
53
54
      if (metric == nullptr) { continue; }
      metric->Init("training", train_data_->metadata(),
        train_data_->num_data());
Guolin Ke's avatar
Guolin Ke committed
55
      train_metric_.push_back(std::move(metric));
Guolin Ke's avatar
Guolin Ke committed
56
    }
Guolin Ke's avatar
Guolin Ke committed
57
    train_metric_.shrink_to_fit();
Guolin Ke's avatar
Guolin Ke committed
58
59
60
61
    // add metric for validation data
    for (size_t i = 0; i < valid_datas_.size(); ++i) {
      valid_metrics_.emplace_back();
      for (auto metric_type : config_.metric_types) {
Guolin Ke's avatar
Guolin Ke committed
62
        auto metric = std::unique_ptr<Metric>(Metric::CreateMetric(metric_type, config_.metric_config));
Guolin Ke's avatar
Guolin Ke committed
63
64
65
66
        if (metric == nullptr) { continue; }
        metric->Init(valid_names[i].c_str(),
          valid_datas_[i]->metadata(),
          valid_datas_[i]->num_data());
Guolin Ke's avatar
Guolin Ke committed
67
        valid_metrics_.back().push_back(std::move(metric));
Guolin Ke's avatar
Guolin Ke committed
68
      }
Guolin Ke's avatar
Guolin Ke committed
69
      valid_metrics_.back().shrink_to_fit();
Guolin Ke's avatar
Guolin Ke committed
70
    }
Guolin Ke's avatar
Guolin Ke committed
71
    valid_metrics_.shrink_to_fit();
Guolin Ke's avatar
Guolin Ke committed
72
    // initialize the objective function
Guolin Ke's avatar
Guolin Ke committed
73
74
75
    if (objective_fun_ != nullptr) {
      objective_fun_->Init(train_data_->metadata(), train_data_->num_data());
    }
Guolin Ke's avatar
Guolin Ke committed
76
    // initialize the boosting
Guolin Ke's avatar
Guolin Ke committed
77
78
    boosting_->Init(&config_.boosting_config, train_data_, objective_fun_.get(),
      Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
Guolin Ke's avatar
Guolin Ke committed
79
80
81
    // add validation data into boosting
    for (size_t i = 0; i < valid_datas_.size(); ++i) {
      boosting_->AddDataset(valid_datas_[i],
Guolin Ke's avatar
Guolin Ke committed
82
        Common::ConstPtrInVectorWrapper<Metric>(valid_metrics_[i]));
Guolin Ke's avatar
Guolin Ke committed
83
84
    }
  }
85
86
87
  void LoadModelFromFile(const char* filename) {
    Boosting::LoadFileToBoosting(boosting_.get(), filename);
  }
Guolin Ke's avatar
Guolin Ke committed
88
  ~Booster() {
Guolin Ke's avatar
Guolin Ke committed
89

Guolin Ke's avatar
Guolin Ke committed
90
  }
91
92
93
94
95
96
97
98
99
100
  bool TrainOneIter() {
    return boosting_->TrainOneIter(nullptr, nullptr, false);
  }

  bool TrainOneIter(const float* gradients, const float* hessians) {
    return boosting_->TrainOneIter(gradients, hessians, false);
  }

  void PrepareForPrediction(int num_used_model, int predict_type) {
    boosting_->SetNumUsedModel(num_used_model);
Guolin Ke's avatar
Guolin Ke committed
101
102
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
103
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
Guolin Ke's avatar
Guolin Ke committed
104
      is_predict_leaf = true;
Guolin Ke's avatar
Guolin Ke committed
105
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
Guolin Ke's avatar
Guolin Ke committed
106
      is_raw_score = true;
Guolin Ke's avatar
Guolin Ke committed
107
108
    } else {
      is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
109
    }
Guolin Ke's avatar
Guolin Ke committed
110
    predictor_.reset(new Predictor(boosting_.get(), is_raw_score, is_predict_leaf));
Guolin Ke's avatar
Guolin Ke committed
111
112
113
114
  }

  std::vector<double> Predict(const std::vector<std::pair<int, double>>& features) {
    return predictor_->GetPredictFunction()(features);
115
116
  }

117
118
119
120
  void PredictForFile(const char* data_filename, const char* result_filename, bool data_has_header) {
    predictor_->Predict(data_filename, result_filename, data_has_header);
  }

Guolin Ke's avatar
Guolin Ke committed
121
122
123
  void SaveModelToFile(int num_used_model, const char* filename) {
    boosting_->SaveModelToFile(num_used_model, true, filename);
  }
124
  
Guolin Ke's avatar
Guolin Ke committed
125
  const Boosting* GetBoosting() const { return boosting_.get(); }
126

127
128
  const float* GetTrainingScore(int* out_len) const { return boosting_->GetTrainingScore(out_len); }

Guolin Ke's avatar
Guolin Ke committed
129
  const inline int NumberOfClasses() const { return boosting_->NumberOfClasses(); }
130

Guolin Ke's avatar
Guolin Ke committed
131
private:
132

Guolin Ke's avatar
Guolin Ke committed
133
  std::unique_ptr<Boosting> boosting_;
Guolin Ke's avatar
Guolin Ke committed
134
135
136
137
138
139
140
  /*! \brief All configs */
  OverallConfig config_;
  /*! \brief Training data */
  const Dataset* train_data_;
  /*! \brief Validation data */
  std::vector<const Dataset*> valid_datas_;
  /*! \brief Metric for training data */
Guolin Ke's avatar
Guolin Ke committed
141
  std::vector<std::unique_ptr<Metric>> train_metric_;
Guolin Ke's avatar
Guolin Ke committed
142
  /*! \brief Metrics for validation data */
Guolin Ke's avatar
Guolin Ke committed
143
  std::vector<std::vector<std::unique_ptr<Metric>>> valid_metrics_;
Guolin Ke's avatar
Guolin Ke committed
144
  /*! \brief Training objective function */
Guolin Ke's avatar
Guolin Ke committed
145
  std::unique_ptr<ObjectiveFunction> objective_fun_;
Guolin Ke's avatar
Guolin Ke committed
146
  /*! \brief Using predictor for prediction task */
Guolin Ke's avatar
Guolin Ke committed
147
  std::unique_ptr<Predictor> predictor_;
148

Guolin Ke's avatar
Guolin Ke committed
149
150
151
};

}
Guolin Ke's avatar
Guolin Ke committed
152
153
154

using namespace LightGBM;

Guolin Ke's avatar
Guolin Ke committed
155
DllExport const char* LGBM_GetLastError() {
156
  return LastErrorMsg().c_str();
Guolin Ke's avatar
Guolin Ke committed
157
158
159
160
161
162
}

DllExport int LGBM_CreateDatasetFromFile(const char* filename,
  const char* parameters,
  const DatesetHandle* reference,
  DatesetHandle* out) {
163
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
164
165
166
  OverallConfig config;
  config.LoadFromString(parameters);
  DatasetLoader loader(config.io_config, nullptr);
167
  loader.SetHeader(filename);
Guolin Ke's avatar
Guolin Ke committed
168
  if (reference == nullptr) {
Guolin Ke's avatar
Guolin Ke committed
169
    *out = loader.LoadFromFile(filename);
Guolin Ke's avatar
Guolin Ke committed
170
  } else {
Guolin Ke's avatar
Guolin Ke committed
171
172
    *out = loader.LoadFromFileAlignWithOtherDataset(filename,
      reinterpret_cast<const Dataset*>(*reference));
Guolin Ke's avatar
Guolin Ke committed
173
  }
174
  API_END();
Guolin Ke's avatar
Guolin Ke committed
175
176
177
178
}

DllExport int LGBM_CreateDatasetFromBinaryFile(const char* filename,
  DatesetHandle* out) {
179
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
180
181
  OverallConfig config;
  DatasetLoader loader(config.io_config, nullptr);
Guolin Ke's avatar
Guolin Ke committed
182
  *out = loader.LoadFromBinFile(filename, 0, 1);
183
  API_END();
Guolin Ke's avatar
Guolin Ke committed
184
185
186
}

DllExport int LGBM_CreateDatasetFromMat(const void* data,
187
  int data_type,
Guolin Ke's avatar
Guolin Ke committed
188
189
190
191
192
193
  int32_t nrow,
  int32_t ncol,
  int is_row_major,
  const char* parameters,
  const DatesetHandle* reference,
  DatesetHandle* out) {
194
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
195
196
197
  OverallConfig config;
  config.LoadFromString(parameters);
  DatasetLoader loader(config.io_config, nullptr);
Guolin Ke's avatar
Guolin Ke committed
198
  std::unique_ptr<Dataset> ret;
199
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
Guolin Ke's avatar
Guolin Ke committed
200
201
202
  if (reference == nullptr) {
    // sample data first
    Random rand(config.io_config.data_random_seed);
203
    const int sample_cnt = static_cast<int>(nrow < config.io_config.bin_construct_sample_cnt ? nrow : config.io_config.bin_construct_sample_cnt);
Guolin Ke's avatar
Guolin Ke committed
204
    auto sample_indices = rand.Sample(nrow, sample_cnt);
205
    std::vector<std::vector<double>> sample_values(ncol);
Guolin Ke's avatar
Guolin Ke committed
206
    for (size_t i = 0; i < sample_indices.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
207
      auto idx = sample_indices[i];
208
      auto row = get_row_fun(static_cast<int>(idx));
Guolin Ke's avatar
Guolin Ke committed
209
      for (size_t j = 0; j < row.size(); ++j) {
Guolin Ke's avatar
Guolin Ke committed
210
211
212
        if (std::fabs(row[j]) > 1e-15) {
          sample_values[j].push_back(row[j]);
        }
Guolin Ke's avatar
Guolin Ke committed
213
214
      }
    }
Guolin Ke's avatar
Guolin Ke committed
215
    ret.reset(loader.CostructFromSampleData(sample_values, sample_cnt, nrow));
Guolin Ke's avatar
Guolin Ke committed
216
  } else {
Guolin Ke's avatar
Guolin Ke committed
217
218
    ret.reset(new Dataset(nrow, config.io_config.num_class));
    ret->CopyFeatureMapperFrom(
Guolin Ke's avatar
Guolin Ke committed
219
      reinterpret_cast<const Dataset*>(*reference),
Guolin Ke's avatar
Guolin Ke committed
220
      config.io_config.is_enable_sparse);
Guolin Ke's avatar
Guolin Ke committed
221
222
223
224
225
  }

#pragma omp parallel for schedule(guided)
  for (int i = 0; i < nrow; ++i) {
    const int tid = omp_get_thread_num();
226
    auto one_row = get_row_fun(i);
Guolin Ke's avatar
Guolin Ke committed
227
228
229
    ret->PushOneRow(tid, i, one_row);
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
230
  *out = ret.release();
231
  API_END();
232
233
}

234
235
DllExport int LGBM_CreateDatasetFromCSR(const void* indptr,
  int indptr_type,
236
237
  const int32_t* indices,
  const void* data,
238
239
240
241
  int data_type,
  int64_t nindptr,
  int64_t nelem,
  int64_t num_col,
242
243
244
  const char* parameters,
  const DatesetHandle* reference,
  DatesetHandle* out) {
245
  API_BEGIN();
246
247
248
  OverallConfig config;
  config.LoadFromString(parameters);
  DatasetLoader loader(config.io_config, nullptr);
Guolin Ke's avatar
Guolin Ke committed
249
  std::unique_ptr<Dataset> ret;
250
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
251
252
253
254
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (reference == nullptr) {
    // sample data first
    Random rand(config.io_config.data_random_seed);
255
    const int sample_cnt = static_cast<int>(nrow < config.io_config.bin_construct_sample_cnt ? nrow : config.io_config.bin_construct_sample_cnt);
256
257
258
259
260
261
    auto sample_indices = rand.Sample(nrow, sample_cnt);
    std::vector<std::vector<double>> sample_values;
    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
262
263
264
265
266
267
268
        if (std::fabs(inner_data.second) > 1e-15) {
          if (static_cast<size_t>(inner_data.first) >= sample_values.size()) {
            // if need expand feature set
            size_t need_size = inner_data.first - sample_values.size() + 1;
            for (size_t j = 0; j < need_size; ++j) {
              sample_values.emplace_back();
            }
269
          }
Guolin Ke's avatar
Guolin Ke committed
270
271
          // edit the feature value
          sample_values[inner_data.first].push_back(inner_data.second);
272
273
274
        }
      }
    }
275
    CHECK(num_col >= static_cast<int>(sample_values.size()));
Guolin Ke's avatar
Guolin Ke committed
276
    ret.reset(loader.CostructFromSampleData(sample_values, sample_cnt, nrow));
277
  } else {
Guolin Ke's avatar
Guolin Ke committed
278
279
    ret.reset(new Dataset(nrow, config.io_config.num_class));
    ret->CopyFeatureMapperFrom(
Guolin Ke's avatar
Guolin Ke committed
280
      reinterpret_cast<const Dataset*>(*reference),
Guolin Ke's avatar
Guolin Ke committed
281
      config.io_config.is_enable_sparse);
282
283
284
285
286
287
288
289
290
  }

#pragma omp parallel for schedule(guided)
  for (int i = 0; i < nindptr - 1; ++i) {
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    ret->PushOneRow(tid, i, one_row);
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
291
  *out = ret.release();
292
  API_END();
293
294
}

295
296
DllExport int LGBM_CreateDatasetFromCSC(const void* col_ptr,
  int col_ptr_type,
Guolin Ke's avatar
Guolin Ke committed
297
298
  const int32_t* indices,
  const void* data,
299
300
301
302
  int data_type,
  int64_t ncol_ptr,
  int64_t nelem,
  int64_t num_row,
Guolin Ke's avatar
Guolin Ke committed
303
304
305
  const char* parameters,
  const DatesetHandle* reference,
  DatesetHandle* out) {
306
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
307
308
309
  OverallConfig config;
  config.LoadFromString(parameters);
  DatasetLoader loader(config.io_config, nullptr);
Guolin Ke's avatar
Guolin Ke committed
310
  std::unique_ptr<Dataset> ret;
311
  auto get_col_fun = ColumnFunctionFromCSC(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
312
313
314
315
316
  int32_t nrow = static_cast<int32_t>(num_row);
  if (reference == nullptr) {
    Log::Warning("Construct from CSC format is not efficient");
    // sample data first
    Random rand(config.io_config.data_random_seed);
317
    const int sample_cnt = static_cast<int>(nrow < config.io_config.bin_construct_sample_cnt ? nrow : config.io_config.bin_construct_sample_cnt);
Guolin Ke's avatar
Guolin Ke committed
318
319
320
321
322
    auto sample_indices = rand.Sample(nrow, sample_cnt);
    std::vector<std::vector<double>> sample_values(ncol_ptr - 1);
#pragma omp parallel for schedule(guided)
    for (int i = 0; i < static_cast<int>(sample_values.size()); ++i) {
      auto cur_col = get_col_fun(i);
323
      sample_values[i] = SampleFromOneColumn(cur_col, sample_indices);
Guolin Ke's avatar
Guolin Ke committed
324
    }
Guolin Ke's avatar
Guolin Ke committed
325
    ret.reset(loader.CostructFromSampleData(sample_values, sample_cnt, nrow));
Guolin Ke's avatar
Guolin Ke committed
326
  } else {
Guolin Ke's avatar
Guolin Ke committed
327
328
    ret.reset(new Dataset(nrow, config.io_config.num_class));
    ret->CopyFeatureMapperFrom(
Guolin Ke's avatar
Guolin Ke committed
329
      reinterpret_cast<const Dataset*>(*reference),
Guolin Ke's avatar
Guolin Ke committed
330
      config.io_config.is_enable_sparse);
Guolin Ke's avatar
Guolin Ke committed
331
332
333
334
335
336
  }

#pragma omp parallel for schedule(guided)
  for (int i = 0; i < ncol_ptr - 1; ++i) {
    const int tid = omp_get_thread_num();
    auto one_col = get_col_fun(i);
Guolin Ke's avatar
Guolin Ke committed
337
    ret->PushOneColumn(tid, i, one_col);
Guolin Ke's avatar
Guolin Ke committed
338
339
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
340
  *out = ret.release();
341
  API_END();
Guolin Ke's avatar
Guolin Ke committed
342
343
}

344
DllExport int LGBM_DatasetFree(DatesetHandle handle) {
345
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
346
  delete reinterpret_cast<Dataset*>(handle);
347
  API_END();
348
349
350
351
}

DllExport int LGBM_DatasetSaveBinary(DatesetHandle handle,
  const char* filename) {
352
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
353
354
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->SaveBinaryFile(filename);
355
  API_END();
356
357
358
359
360
}

DllExport int LGBM_DatasetSetField(DatesetHandle handle,
  const char* field_name,
  const void* field_data,
361
  int64_t num_element,
362
  int type) {
363
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
364
  auto dataset = reinterpret_cast<Dataset*>(handle);
365
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
366
  if (type == C_API_DTYPE_FLOAT32) {
Guolin Ke's avatar
Guolin Ke committed
367
    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
368
  } else if (type == C_API_DTYPE_INT32) {
Guolin Ke's avatar
Guolin Ke committed
369
    is_success = dataset->SetIntField(field_name, reinterpret_cast<const int*>(field_data), static_cast<int32_t>(num_element));
370
  }
371
372
  if (!is_success) { throw std::runtime_error("Input data type erorr or field not found"); }
  API_END();
373
374
375
376
}

DllExport int LGBM_DatasetGetField(DatesetHandle handle,
  const char* field_name,
377
  int64_t* out_len,
378
379
  const void** out_ptr,
  int* out_type) {
380
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
381
  auto dataset = reinterpret_cast<Dataset*>(handle);
382
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
383
  if (dataset->GetFloatField(field_name, out_len, reinterpret_cast<const float**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
384
    *out_type = C_API_DTYPE_FLOAT32;
385
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
386
  } else if (dataset->GetIntField(field_name, out_len, reinterpret_cast<const int**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
387
    *out_type = C_API_DTYPE_INT32;
388
    is_success = true;
389
  }
Guolin Ke's avatar
Guolin Ke committed
390
  if (!is_success) { throw std::runtime_error("Field not found or not exist"); }
391
  API_END();
392
393
394
}

DllExport int LGBM_DatasetGetNumData(DatesetHandle handle,
395
  int64_t* out) {
396
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
397
398
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_data();
399
  API_END();
400
401
402
}

DllExport int LGBM_DatasetGetNumFeature(DatesetHandle handle,
403
  int64_t* out) {
404
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
405
406
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_total_features();
407
  API_END();
Guolin Ke's avatar
Guolin Ke committed
408
}
409
410
411
412
413
414
415
416
417


// ---- start of booster

DllExport int LGBM_BoosterCreate(const DatesetHandle train_data,
  const DatesetHandle valid_datas[],
  const char* valid_names[],
  int n_valid_datas,
  const char* parameters,
418
  const char* init_model_filename,
419
  BoosterHandle* out) {
420
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
421
  const Dataset* p_train_data = reinterpret_cast<const Dataset*>(train_data);
422
423
424
  std::vector<const Dataset*> p_valid_datas;
  std::vector<std::string> p_valid_names;
  for (int i = 0; i < n_valid_datas; ++i) {
Guolin Ke's avatar
Guolin Ke committed
425
    p_valid_datas.emplace_back(reinterpret_cast<const Dataset*>(valid_datas[i]));
426
427
    p_valid_names.emplace_back(valid_names[i]);
  }
428
429
430
431
432
  auto ret = std::unique_ptr<Booster>(new Booster(p_train_data, p_valid_datas, p_valid_names, parameters));
  if (init_model_filename != nullptr) {
    ret->LoadModelFromFile(init_model_filename);
  }
  *out = ret.release();
433
  API_END();
434
435
}

436
DllExport int LGBM_BoosterCreateFromModelfile(
437
438
  const char* filename,
  BoosterHandle* out) {
439
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
440
  *out = new Booster(filename);
441
  API_END();
442
443
444
}

DllExport int LGBM_BoosterFree(BoosterHandle handle) {
445
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
446
  delete reinterpret_cast<Booster*>(handle);
447
  API_END();
448
449
450
}

DllExport int LGBM_BoosterUpdateOneIter(BoosterHandle handle, int* is_finished) {
451
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
452
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
453
454
455
456
457
  if (ref_booster->TrainOneIter()) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
458
  API_END();
459
460
461
462
463
464
}

DllExport int LGBM_BoosterUpdateOneIterCustom(BoosterHandle handle,
  const float* grad,
  const float* hess,
  int* is_finished) {
465
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
466
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
467
468
469
470
471
  if (ref_booster->TrainOneIter(grad, hess)) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
472
  API_END();
473
474
475
476
}

DllExport int LGBM_BoosterEval(BoosterHandle handle,
  int data,
477
  int64_t* out_len,
Guolin Ke's avatar
Guolin Ke committed
478
  float* out_results) {
479
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
480
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
481
482
  auto boosting = ref_booster->GetBoosting();
  auto result_buf = boosting->GetEvalAt(data);
483
  *out_len = static_cast<int64_t>(result_buf.size());
484
  for (size_t i = 0; i < result_buf.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
485
    (out_results)[i] = static_cast<float>(result_buf[i]);
486
  }
487
  API_END();
488
489
490
}

DllExport int LGBM_BoosterGetScore(BoosterHandle handle,
491
  int64_t* out_len,
492
  const float** out_result) {
493
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
494
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
495
  int len = 0;
496
  *out_result = ref_booster->GetTrainingScore(&len);
497
  *out_len = static_cast<int64_t>(len);
498
  API_END();
499
500
}

Guolin Ke's avatar
Guolin Ke committed
501
502
DllExport int LGBM_BoosterGetPredict(BoosterHandle handle,
  int data,
503
  int64_t* out_len,
Guolin Ke's avatar
Guolin Ke committed
504
  float* out_result) {
505
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
506
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
507
508
  auto boosting = ref_booster->GetBoosting();
  int len = 0;
Guolin Ke's avatar
Guolin Ke committed
509
  boosting->GetPredictAt(data, out_result, &len);
510
  *out_len = static_cast<int64_t>(len);
511
  API_END();
Guolin Ke's avatar
Guolin Ke committed
512
513
}

514
515
516
517
518
519
DllExport int LGBM_BoosterPredictForFile(BoosterHandle handle,
  int predict_type,
  int64_t n_used_trees,
  int data_has_header,
  const char* data_filename,
  const char* result_filename) {
520
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
521
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
522
523
524
  ref_booster->PrepareForPrediction(static_cast<int>(n_used_trees), predict_type);
  bool bool_data_has_header = data_has_header > 0 ? true : false;
  ref_booster->PredictForFile(data_filename, result_filename, bool_data_has_header);
525
  API_END();
526
527
}

528
DllExport int LGBM_BoosterPredictForCSR(BoosterHandle handle,
529
530
  const void* indptr,
  int indptr_type,
531
532
  const int32_t* indices,
  const void* data,
533
534
535
536
  int data_type,
  int64_t nindptr,
  int64_t nelem,
  int64_t,
537
  int predict_type,
538
  int64_t n_used_trees,
Guolin Ke's avatar
Guolin Ke committed
539
  double* out_result) {
540
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
541
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
542
543
  ref_booster->PrepareForPrediction(static_cast<int>(n_used_trees), predict_type);

544
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
545
  int num_class = ref_booster->NumberOfClasses();
Guolin Ke's avatar
Guolin Ke committed
546
547
548
549
550
  int nrow = static_cast<int>(nindptr - 1);
#pragma omp parallel for schedule(guided)
  for (int i = 0; i < nrow; ++i) {
    auto one_row = get_row_fun(i);
    auto predicton_result = ref_booster->Predict(one_row);
Guolin Ke's avatar
Guolin Ke committed
551
    for (int j = 0; j < num_class; ++j) {
Guolin Ke's avatar
Guolin Ke committed
552
553
554
      out_result[i * num_class + j] = predicton_result[j];
    }
  }
555
  API_END();
Guolin Ke's avatar
Guolin Ke committed
556
}
557
558
559

DllExport int LGBM_BoosterPredictForMat(BoosterHandle handle,
  const void* data,
560
  int data_type,
561
562
  int32_t nrow,
  int32_t ncol,
Guolin Ke's avatar
Guolin Ke committed
563
  int is_row_major,
564
  int predict_type,
565
  int64_t n_used_trees,
Guolin Ke's avatar
Guolin Ke committed
566
  double* out_result) {
567
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
568
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
569
570
  ref_booster->PrepareForPrediction(static_cast<int>(n_used_trees), predict_type);

571
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
Guolin Ke's avatar
Guolin Ke committed
572
  int num_class = ref_booster->NumberOfClasses();
Guolin Ke's avatar
Guolin Ke committed
573
574
575
576
#pragma omp parallel for schedule(guided)
  for (int i = 0; i < nrow; ++i) {
    auto one_row = get_row_fun(i);
    auto predicton_result = ref_booster->Predict(one_row);
Guolin Ke's avatar
Guolin Ke committed
577
    for (int j = 0; j < num_class; ++j) {
Guolin Ke's avatar
Guolin Ke committed
578
579
580
      out_result[i * num_class + j] = predicton_result[j];
    }
  }
581
  API_END();
Guolin Ke's avatar
Guolin Ke committed
582
}
583
584
585

DllExport int LGBM_BoosterSaveModel(BoosterHandle handle,
  int num_used_model,
Guolin Ke's avatar
Guolin Ke committed
586
  const char* filename) {
587
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
588
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
589
  ref_booster->SaveModelToFile(num_used_model, filename);
590
  API_END();
Guolin Ke's avatar
Guolin Ke committed
591
}
592

Guolin Ke's avatar
Guolin Ke committed
593
// ---- start of some help functions
594
595
596

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
597
  if (data_type == C_API_DTYPE_FLOAT32) {
598
599
600
    const float* data_ptr = reinterpret_cast<const float*>(data);
    if (is_row_major) {
      return [data_ptr, num_col, num_row](int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
601
        std::vector<double> ret(num_col);
602
603
        auto tmp_ptr = data_ptr + num_col * row_idx;
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
604
          ret[i] = static_cast<double>(*(tmp_ptr + i));
605
606
607
608
609
        }
        return ret;
      };
    } else {
      return [data_ptr, num_col, num_row](int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
610
        std::vector<double> ret(num_col);
611
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
612
          ret[i] = static_cast<double>(*(data_ptr + num_row * i + row_idx));
613
614
615
616
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
617
  } else if (data_type == C_API_DTYPE_FLOAT64) {
618
619
620
    const double* data_ptr = reinterpret_cast<const double*>(data);
    if (is_row_major) {
      return [data_ptr, num_col, num_row](int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
621
        std::vector<double> ret(num_col);
622
623
        auto tmp_ptr = data_ptr + num_col * row_idx;
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
624
          ret[i] = static_cast<double>(*(tmp_ptr + i));
625
626
627
628
629
        }
        return ret;
      };
    } else {
      return [data_ptr, num_col, num_row](int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
630
        std::vector<double> ret(num_col);
631
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
632
          ret[i] = static_cast<double>(*(data_ptr + num_row * i + row_idx));
633
634
635
636
637
        }
        return ret;
      };
    }
  }
Guolin Ke's avatar
Guolin Ke committed
638
  throw std::runtime_error("unknown data type in RowFunctionFromDenseMatric");
639
640
641
642
}

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
643
644
645
646
647
648
649
650
  auto inner_function = RowFunctionFromDenseMatric(data, num_row, num_col, data_type, is_row_major);
  if (inner_function != nullptr) {
    return [inner_function](int row_idx) {
      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) {
        if (std::fabs(raw_values[i]) > 1e-15) {
          ret.emplace_back(i, raw_values[i]);
651
        }
Guolin Ke's avatar
Guolin Ke committed
652
653
654
      }
      return ret;
    };
655
  }
Guolin Ke's avatar
Guolin Ke committed
656
  return nullptr;
657
658
659
660
}

std::function<std::vector<std::pair<int, double>>(int idx)>
RowFunctionFromCSR(const void* indptr, int indptr_type, const int32_t* indices, const void* data, int data_type, int64_t nindptr, int64_t nelem) {
Guolin Ke's avatar
Guolin Ke committed
661
  if (data_type == C_API_DTYPE_FLOAT32) {
662
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
663
    if (indptr_type == C_API_DTYPE_INT32) {
664
665
666
667
668
      const int32_t* ptr_indptr = reinterpret_cast<const int32_t*>(indptr);
      return [ptr_indptr, indices, data_ptr, nindptr, nelem](int idx) {
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
Guolin Ke's avatar
Guolin Ke committed
669
        for (int64_t i = start; i < end; ++i) {
670
671
672
673
          ret.emplace_back(indices[i], data_ptr[i]);
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
674
    } else if (indptr_type == C_API_DTYPE_INT64) {
675
676
677
678
679
      const int64_t* ptr_indptr = reinterpret_cast<const int64_t*>(indptr);
      return [ptr_indptr, indices, data_ptr, nindptr, nelem](int idx) {
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
Guolin Ke's avatar
Guolin Ke committed
680
        for (int64_t i = start; i < end; ++i) {
681
682
683
684
685
          ret.emplace_back(indices[i], data_ptr[i]);
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
686
  } else if (data_type == C_API_DTYPE_FLOAT64) {
687
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
688
    if (indptr_type == C_API_DTYPE_INT32) {
689
690
691
692
693
      const int32_t* ptr_indptr = reinterpret_cast<const int32_t*>(indptr);
      return [ptr_indptr, indices, data_ptr, nindptr, nelem](int idx) {
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
Guolin Ke's avatar
Guolin Ke committed
694
        for (int64_t i = start; i < end; ++i) {
695
696
697
698
          ret.emplace_back(indices[i], data_ptr[i]);
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
699
    } else if (indptr_type == C_API_DTYPE_INT64) {
700
701
702
703
704
      const int64_t* ptr_indptr = reinterpret_cast<const int64_t*>(indptr);
      return [ptr_indptr, indices, data_ptr, nindptr, nelem](int idx) {
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_indptr[idx];
        int64_t end = ptr_indptr[idx + 1];
Guolin Ke's avatar
Guolin Ke committed
705
        for (int64_t i = start; i < end; ++i) {
706
707
708
709
          ret.emplace_back(indices[i], data_ptr[i]);
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
710
711
712
    } 
  } 
  throw std::runtime_error("unknown data type in RowFunctionFromCSR");
713
714
715
716
}

std::function<std::vector<std::pair<int, double>>(int idx)>
ColumnFunctionFromCSC(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) {
Guolin Ke's avatar
Guolin Ke committed
717
  if (data_type == C_API_DTYPE_FLOAT32) {
718
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
719
    if (col_ptr_type == C_API_DTYPE_INT32) {
720
721
722
723
724
725
726
727
728
729
      const int32_t* ptr_col_ptr = reinterpret_cast<const int32_t*>(col_ptr);
      return [ptr_col_ptr, indices, data_ptr, ncol_ptr, nelem](int idx) {
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_col_ptr[idx];
        int64_t end = ptr_col_ptr[idx + 1];
        for (int64_t i = start; i < end; ++i) {
          ret.emplace_back(indices[i], data_ptr[i]);
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
730
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
731
732
733
734
735
736
737
738
739
740
      const int64_t* ptr_col_ptr = reinterpret_cast<const int64_t*>(col_ptr);
      return [ptr_col_ptr, indices, data_ptr, ncol_ptr, nelem](int idx) {
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_col_ptr[idx];
        int64_t end = ptr_col_ptr[idx + 1];
        for (int64_t i = start; i < end; ++i) {
          ret.emplace_back(indices[i], data_ptr[i]);
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
741
    } 
Guolin Ke's avatar
Guolin Ke committed
742
  } else if (data_type == C_API_DTYPE_FLOAT64) {
743
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
744
    if (col_ptr_type == C_API_DTYPE_INT32) {
745
746
747
748
749
750
751
752
753
754
      const int32_t* ptr_col_ptr = reinterpret_cast<const int32_t*>(col_ptr);
      return [ptr_col_ptr, indices, data_ptr, ncol_ptr, nelem](int idx) {
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_col_ptr[idx];
        int64_t end = ptr_col_ptr[idx + 1];
        for (int64_t i = start; i < end; ++i) {
          ret.emplace_back(indices[i], data_ptr[i]);
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
755
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
756
757
758
759
760
761
762
763
764
765
      const int64_t* ptr_col_ptr = reinterpret_cast<const int64_t*>(col_ptr);
      return [ptr_col_ptr, indices, data_ptr, ncol_ptr, nelem](int idx) {
        std::vector<std::pair<int, double>> ret;
        int64_t start = ptr_col_ptr[idx];
        int64_t end = ptr_col_ptr[idx + 1];
        for (int64_t i = start; i < end; ++i) {
          ret.emplace_back(indices[i], data_ptr[i]);
        }
        return ret;
      };
Guolin Ke's avatar
Guolin Ke committed
766
767
768
    } 
  } 
  throw std::runtime_error("unknown data type in ColumnFunctionFromCSC");
769
770
}

771
std::vector<double> SampleFromOneColumn(const std::vector<std::pair<int, double>>& data, const std::vector<int>& indices) {
772
773
774
775
776
777
778
779
780
781
782
  size_t j = 0;
  std::vector<double> ret;
  for (auto row_idx : indices) {
    while (j < data.size() && data[j].first < static_cast<int>(row_idx)) {
      ++j;
    }
    if (j < data.size() && data[j].first == static_cast<int>(row_idx)) {
      ret.push_back(data[j].second);
    }
  }
  return ret;
Guolin Ke's avatar
Guolin Ke committed
783
}