lightgbm_R.h 15.1 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
3
4
#ifndef LIGHTGBM_R_H_
#define LIGHTGBM_R_H_

#include <LightGBM/c_api.h>
5
#include <LightGBM/R_object_helper.h>
Guolin Ke's avatar
Guolin Ke committed
6

7
#include <cstdint>
Guolin Ke's avatar
Guolin Ke committed
8
9
10

/*!
* \brief get string message of the last error
11
12
*  all functions in this file will return 0 on success
*  and -1 when an error occured
Guolin Ke's avatar
Guolin Ke committed
13
14
15
* \return err_msg error inforomation
* \return error inforomation
*/
Guolin Ke's avatar
Guolin Ke committed
16
LIGHTGBM_C_EXPORT LGBM_SE LGBM_GetLastError_R(LGBM_SE buf_len, LGBM_SE actual_len, LGBM_SE err_msg);
Guolin Ke's avatar
Guolin Ke committed
17
18
19
20

// --- start Dataset interface

/*!
21
* \brief load data set from file like the command_line LightGBM does
Guolin Ke's avatar
Guolin Ke committed
22
23
* \param filename the name of the file
* \param parameters additional parameters
24
* \param reference used to align bin mapper with other dataset, nullptr means not used
Guolin Ke's avatar
Guolin Ke committed
25
26
27
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
28
29
30
31
32
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetCreateFromFile_R(LGBM_SE filename,
  LGBM_SE parameters,
  LGBM_SE reference,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
33
34
35
36
37
38
39
40
41
42

/*!
* \brief create a dataset from CSC format
* \param indptr pointer to row headers
* \param indices findex
* \param data fvalue
* \param nindptr number of cols in the matrix + 1
* \param nelem number of nonzero elements in the matrix
* \param num_row number of rows
* \param parameters additional parameters
43
* \param reference used to align bin mapper with other dataset, nullptr means not used
Guolin Ke's avatar
Guolin Ke committed
44
45
46
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
47
48
49
50
51
52
53
54
55
56
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetCreateFromCSC_R(LGBM_SE indptr,
  LGBM_SE indices,
  LGBM_SE data,
  LGBM_SE nindptr,
  LGBM_SE nelem,
  LGBM_SE num_row,
  LGBM_SE parameters,
  LGBM_SE reference,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
57
58
59
60
61
62
63
64


/*!
* \brief create dataset from dense matrix
* \param data matric data
* \param nrow number of rows
* \param ncol number columns
* \param parameters additional parameters
65
* \param reference used to align bin mapper with other dataset, nullptr means not used
Guolin Ke's avatar
Guolin Ke committed
66
67
68
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
69
70
71
72
73
74
75
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetCreateFromMat_R(LGBM_SE data,
  LGBM_SE nrow,
  LGBM_SE ncol,
  LGBM_SE parameters,
  LGBM_SE reference,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
76
77
78
79
80
81
82
83
84
85

/*!
* \brief Create subset of a data
* \param handle handle of full dataset
* \param used_row_indices Indices used in subset
* \param len_used_row_indices length of Indices used in subset
* \param parameters additional parameters
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
86
87
88
89
90
91
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetGetSubset_R(LGBM_SE handle,
  LGBM_SE used_row_indices,
  LGBM_SE len_used_row_indices,
  LGBM_SE parameters,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
92
93
94
95
96
97
98

/*!
* \brief save feature names to Dataset
* \param handle handle
* \param feature_names feature names
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
99
100
101
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetSetFeatureNames_R(LGBM_SE handle,
  LGBM_SE feature_names,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
102
103
104
105
106
107
108

/*!
* \brief save feature names to Dataset
* \param handle handle
* \param feature_names feature names
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
109
110
111
112
113
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetGetFeatureNames_R(LGBM_SE handle,
  LGBM_SE buf_len,
  LGBM_SE actual_len,
  LGBM_SE feature_names,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
114
115
116

/*!
* \brief save dateset to binary file
117
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
118
119
120
* \param filename file name
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
121
122
123
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetSaveBinary_R(LGBM_SE handle,
  LGBM_SE filename,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
124
125
126

/*!
* \brief free dataset
127
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
128
129
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
130
131
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetFree_R(LGBM_SE handle,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
132
133
134

/*!
* \brief set vector to a content in info
135
*        Note: group and group_id only work for C_API_DTYPE_INT32
Guolin Ke's avatar
Guolin Ke committed
136
*              label and weight only work for C_API_DTYPE_FLOAT32
137
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
138
139
140
141
142
* \param field_name field name, can be label, weight, group, group_id
* \param field_data pointer to vector
* \param num_element number of element in field_data
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
143
144
145
146
147
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetSetField_R(LGBM_SE handle,
  LGBM_SE field_name,
  LGBM_SE field_data,
  LGBM_SE num_element,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
148
149
150

/*!
* \brief get size of info vector from dataset
151
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
152
153
154
155
* \param field_name field name
* \param out size of info vector from dataset
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
156
157
158
159
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetGetFieldSize_R(LGBM_SE handle,
  LGBM_SE field_name,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
160
161
162

/*!
* \brief get info vector from dataset
163
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
164
165
166
167
* \param field_name field name
* \param field_data pointer to vector
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
168
169
170
171
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetGetField_R(LGBM_SE handle,
  LGBM_SE field_name,
  LGBM_SE field_data,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
172

173
174
175
176
177
178
179
180
181
182
/*!
* \brief Update parameters for a Dataset
* \param handle a instance of data matrix
* \param parameters parameters
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetUpdateParam_R(LGBM_SE handle,
  LGBM_SE params,
  LGBM_SE call_state);

Guolin Ke's avatar
Guolin Ke committed
183
184
185
186
187
188
/*!
* \brief get number of data.
* \param handle the handle to the dataset
* \param out The address to hold number of data
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
189
190
191
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetGetNumData_R(LGBM_SE handle,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
192
193
194
195
196
197
198

/*!
* \brief get number of features
* \param handle the handle to the dataset
* \param out The output of number of features
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
199
200
201
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetGetNumFeature_R(LGBM_SE handle,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
202
203
204
205
206
207
208
209
210
211

// --- start Booster interfaces

/*!
* \brief create an new boosting learner
* \param train_data training data set
* \param parameters format: 'key1=value1 key2=value2'
* \prama out handle of created Booster
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
212
213
214
215
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterCreate_R(LGBM_SE train_data,
  LGBM_SE parameters,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
216
217
218
219
220
221

/*!
* \brief free obj in handle
* \param handle handle to be freed
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
222
223
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterFree_R(LGBM_SE handle,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
224
225
226
227
228
229
230

/*!
* \brief load an existing boosting from model file
* \param filename filename of model
* \prama out handle of created Booster
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
231
232
233
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterCreateFromModelfile_R(LGBM_SE filename,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
234

235
236
237
238
239
240
241
242
243
/*!
* \brief load an existing boosting from model_str
* \param model_str string containing the model
* \param out handle of created Booster
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterLoadModelFromString_R(LGBM_SE model_str,
  LGBM_SE out,
  LGBM_SE call_state);
244

Guolin Ke's avatar
Guolin Ke committed
245
/*!
246
* \brief Merge model in two boosters to first handle
Guolin Ke's avatar
Guolin Ke committed
247
248
249
250
* \param handle handle, will merge other handle to this
* \param other_handle
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
251
252
253
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterMerge_R(LGBM_SE handle,
  LGBM_SE other_handle,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
254
255
256
257
258
259
260

/*!
* \brief Add new validation to booster
* \param handle handle
* \param valid_data validation data set
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
261
262
263
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterAddValidData_R(LGBM_SE handle,
  LGBM_SE valid_data,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
264
265
266
267
268
269
270

/*!
* \brief Reset training data for booster
* \param handle handle
* \param train_data training data set
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
271
272
273
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterResetTrainingData_R(LGBM_SE handle,
  LGBM_SE train_data,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
274
275
276
277
278
279
280

/*!
* \brief Reset config for current booster
* \param handle handle
* \param parameters format: 'key1=value1 key2=value2'
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
281
282
283
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterResetParameter_R(LGBM_SE handle,
  LGBM_SE parameters,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
284
285

/*!
286
* \brief Get number of classes
Guolin Ke's avatar
Guolin Ke committed
287
288
289
290
* \param handle handle
* \param out number of classes
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
291
292
293
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterGetNumClasses_R(LGBM_SE handle,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
294
295
296
297
298
299

/*!
* \brief update the model in one round
* \param handle handle
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
300
301
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterUpdateOneIter_R(LGBM_SE handle,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
302
303
304
305
306
307
308
309
310
311

/*!
* \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
* \param len length of grad/hess
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
312
313
314
315
316
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterUpdateOneIterCustom_R(LGBM_SE handle,
  LGBM_SE grad,
  LGBM_SE hess,
  LGBM_SE len,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
317
318
319
320
321
322

/*!
* \brief Rollback one iteration
* \param handle handle
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
323
324
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterRollbackOneIter_R(LGBM_SE handle,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
325
326
327
328
329
330

/*!
* \brief Get iteration of current boosting rounds
* \param out iteration of boosting rounds
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
331
332
333
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterGetCurrentIteration_R(LGBM_SE handle,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
334
335
336
337
338
339

/*!
* \brief Get Name of eval
* \param eval_names eval names
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
340
341
342
343
344
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterGetEvalNames_R(LGBM_SE handle,
  LGBM_SE buf_len,
  LGBM_SE actual_len,
  LGBM_SE eval_names,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
345
346
347
348
349
350
351
352

/*!
* \brief get evaluation for training data and validation data
* \param handle handle
* \param data_idx 0:training data, 1: 1st valid data, 2:2nd valid data ...
* \param out_result float arrary contains result
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
353
354
355
356
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterGetEval_R(LGBM_SE handle,
  LGBM_SE data_idx,
  LGBM_SE out_result,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
357
358
359
360
361
362
363
364

/*!
* \brief Get number of prediction for training data and validation data
* \param handle handle
* \param data_idx 0:training data, 1: 1st valid data, 2:2nd valid data ...
* \param out size of predict
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
365
366
367
368
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterGetNumPredict_R(LGBM_SE handle,
  LGBM_SE data_idx,
  LGBM_SE out,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
369
370

/*!
371
372
* \brief Get prediction for training data and validation data.
*        This can be used to support customized eval function
Guolin Ke's avatar
Guolin Ke committed
373
374
375
376
377
* \param handle handle
* \param data_idx 0:training data, 1: 1st valid data, 2:2nd valid data ...
* \param out_result, used to store predict result, should pre-allocate memory
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
378
379
380
381
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterGetPredict_R(LGBM_SE handle,
  LGBM_SE data_idx,
  LGBM_SE out_result,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
382
383
384
385
386
387
388
389
390
391
392
393

/*!
* \brief make prediction for file
* \param handle handle
* \param data_filename filename of data file
* \param data_has_header data file has header or not
* \param is_rawscore
* \param is_leafidx
* \param num_iteration number of iteration for prediction, <= 0 means no limit
* \return 0 when succeed, -1 when failure happens
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
394
395
396
397
398
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterPredictForFile_R(LGBM_SE handle,
  LGBM_SE data_filename,
  LGBM_SE data_has_header,
  LGBM_SE is_rawscore,
  LGBM_SE is_leafidx,
399
  LGBM_SE is_predcontrib,
Guolin Ke's avatar
Guolin Ke committed
400
  LGBM_SE num_iteration,
401
  LGBM_SE parameter,
Guolin Ke's avatar
Guolin Ke committed
402
403
  LGBM_SE result_filename,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
404
405
406
407
408
409
410
411
412
413
414

/*!
* \brief Get number of prediction
* \param handle handle
* \param num_row
* \param is_rawscore
* \param is_leafidx
* \param num_iteration number of iteration for prediction, <= 0 means no limit
* \param out_len lenght of prediction
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
415
416
417
418
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterCalcNumPredict_R(LGBM_SE handle,
  LGBM_SE num_row,
  LGBM_SE is_rawscore,
  LGBM_SE is_leafidx,
419
  LGBM_SE is_predcontrib,
Guolin Ke's avatar
Guolin Ke committed
420
421
422
  LGBM_SE num_iteration,
  LGBM_SE out_len,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
423
424
425
426

/*!
* \brief make prediction for an new data set
*        Note:  should pre-allocate memory for out_result,
427
*               for normal and raw score: its length is equal to num_class * num_data
Guolin Ke's avatar
Guolin Ke committed
428
429
430
431
432
433
*               for leaf index, its length is equal to num_class * num_data * num_iteration
* \param handle handle
* \param indptr pointer to row headers
* \param indices findex
* \param data fvalue
* \param nindptr number of cols in the matrix + 1
434
* \param nelem number of non-zero elements in the matrix
Guolin Ke's avatar
Guolin Ke committed
435
436
437
438
439
440
441
* \param num_row number of rows
* \param is_rawscore
* \param is_leafidx
* \param num_iteration number of iteration for prediction, <= 0 means no limit
* \param out prediction result
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
442
443
444
445
446
447
448
449
450
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterPredictForCSC_R(LGBM_SE handle,
  LGBM_SE indptr,
  LGBM_SE indices,
  LGBM_SE data,
  LGBM_SE nindptr,
  LGBM_SE nelem,
  LGBM_SE num_row,
  LGBM_SE is_rawscore,
  LGBM_SE is_leafidx,
451
  LGBM_SE is_predcontrib,
Guolin Ke's avatar
Guolin Ke committed
452
  LGBM_SE num_iteration,
453
  LGBM_SE parameter,
Guolin Ke's avatar
Guolin Ke committed
454
455
  LGBM_SE out_result,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
456
457

/*!
458
* \brief make prediction for a new data set
Guolin Ke's avatar
Guolin Ke committed
459
*        Note:  should pre-allocate memory for out_result,
460
*               for normal and raw score: its length is equal to num_class * num_data
Guolin Ke's avatar
Guolin Ke committed
461
462
463
464
465
466
467
468
469
470
471
*               for leaf index, its length is equal to num_class * num_data * num_iteration
* \param handle handle
* \param data pointer to the data space
* \param nrow number of rows
* \param ncol number columns
* \param is_rawscore
* \param is_leafidx
* \param num_iteration number of iteration for prediction, <= 0 means no limit
* \param out prediction result
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
472
473
474
475
476
477
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterPredictForMat_R(LGBM_SE handle,
  LGBM_SE data,
  LGBM_SE nrow,
  LGBM_SE ncol,
  LGBM_SE is_rawscore,
  LGBM_SE is_leafidx,
478
  LGBM_SE is_predcontrib,
Guolin Ke's avatar
Guolin Ke committed
479
  LGBM_SE num_iteration,
480
  LGBM_SE parameter,
Guolin Ke's avatar
Guolin Ke committed
481
482
  LGBM_SE out_result,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
483
484
485
486
487
488
489
490

/*!
* \brief save model into file
* \param handle handle
* \param num_iteration, <= 0 means save all
* \param filename file name
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
491
492
493
494
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterSaveModel_R(LGBM_SE handle,
  LGBM_SE num_iteration,
  LGBM_SE filename,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
495

496
497
498
499
500
501
502
503
504
505
506
507
508
509
/*!
* \brief create string containing model
* \param handle handle
* \param num_iteration, <= 0 means save all
* \param out_str string of model
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterSaveModelToString_R(LGBM_SE handle,
  LGBM_SE num_iteration,
  LGBM_SE buffer_len,
  LGBM_SE actual_len,
  LGBM_SE out_str,
  LGBM_SE call_state);

Guolin Ke's avatar
Guolin Ke committed
510
511
512
513
514
515
516
/*!
* \brief dump model to json
* \param handle handle
* \param num_iteration, <= 0 means save all
* \param out_str json format string of model
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
517
518
519
520
521
522
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterDumpModel_R(LGBM_SE handle,
  LGBM_SE num_iteration,
  LGBM_SE buffer_len,
  LGBM_SE actual_len,
  LGBM_SE out_str,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
523

524
#endif  // LIGHTGBM_R_H_