c_api.h 33.2 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
#ifndef LIGHTGBM_C_API_H_
#define LIGHTGBM_C_API_H_
ww's avatar
ww committed
3

4
#include <cstdint>
wxchan's avatar
wxchan committed
5
6
#include <cstring>

7
8
9
/*!
* To avoid type conversion on large data, most of our expose interface support both for float_32 and float_64.
* Except following:
wxchan's avatar
wxchan committed
10
* 1. gradients and hessians.
11
* 2. Get current score for training data and validation
wxchan's avatar
wxchan committed
12
* The reason is because they are called frequently, the type-conversion on them maybe time cost.
13
14
*/

15
#include <LightGBM/export.h>
Guolin Ke's avatar
Guolin Ke committed
16

Guolin Ke's avatar
typo  
Guolin Ke committed
17
typedef void* DatasetHandle;
Guolin Ke's avatar
Guolin Ke committed
18
19
typedef void* BoosterHandle;

Guolin Ke's avatar
Guolin Ke committed
20
21
22
23
24
25
26
27
#define C_API_DTYPE_FLOAT32 (0)
#define C_API_DTYPE_FLOAT64 (1)
#define C_API_DTYPE_INT32   (2)
#define C_API_DTYPE_INT64   (3)

#define C_API_PREDICT_NORMAL     (0)
#define C_API_PREDICT_RAW_SCORE  (1)
#define C_API_PREDICT_LEAF_INDEX (2)
28
#define C_API_PREDICT_CONTRIB    (3)
29

Guolin Ke's avatar
Guolin Ke committed
30
31
/*!
* \brief get string message of the last error
wxchan's avatar
wxchan committed
32
*  all function in this file will return 0 when succeed
Guolin Ke's avatar
Guolin Ke committed
33
34
35
*  and -1 when an error occured,
* \return const char* error inforomation
*/
36
LIGHTGBM_C_EXPORT const char* LGBM_GetLastError();
Guolin Ke's avatar
Guolin Ke committed
37

Guolin Ke's avatar
Guolin Ke committed
38
// --- start Dataset interface
Guolin Ke's avatar
Guolin Ke committed
39
40
41
42

/*!
* \brief load data set from file like the command_line LightGBM do
* \param filename the name of the file
Guolin Ke's avatar
Guolin Ke committed
43
* \param parameters additional parameters
Guolin Ke's avatar
Guolin Ke committed
44
45
* \param reference used to align bin mapper with other dataset, nullptr means don't used
* \param out a loaded dataset
wxchan's avatar
wxchan committed
46
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
47
*/
48
LIGHTGBM_C_EXPORT int LGBM_DatasetCreateFromFile(const char* filename,
49
50
51
                                                 const char* parameters,
                                                 const DatasetHandle reference,
                                                 DatasetHandle* out);
Guolin Ke's avatar
Guolin Ke committed
52

53
/*!
54
55
* \brief create a empty dataset by sampling data.
* \param sample_data sampled data, grouped by the column.
56
* \param sample_indices indices of sampled data.
57
* \param ncol number columns
58
59
* \param num_per_col Size of each sampling column
* \param num_sample_row Number of sampled rows
60
61
62
63
64
* \param num_total_row number of total rows
* \param parameters additional parameters
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
65
66
67
68
69
70
71
72
LIGHTGBM_C_EXPORT int LGBM_DatasetCreateFromSampledColumn(double** sample_data,
                                                          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);
Guolin Ke's avatar
Guolin Ke committed
73
74
75
76
77
78
79
80
81

/*!
* \brief create a empty dataset by reference Dataset
* \param reference used to align bin mapper
* \param num_total_row number of total rows
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_DatasetCreateByReference(const DatasetHandle reference,
82
83
                                                    int64_t num_total_row,
                                                    DatasetHandle* out);
Guolin Ke's avatar
Guolin Ke committed
84
85
86
87
88
89
90
91
92
93
94
95

/*!
* \brief push data to existing dataset, if nrow + start_row == num_total_row, will call dataset->FinishLoad
* \param dataset handle of dataset
* \param data pointer to the data space
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
* \param nrow number of rows
* \param ncol number columns
* \param start_row row start index
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_DatasetPushRows(DatasetHandle dataset,
96
97
98
99
100
                                           const void* data,
                                           int data_type,
                                           int32_t nrow,
                                           int32_t ncol,
                                           int32_t start_row);
Guolin Ke's avatar
Guolin Ke committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

/*!
* \brief push data to existing dataset, if nrow + start_row == num_total_row, will call dataset->FinishLoad
* \param dataset handle of dataset
* \param indptr pointer to row headers
* \param indptr_type type of indptr, can be C_API_DTYPE_INT32 or C_API_DTYPE_INT64
* \param indices findex
* \param data fvalue
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
* \param nindptr number of rows in the matrix + 1
* \param nelem number of nonzero elements in the matrix
* \param num_col number of columns
* \param start_row row start index
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_DatasetPushRowsByCSR(DatasetHandle dataset,
117
118
119
120
121
122
123
124
125
                                                const void* indptr,
                                                int indptr_type,
                                                const int32_t* indices,
                                                const void* data,
                                                int data_type,
                                                int64_t nindptr,
                                                int64_t nelem,
                                                int64_t num_col,
                                                int64_t start_row);
Guolin Ke's avatar
Guolin Ke committed
126

Guolin Ke's avatar
Guolin Ke committed
127
128
129
/*!
* \brief create a dataset from CSR format
* \param indptr pointer to row headers
wxchan's avatar
wxchan committed
130
* \param indptr_type type of indptr, can be C_API_DTYPE_INT32 or C_API_DTYPE_INT64
Guolin Ke's avatar
Guolin Ke committed
131
132
* \param indices findex
* \param data fvalue
wxchan's avatar
wxchan committed
133
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
Guolin Ke's avatar
Guolin Ke committed
134
* \param nindptr number of rows in the matrix + 1
Guolin Ke's avatar
Guolin Ke committed
135
* \param nelem number of nonzero elements in the matrix
wxchan's avatar
wxchan committed
136
* \param num_col number of columns
Guolin Ke's avatar
Guolin Ke committed
137
* \param parameters additional parameters
Guolin Ke's avatar
Guolin Ke committed
138
139
* \param reference used to align bin mapper with other dataset, nullptr means don't used
* \param out created dataset
wxchan's avatar
wxchan committed
140
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
141
*/
142
LIGHTGBM_C_EXPORT int LGBM_DatasetCreateFromCSR(const void* indptr,
143
144
145
146
147
148
149
150
151
152
                                                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);
Guolin Ke's avatar
Guolin Ke committed
153
154
155
156

/*!
* \brief create a dataset from CSC format
* \param col_ptr pointer to col headers
wxchan's avatar
wxchan committed
157
* \param col_ptr_type type of col_ptr, can be C_API_DTYPE_INT32 or C_API_DTYPE_INT64
Guolin Ke's avatar
Guolin Ke committed
158
159
* \param indices findex
* \param data fvalue
wxchan's avatar
wxchan committed
160
161
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
* \param ncol_ptr number of cols in the matrix + 1
Guolin Ke's avatar
Guolin Ke committed
162
* \param nelem number of nonzero elements in the matrix
wxchan's avatar
wxchan committed
163
* \param num_row number of rows
Guolin Ke's avatar
Guolin Ke committed
164
165
166
* \param parameters additional parameters
* \param reference used to align bin mapper with other dataset, nullptr means don't used
* \param out created dataset
wxchan's avatar
wxchan committed
167
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
168
*/
169
LIGHTGBM_C_EXPORT int LGBM_DatasetCreateFromCSC(const void* col_ptr,
170
171
172
173
174
175
176
177
178
179
                                                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);
Guolin Ke's avatar
Guolin Ke committed
180
181
182
183

/*!
* \brief create dataset from dense matrix
* \param data pointer to the data space
wxchan's avatar
wxchan committed
184
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
Guolin Ke's avatar
Guolin Ke committed
185
186
* \param nrow number of rows
* \param ncol number columns
187
* \param is_row_major 1 for row major, 0 for column major
Guolin Ke's avatar
Guolin Ke committed
188
* \param parameters additional parameters
Guolin Ke's avatar
Guolin Ke committed
189
190
* \param reference used to align bin mapper with other dataset, nullptr means don't used
* \param out created dataset
wxchan's avatar
wxchan committed
191
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
192
*/
193
LIGHTGBM_C_EXPORT int LGBM_DatasetCreateFromMat(const void* data,
194
195
196
197
198
199
200
                                                int data_type,
                                                int32_t nrow,
                                                int32_t ncol,
                                                int is_row_major,
                                                const char* parameters,
                                                const DatasetHandle reference,
                                                DatasetHandle* out);
Guolin Ke's avatar
Guolin Ke committed
201

202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*!
* \brief create dataset from array of dense matrices
* \param data pointer to the data space
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
* \param nrow number of rows
* \param ncol number columns
* \param parameters additional parameters
* \param reference used to align bin mapper with other dataset, nullptr means don't used
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT 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);

wxchan's avatar
wxchan committed
223
224
225
226
227
228
229
230
231
/*!
* \brief Create subset of a data
* \param handle handle of full dataset
* \param used_row_indices Indices used in subset
* \param num_used_row_indices len of used_row_indices
* \param parameters additional parameters
* \param out subset of data
* \return 0 when succeed, -1 when failure happens
*/
232
LIGHTGBM_C_EXPORT int LGBM_DatasetGetSubset(
233
  const DatasetHandle handle,
wxchan's avatar
wxchan committed
234
235
236
  const int32_t* used_row_indices,
  int32_t num_used_row_indices,
  const char* parameters,
Guolin Ke's avatar
typo  
Guolin Ke committed
237
  DatasetHandle* out);
wxchan's avatar
wxchan committed
238

Guolin Ke's avatar
Guolin Ke committed
239
240
241
242
243
244
245
/*!
* \brief save feature names to Dataset
* \param handle handle
* \param feature_names feature names
* \param num_feature_names number of feature names
* \return 0 when succeed, -1 when failure happens
*/
246
LIGHTGBM_C_EXPORT int LGBM_DatasetSetFeatureNames(
Guolin Ke's avatar
typo  
Guolin Ke committed
247
  DatasetHandle handle,
Guolin Ke's avatar
Guolin Ke committed
248
  const char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
249
  int num_feature_names);
Guolin Ke's avatar
Guolin Ke committed
250

251
252
253
254
255
256
257
258

/*!
* \brief get feature names of Dataset
* \param handle handle
* \param feature_names feature names, should pre-allocate memory
* \param num_feature_names number of feature names
* \return 0 when succeed, -1 when failure happens
*/
259
LIGHTGBM_C_EXPORT int LGBM_DatasetGetFeatureNames(
260
261
  DatasetHandle handle,
  char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
262
  int* num_feature_names);
263
264


Guolin Ke's avatar
Guolin Ke committed
265
266
/*!
* \brief free space for dataset
wxchan's avatar
wxchan committed
267
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
268
*/
269
LIGHTGBM_C_EXPORT int LGBM_DatasetFree(DatasetHandle handle);
Guolin Ke's avatar
Guolin Ke committed
270
271
272
273
274

/*!
* \brief save dateset to binary file
* \param handle a instance of dataset
* \param filename file name
wxchan's avatar
wxchan committed
275
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
276
*/
277
LIGHTGBM_C_EXPORT int LGBM_DatasetSaveBinary(DatasetHandle handle,
278
                                             const char* filename);
Guolin Ke's avatar
Guolin Ke committed
279
280
281

/*!
* \brief set vector to a content in info
wxchan's avatar
wxchan committed
282
283
*        Note: group and group only work for C_API_DTYPE_INT32
*              label and weight only work for C_API_DTYPE_FLOAT32
Guolin Ke's avatar
Guolin Ke committed
284
* \param handle a instance of dataset
wxchan's avatar
wxchan committed
285
* \param field_name field name, can be label, weight, group, group_id
286
* \param field_data pointer to vector
Guolin Ke's avatar
Guolin Ke committed
287
* \param num_element number of element in field_data
wxchan's avatar
wxchan committed
288
289
* \param type C_API_DTYPE_FLOAT32 or C_API_DTYPE_INT32
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
290
*/
291
LIGHTGBM_C_EXPORT int LGBM_DatasetSetField(DatasetHandle handle,
292
293
294
295
                                           const char* field_name,
                                           const void* field_data,
                                           int num_element,
                                           int type);
Guolin Ke's avatar
Guolin Ke committed
296
297

/*!
298
* \brief get info vector from dataset
Guolin Ke's avatar
Guolin Ke committed
299
300
301
302
* \param handle a instance of data matrix
* \param field_name field name
* \param out_len used to set result length
* \param out_ptr pointer to the result
wxchan's avatar
wxchan committed
303
304
* \param out_type  C_API_DTYPE_FLOAT32 or C_API_DTYPE_INT32
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
305
*/
306
LIGHTGBM_C_EXPORT int LGBM_DatasetGetField(DatasetHandle handle,
307
308
309
310
                                           const char* field_name,
                                           int* out_len,
                                           const void** out_ptr,
                                           int* out_type);
Guolin Ke's avatar
Guolin Ke committed
311
312
313
314
315

/*!
* \brief get number of data.
* \param handle the handle to the dataset
* \param out The address to hold number of data
wxchan's avatar
wxchan committed
316
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
317
*/
318
LIGHTGBM_C_EXPORT int LGBM_DatasetGetNumData(DatasetHandle handle,
319
                                             int* out);
Guolin Ke's avatar
Guolin Ke committed
320
321
322
323
324

/*!
* \brief get number of features
* \param handle the handle to the dataset
* \param out The output of number of features
wxchan's avatar
wxchan committed
325
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
326
*/
327
LIGHTGBM_C_EXPORT int LGBM_DatasetGetNumFeature(DatasetHandle handle,
328
                                                int* out);
Guolin Ke's avatar
Guolin Ke committed
329
330
331
332
333

// --- start Booster interfaces

/*!
* \brief create an new boosting learner
Guolin Ke's avatar
Guolin Ke committed
334
* \param train_data training data set
Guolin Ke's avatar
Guolin Ke committed
335
336
* \param parameters format: 'key1=value1 key2=value2'
* \prama out handle of created Booster
wxchan's avatar
wxchan committed
337
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
338
*/
339
LIGHTGBM_C_EXPORT int LGBM_BoosterCreate(const DatasetHandle train_data,
340
341
                                         const char* parameters,
                                         BoosterHandle* out);
Guolin Ke's avatar
Guolin Ke committed
342
343

/*!
Guolin Ke's avatar
Guolin Ke committed
344
* \brief load an existing boosting from model file
Guolin Ke's avatar
Guolin Ke committed
345
* \param filename filename of model
wxchan's avatar
wxchan committed
346
* \param out_num_iterations number of iterations of this booster
Guolin Ke's avatar
Guolin Ke committed
347
* \param out handle of created Booster
wxchan's avatar
wxchan committed
348
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
349
*/
350
LIGHTGBM_C_EXPORT int LGBM_BoosterCreateFromModelfile(
Guolin Ke's avatar
Guolin Ke committed
351
  const char* filename,
Guolin Ke's avatar
Guolin Ke committed
352
  int* out_num_iterations,
Guolin Ke's avatar
Guolin Ke committed
353
354
  BoosterHandle* out);

355
356
357
358
359
360
361
362
363
364
365
/*!
* \brief load an existing boosting from string
* \param model_str model string
* \param out_num_iterations number of iterations of this booster
* \param out handle of created Booster
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_BoosterLoadModelFromString(
  const char* model_str,
  int* out_num_iterations,
  BoosterHandle* out);
wxchan's avatar
wxchan committed
366

Guolin Ke's avatar
Guolin Ke committed
367
368
369
/*!
* \brief free obj in handle
* \param handle handle to be freed
wxchan's avatar
wxchan committed
370
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
371
*/
372
LIGHTGBM_C_EXPORT int LGBM_BoosterFree(BoosterHandle handle);
Guolin Ke's avatar
Guolin Ke committed
373

wxchan's avatar
wxchan committed
374
375
376
377
378
379
/*!
* \brief Merge model in two booster to first handle
* \param handle handle, will merge other handle to this
* \param other_handle
* \return 0 when succeed, -1 when failure happens
*/
380
LIGHTGBM_C_EXPORT int LGBM_BoosterMerge(BoosterHandle handle,
381
                                        BoosterHandle other_handle);
wxchan's avatar
wxchan committed
382
383
384
385
386
387
388

/*!
* \brief Add new validation to booster
* \param handle handle
* \param valid_data validation data set
* \return 0 when succeed, -1 when failure happens
*/
389
LIGHTGBM_C_EXPORT int LGBM_BoosterAddValidData(BoosterHandle handle,
390
                                               const DatasetHandle valid_data);
wxchan's avatar
wxchan committed
391
392
393
394
395
396
397

/*!
* \brief Reset training data for booster
* \param handle handle
* \param train_data training data set
* \return 0 when succeed, -1 when failure happens
*/
398
LIGHTGBM_C_EXPORT int LGBM_BoosterResetTrainingData(BoosterHandle handle,
399
                                                    const DatasetHandle train_data);
wxchan's avatar
wxchan committed
400
401
402
403
404
405
406

/*!
* \brief Reset config for current booster
* \param handle handle
* \param parameters format: 'key1=value1 key2=value2'
* \return 0 when succeed, -1 when failure happens
*/
407
LIGHTGBM_C_EXPORT int LGBM_BoosterResetParameter(BoosterHandle handle, const char* parameters);
wxchan's avatar
wxchan committed
408
409

/*!
Guolin Ke's avatar
Guolin Ke committed
410
* \brief Get number of class
wxchan's avatar
wxchan committed
411
412
413
414
* \param handle handle
* \param out_len number of class
* \return 0 when succeed, -1 when failure happens
*/
415
LIGHTGBM_C_EXPORT int LGBM_BoosterGetNumClasses(BoosterHandle handle, int* out_len);
wxchan's avatar
wxchan committed
416

Guolin Ke's avatar
Guolin Ke committed
417
418
419
/*!
* \brief update the model in one round
* \param handle handle
Guolin Ke's avatar
Guolin Ke committed
420
* \param is_finished 1 means finised(cannot split any more)
wxchan's avatar
wxchan committed
421
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
422
*/
423
LIGHTGBM_C_EXPORT int LGBM_BoosterUpdateOneIter(BoosterHandle handle, int* is_finished);
Guolin Ke's avatar
Guolin Ke committed
424
425
426
427
428
429
430

/*!
* \brief update the model, by directly specify gradient and second order gradient,
*       this can be used to support customized loss function
* \param handle handle
* \param grad gradient statistics
* \param hess second order gradient statistics
Guolin Ke's avatar
Guolin Ke committed
431
* \param is_finished 1 means finised(cannot split any more)
wxchan's avatar
wxchan committed
432
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
433
*/
434
LIGHTGBM_C_EXPORT int LGBM_BoosterUpdateOneIterCustom(BoosterHandle handle,
435
436
437
                                                      const float* grad,
                                                      const float* hess,
                                                      int* is_finished);
Guolin Ke's avatar
Guolin Ke committed
438
439

/*!
wxchan's avatar
wxchan committed
440
* \brief Rollback one iteration
Guolin Ke's avatar
Guolin Ke committed
441
* \param handle handle
wxchan's avatar
wxchan committed
442
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
443
*/
444
LIGHTGBM_C_EXPORT int LGBM_BoosterRollbackOneIter(BoosterHandle handle);
wxchan's avatar
wxchan committed
445
446
447
448
449
450

/*!
* \brief Get iteration of current boosting rounds
* \param out_iteration iteration of boosting rounds
* \return 0 when succeed, -1 when failure happens
*/
451
LIGHTGBM_C_EXPORT int LGBM_BoosterGetCurrentIteration(BoosterHandle handle, int* out_iteration);
Guolin Ke's avatar
Guolin Ke committed
452

Guolin Ke's avatar
Guolin Ke committed
453
/*!
Guolin Ke's avatar
Guolin Ke committed
454
* \brief Get number of eval
wxchan's avatar
wxchan committed
455
456
457
* \param out_len total number of eval results
* \return 0 when succeed, -1 when failure happens
*/
458
LIGHTGBM_C_EXPORT int LGBM_BoosterGetEvalCounts(BoosterHandle handle, int* out_len);
wxchan's avatar
wxchan committed
459
460

/*!
wxchan's avatar
wxchan committed
461
* \brief Get name of eval
wxchan's avatar
wxchan committed
462
* \param out_len total number of eval results
Guolin Ke's avatar
typo  
Guolin Ke committed
463
* \param out_strs names of eval result, need to pre-allocate memory before call this
wxchan's avatar
wxchan committed
464
465
* \return 0 when succeed, -1 when failure happens
*/
466
LIGHTGBM_C_EXPORT int LGBM_BoosterGetEvalNames(BoosterHandle handle, int* out_len, char** out_strs);
wxchan's avatar
wxchan committed
467

wxchan's avatar
wxchan committed
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
/*!
* \brief Get name of features
* \param out_len total number of features
* \param out_strs names of features, need to pre-allocate memory before call this
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_BoosterGetFeatureNames(BoosterHandle handle, int* out_len, char** out_strs);

/*!
* \brief Get number of features
* \param out_len total number of features
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_BoosterGetNumFeature(BoosterHandle handle, int* out_len);

wxchan's avatar
wxchan committed
483
484
/*!
* \brief get evaluation for training data and validation data
Guolin Ke's avatar
Guolin Ke committed
485
486
Note: 1. you should call LGBM_BoosterGetEvalNames first to get the name of evaluation results
2. should pre-allocate memory for out_results, you can get its length by LGBM_BoosterGetEvalCounts
Guolin Ke's avatar
Guolin Ke committed
487
* \param handle handle
wxchan's avatar
wxchan committed
488
* \param data_idx 0:training data, 1: 1st valid data, 2:2nd valid data ...
Guolin Ke's avatar
Guolin Ke committed
489
* \param out_len len of output result
wxchan's avatar
wxchan committed
490
491
* \param out_result float arrary contains result
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
492
*/
493
LIGHTGBM_C_EXPORT int LGBM_BoosterGetEval(BoosterHandle handle,
494
495
496
                                          int data_idx,
                                          int* out_len,
                                          double* out_results);
Guolin Ke's avatar
Guolin Ke committed
497
498
499
500
501
502
503
504
505
506

/*!
* \brief Get number of predict for inner dataset
this can be used to support customized eval function
Note:  should pre-allocate memory for out_result, its length is equal to num_class * num_data
* \param handle handle
* \param data_idx 0:training data, 1: 1st valid data, 2:2nd valid data ...
* \param out_len len of output result
* \return 0 when succeed, -1 when failure happens
*/
507
LIGHTGBM_C_EXPORT int LGBM_BoosterGetNumPredict(BoosterHandle handle,
508
509
                                                int data_idx,
                                                int64_t* out_len);
Guolin Ke's avatar
Guolin Ke committed
510

Guolin Ke's avatar
Guolin Ke committed
511
/*!
Guolin Ke's avatar
Guolin Ke committed
512
* \brief Get prediction for training data and validation data
Guolin Ke's avatar
Guolin Ke committed
513
514
this can be used to support customized eval function
Note:  should pre-allocate memory for out_result, its length is equal to num_class * num_data
Guolin Ke's avatar
Guolin Ke committed
515
* \param handle handle
wxchan's avatar
wxchan committed
516
* \param data_idx 0:training data, 1: 1st valid data, 2:2nd valid data ...
Guolin Ke's avatar
Guolin Ke committed
517
* \param out_len len of output result
Guolin Ke's avatar
Guolin Ke committed
518
* \param out_result used to set a pointer to array, should allocate memory before call this function
wxchan's avatar
wxchan committed
519
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
520
*/
521
LIGHTGBM_C_EXPORT int LGBM_BoosterGetPredict(BoosterHandle handle,
522
523
524
                                             int data_idx,
                                             int64_t* out_len,
                                             double* out_result);
Guolin Ke's avatar
Guolin Ke committed
525

526
527
528
529
/*!
* \brief make prediction for file
* \param handle handle
* \param data_filename filename of data file
wxchan's avatar
wxchan committed
530
531
532
533
534
535
* \param data_has_header data file has header or not
* \param predict_type
*          C_API_PREDICT_NORMAL: normal prediction, with transform (if needed)
*          C_API_PREDICT_RAW_SCORE: raw score
*          C_API_PREDICT_LEAF_INDEX: leaf index
* \param num_iteration number of iteration for prediction, <= 0 means no limit
Guolin Ke's avatar
Guolin Ke committed
536
* \param parameter Other parameters for the parameters, e.g. early stopping for prediction.
537
* \param result_filename filename of result file
wxchan's avatar
wxchan committed
538
* \return 0 when succeed, -1 when failure happens
539
*/
540
LIGHTGBM_C_EXPORT int LGBM_BoosterPredictForFile(BoosterHandle handle,
541
542
543
544
                                                 const char* data_filename,
                                                 int data_has_header,
                                                 int predict_type,
                                                 int num_iteration,
545
                                                 const char* parameter,
546
                                                 const char* result_filename);
547

Guolin Ke's avatar
Guolin Ke committed
548
549
550
/*!
* \brief Get number of prediction
* \param handle handle
Guolin Ke's avatar
Guolin Ke committed
551
* \param num_row
Guolin Ke's avatar
Guolin Ke committed
552
553
554
555
556
* \param predict_type
*          C_API_PREDICT_NORMAL: normal prediction, with transform (if needed)
*          C_API_PREDICT_RAW_SCORE: raw score
*          C_API_PREDICT_LEAF_INDEX: leaf index
* \param num_iteration number of iteration for prediction, <= 0 means no limit
557
* \param out_len length of prediction
Guolin Ke's avatar
Guolin Ke committed
558
559
* \return 0 when succeed, -1 when failure happens
*/
560
LIGHTGBM_C_EXPORT int LGBM_BoosterCalcNumPredict(BoosterHandle handle,
561
562
563
564
                                                 int num_row,
                                                 int predict_type,
                                                 int num_iteration,
                                                 int64_t* out_len);
Guolin Ke's avatar
Guolin Ke committed
565

Guolin Ke's avatar
Guolin Ke committed
566
567
/*!
* \brief make prediction for an new data set
Guolin Ke's avatar
Guolin Ke committed
568
*        Note:  should pre-allocate memory for out_result,
wxchan's avatar
wxchan committed
569
570
*               for noraml and raw score: its length is equal to num_class * num_data
*               for leaf index, its length is equal to num_class * num_data * num_iteration
Guolin Ke's avatar
Guolin Ke committed
571
572
* \param handle handle
* \param indptr pointer to row headers
wxchan's avatar
wxchan committed
573
* \param indptr_type type of indptr, can be C_API_DTYPE_INT32 or C_API_DTYPE_INT64
Guolin Ke's avatar
Guolin Ke committed
574
575
* \param indices findex
* \param data fvalue
wxchan's avatar
wxchan committed
576
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
Guolin Ke's avatar
Guolin Ke committed
577
* \param nindptr number of rows in the matrix + 1
Guolin Ke's avatar
Guolin Ke committed
578
579
580
* \param nelem number of nonzero elements in the matrix
* \param num_col number of columns; when it's set to 0, then guess from data
* \param predict_type
wxchan's avatar
wxchan committed
581
582
583
584
*          C_API_PREDICT_NORMAL: normal prediction, with transform (if needed)
*          C_API_PREDICT_RAW_SCORE: raw score
*          C_API_PREDICT_LEAF_INDEX: leaf index
* \param num_iteration number of iteration for prediction, <= 0 means no limit
Guolin Ke's avatar
Guolin Ke committed
585
* \param parameter Other parameters for the parameters, e.g. early stopping for prediction.
wxchan's avatar
wxchan committed
586
* \param out_len len of output result
Guolin Ke's avatar
Guolin Ke committed
587
* \param out_result used to set a pointer to array, should allocate memory before call this function
wxchan's avatar
wxchan committed
588
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
589
*/
590
LIGHTGBM_C_EXPORT int LGBM_BoosterPredictForCSR(BoosterHandle handle,
591
592
593
594
595
596
597
598
599
600
                                                const void* indptr,
                                                int indptr_type,
                                                const int32_t* indices,
                                                const void* data,
                                                int data_type,
                                                int64_t nindptr,
                                                int64_t nelem,
                                                int64_t num_col,
                                                int predict_type,
                                                int num_iteration,
601
                                                const char* parameter,
602
603
                                                int64_t* out_len,
                                                double* out_result);
Guolin Ke's avatar
Guolin Ke committed
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623

/*!
* \brief make prediction for an new data set
*        Note:  should pre-allocate memory for out_result,
*               for noraml and raw score: its length is equal to num_class * num_data
*               for leaf index, its length is equal to num_class * num_data * num_iteration
* \param handle handle
* \param col_ptr pointer to col headers
* \param col_ptr_type type of col_ptr, can be C_API_DTYPE_INT32 or C_API_DTYPE_INT64
* \param indices findex
* \param data fvalue
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
* \param ncol_ptr number of cols in the matrix + 1
* \param nelem number of nonzero elements in the matrix
* \param num_row number of rows
* \param predict_type
*          C_API_PREDICT_NORMAL: normal prediction, with transform (if needed)
*          C_API_PREDICT_RAW_SCORE: raw score
*          C_API_PREDICT_LEAF_INDEX: leaf index
* \param num_iteration number of iteration for prediction, <= 0 means no limit
Guolin Ke's avatar
Guolin Ke committed
624
* \param parameter Other parameters for the parameters, e.g. early stopping for prediction.
Guolin Ke's avatar
Guolin Ke committed
625
626
627
628
* \param out_len len of output result
* \param out_result used to set a pointer to array, should allocate memory before call this function
* \return 0 when succeed, -1 when failure happens
*/
629
LIGHTGBM_C_EXPORT int LGBM_BoosterPredictForCSC(BoosterHandle handle,
630
631
632
633
634
635
636
637
638
639
                                                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,
640
                                                const char* parameter,
641
642
                                                int64_t* out_len,
                                                double* out_result);
Guolin Ke's avatar
Guolin Ke committed
643
644
645

/*!
* \brief make prediction for an new data set
wxchan's avatar
wxchan committed
646
647
648
*        Note:  should pre-allocate memory for out_result,
*               for noraml and raw score: its length is equal to num_class * num_data
*               for leaf index, its length is equal to num_class * num_data * num_iteration
Guolin Ke's avatar
Guolin Ke committed
649
650
* \param handle handle
* \param data pointer to the data space
wxchan's avatar
wxchan committed
651
* \param data_type type of data pointer, can be C_API_DTYPE_FLOAT32 or C_API_DTYPE_FLOAT64
Guolin Ke's avatar
Guolin Ke committed
652
653
* \param nrow number of rows
* \param ncol number columns
Guolin Ke's avatar
Guolin Ke committed
654
* \param is_row_major 1 for row major, 0 for column major
Guolin Ke's avatar
Guolin Ke committed
655
* \param predict_type
wxchan's avatar
wxchan committed
656
657
658
659
*          C_API_PREDICT_NORMAL: normal prediction, with transform (if needed)
*          C_API_PREDICT_RAW_SCORE: raw score
*          C_API_PREDICT_LEAF_INDEX: leaf index
* \param num_iteration number of iteration for prediction, <= 0 means no limit
Guolin Ke's avatar
Guolin Ke committed
660
* \param parameter Other parameters for the parameters, e.g. early stopping for prediction.
wxchan's avatar
wxchan committed
661
* \param out_len len of output result
Guolin Ke's avatar
Guolin Ke committed
662
* \param out_result used to set a pointer to array, should allocate memory before call this function
wxchan's avatar
wxchan committed
663
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
664
*/
665
LIGHTGBM_C_EXPORT int LGBM_BoosterPredictForMat(BoosterHandle handle,
666
667
668
669
670
671
672
                                                const void* data,
                                                int data_type,
                                                int32_t nrow,
                                                int32_t ncol,
                                                int is_row_major,
                                                int predict_type,
                                                int num_iteration,
673
                                                const char* parameter,
674
675
                                                int64_t* out_len,
                                                double* out_result);
Guolin Ke's avatar
Guolin Ke committed
676
677
678
679

/*!
* \brief save model into file
* \param handle handle
wxchan's avatar
wxchan committed
680
* \param num_iteration, <= 0 means save all
Guolin Ke's avatar
Guolin Ke committed
681
* \param filename file name
wxchan's avatar
wxchan committed
682
* \return 0 when succeed, -1 when failure happens
Guolin Ke's avatar
Guolin Ke committed
683
*/
684
LIGHTGBM_C_EXPORT int LGBM_BoosterSaveModel(BoosterHandle handle,
685
686
                                            int num_iteration,
                                            const char* filename);
Guolin Ke's avatar
Guolin Ke committed
687

688
689
690
691
692
693
694
695
696
697
/*!
* \brief save model to string
* \param handle handle
* \param num_iteration, <= 0 means save all
* \param buffer_len string buffer length, if buffer_len < out_len, re-allocate buffer
* \param out_len actual output length
* \param out_str string of model, need to pre-allocate memory before call this
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_BoosterSaveModelToString(BoosterHandle handle,
698
                                                    int num_iteration,
699
700
                                                    int64_t buffer_len,
                                                    int64_t* out_len,
701
                                                    char* out_str);
702

wxchan's avatar
wxchan committed
703
704
705
/*!
* \brief dump model to json
* \param handle handle
706
* \param num_iteration, <= 0 means save all
wxchan's avatar
wxchan committed
707
708
* \param buffer_len string buffer length, if buffer_len < out_len, re-allocate buffer
* \param out_len actual output length
Guolin Ke's avatar
typo  
Guolin Ke committed
709
* \param out_str json format string of model, need to pre-allocate memory before call this
wxchan's avatar
wxchan committed
710
711
* \return 0 when succeed, -1 when failure happens
*/
712
LIGHTGBM_C_EXPORT int LGBM_BoosterDumpModel(BoosterHandle handle,
713
                                            int num_iteration,
714
715
                                            int64_t buffer_len,
                                            int64_t* out_len,
716
                                            char* out_str);
717

Guolin Ke's avatar
Guolin Ke committed
718
/*!
Guolin Ke's avatar
Guolin Ke committed
719
* \brief Get leaf value
Guolin Ke's avatar
Guolin Ke committed
720
721
722
723
724
725
* \param handle handle
* \param tree_idx index of tree
* \param leaf_idx index of leaf
* \param out_val out result
* \return 0 when succeed, -1 when failure happens
*/
726
LIGHTGBM_C_EXPORT int LGBM_BoosterGetLeafValue(BoosterHandle handle,
727
728
729
                                               int tree_idx,
                                               int leaf_idx,
                                               double* out_val);
Guolin Ke's avatar
Guolin Ke committed
730
731
732
733
734
735
736
737
738

/*!
* \brief Set leaf value
* \param handle handle
* \param tree_idx index of tree
* \param leaf_idx index of leaf
* \param val leaf value
* \return 0 when succeed, -1 when failure happens
*/
739
LIGHTGBM_C_EXPORT int LGBM_BoosterSetLeafValue(BoosterHandle handle,
740
741
742
                                               int tree_idx,
                                               int leaf_idx,
                                               double val);
743

744
745
746
747
748
749
750
751
752
753
754
755
756
/*!
* \brief get model feature importance
* \param handle handle
* \param num_iteration, <= 0 means use all
* \param importance_type: 0 for split, 1 for gain
* \param out_results output value array
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_BoosterFeatureImportance(BoosterHandle handle,
                                                    int num_iteration,
                                                    int importance_type,
                                                    double* out_results);

757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
/*!
* \brief Initilize the network
* \param machines represent the nodes, format: ip1:port1,ip2:port2
* \param local_listen_port
* \param listen_time_out
* \param num_machines
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_NetworkInit(const char* machines,
                                       int local_listen_port,
                                       int listen_time_out,
                                       int num_machines);

/*!
* \brief Finalize the network
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT int LGBM_NetworkFree();

776
777
778
LIGHTGBM_C_EXPORT int LGBM_NetworkInitWithFunctions(int num_machines, int rank, 
                                                    void* reduce_scatter_ext_fun, 
                                                    void* allgather_ext_fun);
779

Guolin Ke's avatar
Guolin Ke committed
780
781
782
783
784
785

#if defined(_MSC_VER)
#define THREAD_LOCAL __declspec(thread) 
#else
#define THREAD_LOCAL thread_local
#endif
786
// exception handle and error msg
787
static char* LastErrorMsg() { static THREAD_LOCAL char err_msg[512] = "Everything is fine"; return err_msg; }
788

789
#pragma warning(disable : 4996)
790
inline void LGBM_SetLastError(const char* msg) {
wxchan's avatar
wxchan committed
791
  std::strcpy(LastErrorMsg(), msg);
792
793
}

Guolin Ke's avatar
Guolin Ke committed
794
#endif // LIGHTGBM_C_API_H_