"git@developer.sourcefind.cn:tianlh/lightgbm-dcu.git" did not exist on "fc167922d9896f4f4ba6c4db3160bc6bd5d17a84"
c_api.cpp 28.1 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
  }

  Booster(const Dataset* train_data, 
    std::vector<const Dataset*> valid_data, 
    const char* parameters)
Guolin Ke's avatar
Guolin Ke committed
33
    :train_data_(train_data), valid_datas_(valid_data) {
Guolin Ke's avatar
Guolin Ke committed
34
35
36
    config_.LoadFromString(parameters);
    // create boosting
    if (config_.io_config.input_model.size() > 0) {
Guolin Ke's avatar
Guolin Ke committed
37
      Log::Warning("continued train from model is not support for c_api, \
Guolin Ke's avatar
Guolin Ke committed
38
39
        please use continued train with input score");
    }
Guolin Ke's avatar
Guolin Ke committed
40
    boosting_.reset(Boosting::CreateBoosting(config_.boosting_type, ""));
Guolin Ke's avatar
Guolin Ke committed
41
    // create objective function
Guolin Ke's avatar
Guolin Ke committed
42
43
44
45
46
    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
47
    // create training metric
Guolin Ke's avatar
Guolin Ke committed
48
    for (auto metric_type : config_.metric_types) {
Guolin Ke's avatar
Guolin Ke committed
49
50
      auto metric = std::unique_ptr<Metric>(
        Metric::CreateMetric(metric_type, config_.metric_config));
Guolin Ke's avatar
Guolin Ke committed
51
      if (metric == nullptr) { continue; }
Guolin Ke's avatar
Guolin Ke committed
52
      metric->Init(train_data_->metadata(), train_data_->num_data());
Guolin Ke's avatar
Guolin Ke committed
53
      train_metric_.push_back(std::move(metric));
Guolin Ke's avatar
Guolin Ke committed
54
    }
Guolin Ke's avatar
Guolin Ke committed
55
    train_metric_.shrink_to_fit();
Guolin Ke's avatar
Guolin Ke committed
56
57
58
59
    // 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
60
        auto metric = std::unique_ptr<Metric>(Metric::CreateMetric(metric_type, config_.metric_config));
Guolin Ke's avatar
Guolin Ke committed
61
        if (metric == nullptr) { continue; }
Guolin Ke's avatar
Guolin Ke committed
62
        metric->Init(valid_datas_[i]->metadata(), valid_datas_[i]->num_data());
Guolin Ke's avatar
Guolin Ke committed
63
        valid_metrics_.back().push_back(std::move(metric));
Guolin Ke's avatar
Guolin Ke committed
64
      }
Guolin Ke's avatar
Guolin Ke committed
65
      valid_metrics_.back().shrink_to_fit();
Guolin Ke's avatar
Guolin Ke committed
66
    }
Guolin Ke's avatar
Guolin Ke committed
67
    valid_metrics_.shrink_to_fit();
Guolin Ke's avatar
Guolin Ke committed
68
    // initialize the objective function
Guolin Ke's avatar
Guolin Ke committed
69
70
71
    if (objective_fun_ != nullptr) {
      objective_fun_->Init(train_data_->metadata(), train_data_->num_data());
    }
Guolin Ke's avatar
Guolin Ke committed
72
    // initialize the boosting
Guolin Ke's avatar
Guolin Ke committed
73
74
    boosting_->Init(&config_.boosting_config, train_data_, objective_fun_.get(),
      Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
Guolin Ke's avatar
Guolin Ke committed
75
76
77
    // 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
78
        Common::ConstPtrInVectorWrapper<Metric>(valid_metrics_[i]));
Guolin Ke's avatar
Guolin Ke committed
79
80
    }
  }
Guolin Ke's avatar
Guolin Ke committed
81

82
83
84
  void LoadModelFromFile(const char* filename) {
    Boosting::LoadFileToBoosting(boosting_.get(), filename);
  }
Guolin Ke's avatar
Guolin Ke committed
85

Guolin Ke's avatar
Guolin Ke committed
86
  ~Booster() {
Guolin Ke's avatar
Guolin Ke committed
87

Guolin Ke's avatar
Guolin Ke committed
88
  }
Guolin Ke's avatar
Guolin Ke committed
89

90
91
92
93
94
95
96
97
  bool TrainOneIter() {
    return boosting_->TrainOneIter(nullptr, nullptr, false);
  }

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

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

Guolin Ke's avatar
Guolin Ke committed
112
113
114
115
  void GetPredictAt(int data_idx, score_t* out_result, data_size_t* out_len) {
    boosting_->GetPredictAt(data_idx, out_result, out_len);
  }

Guolin Ke's avatar
Guolin Ke committed
116
117
  std::vector<double> Predict(const std::vector<std::pair<int, double>>& features) {
    return predictor_->GetPredictFunction()(features);
118
119
  }

120
121
122
123
  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
124
125
  void SaveModelToFile(int num_iteration, const char* filename) {
    boosting_->SaveModelToFile(num_iteration, true, filename);
Guolin Ke's avatar
Guolin Ke committed
126
  }
Guolin Ke's avatar
Guolin Ke committed
127
128
129
130
131
132
133
134
135

  int GetEvalCounts() const {
    int ret = 0;
    for (const auto& metric : train_metric_) {
      ret += static_cast<int>(metric->GetName().size());
    }
    return ret;
  }

Guolin Ke's avatar
Guolin Ke committed
136
  int GetEvalNames(char** out_strs) const {
Guolin Ke's avatar
Guolin Ke committed
137
138
139
    int idx = 0;
    for (const auto& metric : train_metric_) {
      for (const auto& name : metric->GetName()) {
Guolin Ke's avatar
Guolin Ke committed
140
141
142
143
144
145
146
147
        int j = 0;
        auto name_cstr = name.c_str();
        while (name_cstr[j] != '\0') {
          out_strs[idx][j] = name_cstr[j];
          ++j;
        }
        out_strs[idx][j] = '\0';
        ++idx;
Guolin Ke's avatar
Guolin Ke committed
148
149
150
151
152
      }
    }
    return idx;
  }

Guolin Ke's avatar
Guolin Ke committed
153
  const Boosting* GetBoosting() const { return boosting_.get(); }
Guolin Ke's avatar
Guolin Ke committed
154
  
Guolin Ke's avatar
Guolin Ke committed
155
private:
156

Guolin Ke's avatar
Guolin Ke committed
157
  std::unique_ptr<Boosting> boosting_;
Guolin Ke's avatar
Guolin Ke committed
158
159
160
161
162
163
164
  /*! \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
165
  std::vector<std::unique_ptr<Metric>> train_metric_;
Guolin Ke's avatar
Guolin Ke committed
166
  /*! \brief Metrics for validation data */
Guolin Ke's avatar
Guolin Ke committed
167
  std::vector<std::vector<std::unique_ptr<Metric>>> valid_metrics_;
Guolin Ke's avatar
Guolin Ke committed
168
  /*! \brief Training objective function */
Guolin Ke's avatar
Guolin Ke committed
169
  std::unique_ptr<ObjectiveFunction> objective_fun_;
Guolin Ke's avatar
Guolin Ke committed
170
  /*! \brief Using predictor for prediction task */
Guolin Ke's avatar
Guolin Ke committed
171
  std::unique_ptr<Predictor> predictor_;
172

Guolin Ke's avatar
Guolin Ke committed
173
174
175
};

}
Guolin Ke's avatar
Guolin Ke committed
176
177
178

using namespace LightGBM;

Guolin Ke's avatar
Guolin Ke committed
179
DllExport const char* LGBM_GetLastError() {
180
  return LastErrorMsg().c_str();
Guolin Ke's avatar
Guolin Ke committed
181
182
183
184
185
186
}

DllExport int LGBM_CreateDatasetFromFile(const char* filename,
  const char* parameters,
  const DatesetHandle* reference,
  DatesetHandle* out) {
187
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
188
189
190
  OverallConfig config;
  config.LoadFromString(parameters);
  DatasetLoader loader(config.io_config, nullptr);
191
  loader.SetHeader(filename);
Guolin Ke's avatar
Guolin Ke committed
192
  if (reference == nullptr) {
Guolin Ke's avatar
Guolin Ke committed
193
    *out = loader.LoadFromFile(filename);
Guolin Ke's avatar
Guolin Ke committed
194
  } else {
Guolin Ke's avatar
Guolin Ke committed
195
196
    *out = loader.LoadFromFileAlignWithOtherDataset(filename,
      reinterpret_cast<const Dataset*>(*reference));
Guolin Ke's avatar
Guolin Ke committed
197
  }
198
  API_END();
Guolin Ke's avatar
Guolin Ke committed
199
200
201
202
}

DllExport int LGBM_CreateDatasetFromBinaryFile(const char* filename,
  DatesetHandle* out) {
203
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
204
205
  OverallConfig config;
  DatasetLoader loader(config.io_config, nullptr);
Guolin Ke's avatar
Guolin Ke committed
206
  *out = loader.LoadFromBinFile(filename, 0, 1);
207
  API_END();
Guolin Ke's avatar
Guolin Ke committed
208
209
210
}

DllExport int LGBM_CreateDatasetFromMat(const void* data,
211
  int data_type,
Guolin Ke's avatar
Guolin Ke committed
212
213
214
215
216
217
  int32_t nrow,
  int32_t ncol,
  int is_row_major,
  const char* parameters,
  const DatesetHandle* reference,
  DatesetHandle* out) {
218
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
219
220
221
  OverallConfig config;
  config.LoadFromString(parameters);
  DatasetLoader loader(config.io_config, nullptr);
Guolin Ke's avatar
Guolin Ke committed
222
  std::unique_ptr<Dataset> ret;
223
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
Guolin Ke's avatar
Guolin Ke committed
224
225
226
  if (reference == nullptr) {
    // sample data first
    Random rand(config.io_config.data_random_seed);
227
    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
228
    auto sample_indices = rand.Sample(nrow, sample_cnt);
229
    std::vector<std::vector<double>> sample_values(ncol);
Guolin Ke's avatar
Guolin Ke committed
230
    for (size_t i = 0; i < sample_indices.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
231
      auto idx = sample_indices[i];
232
      auto row = get_row_fun(static_cast<int>(idx));
Guolin Ke's avatar
Guolin Ke committed
233
      for (size_t j = 0; j < row.size(); ++j) {
Guolin Ke's avatar
Guolin Ke committed
234
235
236
        if (std::fabs(row[j]) > 1e-15) {
          sample_values[j].push_back(row[j]);
        }
Guolin Ke's avatar
Guolin Ke committed
237
238
      }
    }
Guolin Ke's avatar
Guolin Ke committed
239
    ret.reset(loader.CostructFromSampleData(sample_values, sample_cnt, nrow));
Guolin Ke's avatar
Guolin Ke committed
240
  } else {
Guolin Ke's avatar
Guolin Ke committed
241
242
    ret.reset(new Dataset(nrow, config.io_config.num_class));
    ret->CopyFeatureMapperFrom(
Guolin Ke's avatar
Guolin Ke committed
243
      reinterpret_cast<const Dataset*>(*reference),
Guolin Ke's avatar
Guolin Ke committed
244
      config.io_config.is_enable_sparse);
Guolin Ke's avatar
Guolin Ke committed
245
246
247
248
249
  }

#pragma omp parallel for schedule(guided)
  for (int i = 0; i < nrow; ++i) {
    const int tid = omp_get_thread_num();
250
    auto one_row = get_row_fun(i);
Guolin Ke's avatar
Guolin Ke committed
251
252
253
    ret->PushOneRow(tid, i, one_row);
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
254
  *out = ret.release();
255
  API_END();
256
257
}

258
259
DllExport int LGBM_CreateDatasetFromCSR(const void* indptr,
  int indptr_type,
260
261
  const int32_t* indices,
  const void* data,
262
263
264
265
  int data_type,
  int64_t nindptr,
  int64_t nelem,
  int64_t num_col,
266
267
268
  const char* parameters,
  const DatesetHandle* reference,
  DatesetHandle* out) {
269
  API_BEGIN();
270
271
272
  OverallConfig config;
  config.LoadFromString(parameters);
  DatasetLoader loader(config.io_config, nullptr);
Guolin Ke's avatar
Guolin Ke committed
273
  std::unique_ptr<Dataset> ret;
274
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
275
276
277
278
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (reference == nullptr) {
    // sample data first
    Random rand(config.io_config.data_random_seed);
279
    const int sample_cnt = static_cast<int>(nrow < config.io_config.bin_construct_sample_cnt ? nrow : config.io_config.bin_construct_sample_cnt);
280
281
282
283
284
285
    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
286
287
288
289
290
291
292
        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();
            }
293
          }
Guolin Ke's avatar
Guolin Ke committed
294
295
          // edit the feature value
          sample_values[inner_data.first].push_back(inner_data.second);
296
297
298
        }
      }
    }
299
    CHECK(num_col >= static_cast<int>(sample_values.size()));
Guolin Ke's avatar
Guolin Ke committed
300
    ret.reset(loader.CostructFromSampleData(sample_values, sample_cnt, nrow));
301
  } else {
Guolin Ke's avatar
Guolin Ke committed
302
303
    ret.reset(new Dataset(nrow, config.io_config.num_class));
    ret->CopyFeatureMapperFrom(
Guolin Ke's avatar
Guolin Ke committed
304
      reinterpret_cast<const Dataset*>(*reference),
Guolin Ke's avatar
Guolin Ke committed
305
      config.io_config.is_enable_sparse);
306
307
308
309
310
311
312
313
314
  }

#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
315
  *out = ret.release();
316
  API_END();
317
318
}

319
320
DllExport int LGBM_CreateDatasetFromCSC(const void* col_ptr,
  int col_ptr_type,
Guolin Ke's avatar
Guolin Ke committed
321
322
  const int32_t* indices,
  const void* data,
323
324
325
326
  int data_type,
  int64_t ncol_ptr,
  int64_t nelem,
  int64_t num_row,
Guolin Ke's avatar
Guolin Ke committed
327
328
329
  const char* parameters,
  const DatesetHandle* reference,
  DatesetHandle* out) {
330
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
331
332
333
  OverallConfig config;
  config.LoadFromString(parameters);
  DatasetLoader loader(config.io_config, nullptr);
Guolin Ke's avatar
Guolin Ke committed
334
  std::unique_ptr<Dataset> ret;
335
  auto get_col_fun = ColumnFunctionFromCSC(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
336
337
338
339
340
  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);
341
    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
342
343
344
345
346
    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);
347
      sample_values[i] = SampleFromOneColumn(cur_col, sample_indices);
Guolin Ke's avatar
Guolin Ke committed
348
    }
Guolin Ke's avatar
Guolin Ke committed
349
    ret.reset(loader.CostructFromSampleData(sample_values, sample_cnt, nrow));
Guolin Ke's avatar
Guolin Ke committed
350
  } else {
Guolin Ke's avatar
Guolin Ke committed
351
352
    ret.reset(new Dataset(nrow, config.io_config.num_class));
    ret->CopyFeatureMapperFrom(
Guolin Ke's avatar
Guolin Ke committed
353
      reinterpret_cast<const Dataset*>(*reference),
Guolin Ke's avatar
Guolin Ke committed
354
      config.io_config.is_enable_sparse);
Guolin Ke's avatar
Guolin Ke committed
355
356
357
358
359
360
  }

#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
361
    ret->PushOneColumn(tid, i, one_col);
Guolin Ke's avatar
Guolin Ke committed
362
363
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
364
  *out = ret.release();
365
  API_END();
Guolin Ke's avatar
Guolin Ke committed
366
367
}

368
DllExport int LGBM_DatasetFree(DatesetHandle handle) {
369
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
370
  delete reinterpret_cast<Dataset*>(handle);
371
  API_END();
372
373
374
375
}

DllExport int LGBM_DatasetSaveBinary(DatesetHandle handle,
  const char* filename) {
376
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
377
378
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->SaveBinaryFile(filename);
379
  API_END();
380
381
382
383
384
}

DllExport int LGBM_DatasetSetField(DatesetHandle handle,
  const char* field_name,
  const void* field_data,
385
  int64_t num_element,
386
  int type) {
387
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
388
  auto dataset = reinterpret_cast<Dataset*>(handle);
389
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
390
  if (type == C_API_DTYPE_FLOAT32) {
Guolin Ke's avatar
Guolin Ke committed
391
    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
392
  } else if (type == C_API_DTYPE_INT32) {
Guolin Ke's avatar
Guolin Ke committed
393
    is_success = dataset->SetIntField(field_name, reinterpret_cast<const int*>(field_data), static_cast<int32_t>(num_element));
394
  }
395
396
  if (!is_success) { throw std::runtime_error("Input data type erorr or field not found"); }
  API_END();
397
398
399
400
}

DllExport int LGBM_DatasetGetField(DatesetHandle handle,
  const char* field_name,
401
  int64_t* out_len,
402
403
  const void** out_ptr,
  int* out_type) {
404
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
405
  auto dataset = reinterpret_cast<Dataset*>(handle);
406
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
407
  if (dataset->GetFloatField(field_name, out_len, reinterpret_cast<const float**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
408
    *out_type = C_API_DTYPE_FLOAT32;
409
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
410
  } else if (dataset->GetIntField(field_name, out_len, reinterpret_cast<const int**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
411
    *out_type = C_API_DTYPE_INT32;
412
    is_success = true;
413
  }
Guolin Ke's avatar
Guolin Ke committed
414
  if (!is_success) { throw std::runtime_error("Field not found or not exist"); }
415
  API_END();
416
417
418
}

DllExport int LGBM_DatasetGetNumData(DatesetHandle handle,
419
  int64_t* out) {
420
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
421
422
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_data();
423
  API_END();
424
425
426
}

DllExport int LGBM_DatasetGetNumFeature(DatesetHandle handle,
427
  int64_t* out) {
428
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
429
430
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_total_features();
431
  API_END();
Guolin Ke's avatar
Guolin Ke committed
432
}
433
434
435
436
437
438
439
440


// ---- start of booster

DllExport int LGBM_BoosterCreate(const DatesetHandle train_data,
  const DatesetHandle valid_datas[],
  int n_valid_datas,
  const char* parameters,
441
  const char* init_model_filename,
442
  BoosterHandle* out) {
443
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
444
  const Dataset* p_train_data = reinterpret_cast<const Dataset*>(train_data);
445
446
  std::vector<const Dataset*> p_valid_datas;
  for (int i = 0; i < n_valid_datas; ++i) {
Guolin Ke's avatar
Guolin Ke committed
447
    p_valid_datas.emplace_back(reinterpret_cast<const Dataset*>(valid_datas[i]));
448
  }
Guolin Ke's avatar
Guolin Ke committed
449
  auto ret = std::unique_ptr<Booster>(new Booster(p_train_data, p_valid_datas, parameters));
450
451
452
453
  if (init_model_filename != nullptr) {
    ret->LoadModelFromFile(init_model_filename);
  }
  *out = ret.release();
454
  API_END();
455
456
}

457
DllExport int LGBM_BoosterCreateFromModelfile(
458
  const char* filename,
Guolin Ke's avatar
Guolin Ke committed
459
  int64_t* num_total_model,
460
  BoosterHandle* out) {
461
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
462
463
464
  auto ret = std::unique_ptr<Booster>(new Booster(filename));
  *num_total_model = static_cast<int64_t>(ret->GetBoosting()->NumberOfTotalModel());
  *out = ret.release();
465
  API_END();
466
467
468
}

DllExport int LGBM_BoosterFree(BoosterHandle handle) {
469
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
470
  delete reinterpret_cast<Booster*>(handle);
471
  API_END();
472
473
}

Guolin Ke's avatar
Guolin Ke committed
474
475
476
477
478
479
480
DllExport int LGBM_BoosterGetNumClasses(BoosterHandle handle, int64_t* out_len) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->NumberOfClasses();
  API_END();
}

481
DllExport int LGBM_BoosterUpdateOneIter(BoosterHandle handle, int* is_finished) {
482
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
483
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
484
485
486
487
488
  if (ref_booster->TrainOneIter()) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
489
  API_END();
490
491
492
493
494
495
}

DllExport int LGBM_BoosterUpdateOneIterCustom(BoosterHandle handle,
  const float* grad,
  const float* hess,
  int* is_finished) {
496
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
497
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
498
499
500
501
502
  if (ref_booster->TrainOneIter(grad, hess)) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
503
  API_END();
504
505
}

Guolin Ke's avatar
Guolin Ke committed
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
/*!
* \brief Get number of eval
* \return total number of eval result
*/
DllExport int LGBM_BoosterGetEvalCounts(BoosterHandle handle, int64_t* out_len) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalCounts();
  API_END();
}

/*!
* \brief Get number of eval
* \return total number of eval result
*/
Guolin Ke's avatar
Guolin Ke committed
521
DllExport int LGBM_BoosterGetEvalNames(BoosterHandle handle, int64_t* out_len, char** out_strs) {
Guolin Ke's avatar
Guolin Ke committed
522
523
524
525
526
527
528
529
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalNames(out_strs);
  API_END();
}


DllExport int LGBM_BoosterGetEval(BoosterHandle handle,
530
  int data,
531
  int64_t* out_len,
Guolin Ke's avatar
Guolin Ke committed
532
  float* out_results) {
533
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
534
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
535
536
  auto boosting = ref_booster->GetBoosting();
  auto result_buf = boosting->GetEvalAt(data);
537
  *out_len = static_cast<int64_t>(result_buf.size());
538
  for (size_t i = 0; i < result_buf.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
539
    (out_results)[i] = static_cast<float>(result_buf[i]);
540
  }
541
  API_END();
542
543
}

Guolin Ke's avatar
Guolin Ke committed
544
545
DllExport int LGBM_BoosterGetPredict(BoosterHandle handle,
  int data,
546
  int64_t* out_len,
Guolin Ke's avatar
Guolin Ke committed
547
  float* out_result) {
548
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
549
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
550
  int len = 0;
Guolin Ke's avatar
Guolin Ke committed
551
  ref_booster->GetPredictAt(data, out_result, &len);
552
  *out_len = static_cast<int64_t>(len);
553
  API_END();
Guolin Ke's avatar
Guolin Ke committed
554
555
}

556
557
DllExport int LGBM_BoosterPredictForFile(BoosterHandle handle,
  const char* data_filename,
Guolin Ke's avatar
Guolin Ke committed
558
559
560
  int data_has_header,
  int predict_type,
  int64_t num_iteration,
561
  const char* result_filename) {
562
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
563
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
564
  ref_booster->PrepareForPrediction(static_cast<int>(num_iteration), predict_type);
565
566
  bool bool_data_has_header = data_has_header > 0 ? true : false;
  ref_booster->PredictForFile(data_filename, result_filename, bool_data_has_header);
567
  API_END();
568
569
}

570
DllExport int LGBM_BoosterPredictForCSR(BoosterHandle handle,
571
572
  const void* indptr,
  int indptr_type,
573
574
  const int32_t* indices,
  const void* data,
575
576
577
578
  int data_type,
  int64_t nindptr,
  int64_t nelem,
  int64_t,
579
  int predict_type,
Guolin Ke's avatar
Guolin Ke committed
580
581
582
  int64_t num_iteration,
  int64_t* out_len,
  float* out_result) {
583
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
584
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
585
  ref_booster->PrepareForPrediction(static_cast<int>(num_iteration), predict_type);
Guolin Ke's avatar
Guolin Ke committed
586

587
  auto get_row_fun = RowFunctionFromCSR(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
588
589
590
591
592
593
594
595
  int num_preb_in_one_row = ref_booster->GetBoosting()->NumberOfClasses();
  if (predict_type == C_API_PREDICT_LEAF_INDEX) {
    if (num_iteration > 0) {
      num_preb_in_one_row *= static_cast<int>(num_iteration);
    } else {
      num_preb_in_one_row *= ref_booster->GetBoosting()->NumberOfTotalModel() / num_preb_in_one_row;
    }
  }
Guolin Ke's avatar
Guolin Ke committed
596
597
598
599
600
  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
601
602
    for (int j = 0; j < static_cast<int>(predicton_result.size()); ++j) {
      out_result[i * num_preb_in_one_row + j] = static_cast<float>(predicton_result[j]);
Guolin Ke's avatar
Guolin Ke committed
603
604
    }
  }
Guolin Ke's avatar
Guolin Ke committed
605
  *out_len = nrow * num_preb_in_one_row;
606
  API_END();
Guolin Ke's avatar
Guolin Ke committed
607
}
608
609
610

DllExport int LGBM_BoosterPredictForMat(BoosterHandle handle,
  const void* data,
611
  int data_type,
612
613
  int32_t nrow,
  int32_t ncol,
Guolin Ke's avatar
Guolin Ke committed
614
  int is_row_major,
615
  int predict_type,
Guolin Ke's avatar
Guolin Ke committed
616
617
618
  int64_t num_iteration,
  int64_t* out_len,
  float* out_result) {
619
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
620
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
621
  ref_booster->PrepareForPrediction(static_cast<int>(num_iteration), predict_type);
Guolin Ke's avatar
Guolin Ke committed
622

623
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
Guolin Ke's avatar
Guolin Ke committed
624
625
626
627
628
629
630
631
  int num_preb_in_one_row = ref_booster->GetBoosting()->NumberOfClasses();
  if (predict_type == C_API_PREDICT_LEAF_INDEX) {
    if (num_iteration > 0) {
      num_preb_in_one_row *= static_cast<int>(num_iteration);
    } else {
      num_preb_in_one_row *= ref_booster->GetBoosting()->NumberOfTotalModel() / num_preb_in_one_row;
    }
  }
Guolin Ke's avatar
Guolin Ke committed
632
633
634
635
#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
636
637
    for (int j = 0; j < static_cast<int>(predicton_result.size()); ++j) {
      out_result[i * num_preb_in_one_row + j] = static_cast<float>(predicton_result[j]);
Guolin Ke's avatar
Guolin Ke committed
638
639
    }
  }
Guolin Ke's avatar
Guolin Ke committed
640
  *out_len = nrow * num_preb_in_one_row;
641
  API_END();
Guolin Ke's avatar
Guolin Ke committed
642
}
643
644

DllExport int LGBM_BoosterSaveModel(BoosterHandle handle,
Guolin Ke's avatar
Guolin Ke committed
645
  int num_iteration,
Guolin Ke's avatar
Guolin Ke committed
646
  const char* filename) {
647
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
648
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
649
  ref_booster->SaveModelToFile(num_iteration, filename);
650
  API_END();
Guolin Ke's avatar
Guolin Ke committed
651
}
652

Guolin Ke's avatar
Guolin Ke committed
653
// ---- start of some help functions
654
655
656

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
657
  if (data_type == C_API_DTYPE_FLOAT32) {
658
659
660
    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
661
        std::vector<double> ret(num_col);
662
663
        auto tmp_ptr = data_ptr + num_col * row_idx;
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
664
          ret[i] = static_cast<double>(*(tmp_ptr + i));
665
666
667
668
669
        }
        return ret;
      };
    } else {
      return [data_ptr, num_col, num_row](int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
670
        std::vector<double> ret(num_col);
671
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
672
          ret[i] = static_cast<double>(*(data_ptr + num_row * i + row_idx));
673
674
675
676
        }
        return ret;
      };
    }
Guolin Ke's avatar
Guolin Ke committed
677
  } else if (data_type == C_API_DTYPE_FLOAT64) {
678
679
680
    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
681
        std::vector<double> ret(num_col);
682
683
        auto tmp_ptr = data_ptr + num_col * row_idx;
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
684
          ret[i] = static_cast<double>(*(tmp_ptr + i));
685
686
687
688
689
        }
        return ret;
      };
    } else {
      return [data_ptr, num_col, num_row](int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
690
        std::vector<double> ret(num_col);
691
        for (int i = 0; i < num_col; ++i) {
Guolin Ke's avatar
Guolin Ke committed
692
          ret[i] = static_cast<double>(*(data_ptr + num_row * i + row_idx));
693
694
695
696
697
        }
        return ret;
      };
    }
  }
Guolin Ke's avatar
Guolin Ke committed
698
  throw std::runtime_error("unknown data type in RowFunctionFromDenseMatric");
699
700
701
702
}

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
703
704
705
706
707
708
709
710
  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]);
711
        }
Guolin Ke's avatar
Guolin Ke committed
712
713
714
      }
      return ret;
    };
715
  }
Guolin Ke's avatar
Guolin Ke committed
716
  return nullptr;
717
718
719
720
}

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

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
777
  if (data_type == C_API_DTYPE_FLOAT32) {
778
    const float* data_ptr = reinterpret_cast<const float*>(data);
Guolin Ke's avatar
Guolin Ke committed
779
    if (col_ptr_type == C_API_DTYPE_INT32) {
780
781
782
783
784
785
786
787
788
789
      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
790
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
791
792
793
794
795
796
797
798
799
800
      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
801
    } 
Guolin Ke's avatar
Guolin Ke committed
802
  } else if (data_type == C_API_DTYPE_FLOAT64) {
803
    const double* data_ptr = reinterpret_cast<const double*>(data);
Guolin Ke's avatar
Guolin Ke committed
804
    if (col_ptr_type == C_API_DTYPE_INT32) {
805
806
807
808
809
810
811
812
813
814
      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
815
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
816
817
818
819
820
821
822
823
824
825
      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
826
827
828
    } 
  } 
  throw std::runtime_error("unknown data type in ColumnFunctionFromCSC");
829
830
}

831
std::vector<double> SampleFromOneColumn(const std::vector<std::pair<int, double>>& data, const std::vector<int>& indices) {
832
833
834
835
836
837
838
839
840
841
842
  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
843
}