lightgbm_R.h 15.9 KB
Newer Older
1
2
3
4
/*!
 * Copyright (c) 2017 Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
Guolin Ke's avatar
Guolin Ke committed
5
6
7
8
#ifndef LIGHTGBM_R_H_
#define LIGHTGBM_R_H_

#include <LightGBM/c_api.h>
9
#include <LightGBM/R_object_helper.h>
Guolin Ke's avatar
Guolin Ke committed
10
11
12

/*!
* \brief get string message of the last error
13
*  all functions in this file will return 0 on success
14
15
16
*  and -1 when an error occurred
* \return err_msg error information
* \return error information
Guolin Ke's avatar
Guolin Ke committed
17
*/
Guolin Ke's avatar
Guolin Ke committed
18
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
19
20
21
22

// --- start Dataset interface

/*!
23
* \brief load data set from file like the command_line LightGBM does
Guolin Ke's avatar
Guolin Ke committed
24
25
* \param filename the name of the file
* \param parameters additional parameters
26
* \param reference used to align bin mapper with other dataset, nullptr means not used
Guolin Ke's avatar
Guolin Ke committed
27
28
29
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
30
31
32
33
34
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
35
36
37
38
39
40
41
42
43
44

/*!
* \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
45
* \param reference used to align bin mapper with other dataset, nullptr means not used
Guolin Ke's avatar
Guolin Ke committed
46
47
48
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
49
50
51
52
53
54
55
56
57
58
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
59
60
61
62
63
64
65
66


/*!
* \brief create dataset from dense matrix
* \param data matric data
* \param nrow number of rows
* \param ncol number columns
* \param parameters additional parameters
67
* \param reference used to align bin mapper with other dataset, nullptr means not used
Guolin Ke's avatar
Guolin Ke committed
68
69
70
* \param out created dataset
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
71
72
73
74
75
76
77
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
78
79
80
81
82
83
84
85
86
87

/*!
* \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
88
89
90
91
92
93
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
94
95
96
97
98
99
100

/*!
* \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
101
102
103
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
104
105
106
107
108
109
110

/*!
* \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
111
112
113
114
115
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
116
117

/*!
118
* \brief save dataset to binary file
119
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
120
121
122
* \param filename file name
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
123
124
125
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
126
127
128

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

/*!
* \brief set vector to a content in info
137
*        Note: group and group_id only work for C_API_DTYPE_INT32
Guolin Ke's avatar
Guolin Ke committed
138
*              label and weight only work for C_API_DTYPE_FLOAT32
139
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
140
141
142
143
144
* \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
145
146
147
148
149
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
150
151
152

/*!
* \brief get size of info vector from dataset
153
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
154
155
156
157
* \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
158
159
160
161
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
162
163
164

/*!
* \brief get info vector from dataset
165
* \param handle an instance of dataset
Guolin Ke's avatar
Guolin Ke committed
166
167
168
169
* \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
170
171
172
173
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
174

175
/*!
176
177
178
179
180
181
182
 * \brief Raise errors for attempts to update dataset parameters
 * \param old_params Current dataset parameters
 * \param new_params New dataset parameters
 * \return 0 when succeed, -1 when failure happens
 */
LIGHTGBM_C_EXPORT LGBM_SE LGBM_DatasetUpdateParamChecking_R(LGBM_SE old_params,
  LGBM_SE new_params,
183
184
  LGBM_SE call_state);

Guolin Ke's avatar
Guolin Ke committed
185
186
187
188
189
190
/*!
* \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
191
192
193
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
194
195
196
197
198
199
200

/*!
* \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
201
202
203
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
204
205
206
207

// --- start Booster interfaces

/*!
208
* \brief create a new boosting learner
Guolin Ke's avatar
Guolin Ke committed
209
210
* \param train_data training data set
* \param parameters format: 'key1=value1 key2=value2'
211
* \param out handle of created Booster
Guolin Ke's avatar
Guolin Ke committed
212
213
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
214
215
216
217
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
218
219
220
221
222
223

/*!
* \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
224
225
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterFree_R(LGBM_SE handle,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
226
227
228
229

/*!
* \brief load an existing boosting from model file
* \param filename filename of model
230
* \param out handle of created Booster
Guolin Ke's avatar
Guolin Ke committed
231
232
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
233
234
235
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
236

237
238
239
240
241
242
243
244
245
/*!
* \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);
246

Guolin Ke's avatar
Guolin Ke committed
247
/*!
248
* \brief Merge model in two boosters to first handle
Guolin Ke's avatar
Guolin Ke committed
249
250
251
252
* \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
253
254
255
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
256
257
258
259
260
261
262

/*!
* \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
263
264
265
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
266
267
268
269
270
271
272

/*!
* \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
273
274
275
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
276
277
278
279
280
281
282

/*!
* \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
283
284
285
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
286
287

/*!
288
* \brief Get number of classes
Guolin Ke's avatar
Guolin Ke committed
289
290
291
292
* \param handle handle
* \param out number of classes
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
293
294
295
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
296
297
298
299
300
301

/*!
* \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
302
303
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterUpdateOneIter_R(LGBM_SE handle,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
304
305
306
307
308
309
310
311
312
313

/*!
* \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
314
315
316
317
318
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
319
320
321
322
323
324

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

/*!
* \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
333
334
335
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
336

337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
/*!
* \brief Get model upper bound value.
* \param handle Handle of booster
* \param[out] out_results Result pointing to max value
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterGetUpperBoundValue_R(
    LGBM_SE handle,
    LGBM_SE out_result,
    LGBM_SE call_state
);

/*!
* \brief Get model lower bound value.
* \param handle Handle of booster
* \param[out] out_results Result pointing to min value
* \return 0 when succeed, -1 when failure happens
*/
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterGetLowerBoundValue_R(
    LGBM_SE handle,
    LGBM_SE out_result,
    LGBM_SE call_state
);

Guolin Ke's avatar
Guolin Ke committed
361
362
363
364
365
/*!
* \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
366
367
368
369
370
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
371
372
373
374
375

/*!
* \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 ...
376
* \param out_result float array contains result
Guolin Ke's avatar
Guolin Ke committed
377
378
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
379
380
381
382
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
383
384
385
386
387
388
389
390

/*!
* \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
391
392
393
394
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
395
396

/*!
397
398
* \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
399
400
401
402
403
* \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
404
405
406
407
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
408
409
410
411
412
413
414
415
416
417
418
419

/*!
* \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
420
421
422
423
424
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,
425
  LGBM_SE is_predcontrib,
Guolin Ke's avatar
Guolin Ke committed
426
  LGBM_SE num_iteration,
427
  LGBM_SE parameter,
Guolin Ke's avatar
Guolin Ke committed
428
429
  LGBM_SE result_filename,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
430
431
432
433
434
435
436
437

/*!
* \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
438
* \param out_len length of prediction
Guolin Ke's avatar
Guolin Ke committed
439
440
* \return 0 when succeed, -1 when failure happens
*/
Guolin Ke's avatar
Guolin Ke committed
441
442
443
444
LIGHTGBM_C_EXPORT LGBM_SE LGBM_BoosterCalcNumPredict_R(LGBM_SE handle,
  LGBM_SE num_row,
  LGBM_SE is_rawscore,
  LGBM_SE is_leafidx,
445
  LGBM_SE is_predcontrib,
Guolin Ke's avatar
Guolin Ke committed
446
447
448
  LGBM_SE num_iteration,
  LGBM_SE out_len,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
449
450

/*!
451
* \brief make prediction for a new data set
Guolin Ke's avatar
Guolin Ke committed
452
*        Note:  should pre-allocate memory for out_result,
453
*               for normal and raw score: its length is equal to num_class * num_data
Guolin Ke's avatar
Guolin Ke committed
454
455
456
457
458
459
*               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
460
* \param nelem number of non-zero elements in the matrix
Guolin Ke's avatar
Guolin Ke committed
461
462
463
464
465
466
467
* \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
468
469
470
471
472
473
474
475
476
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,
477
  LGBM_SE is_predcontrib,
Guolin Ke's avatar
Guolin Ke committed
478
  LGBM_SE num_iteration,
479
  LGBM_SE parameter,
Guolin Ke's avatar
Guolin Ke committed
480
481
  LGBM_SE out_result,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
482
483

/*!
484
* \brief make prediction for a new data set
Guolin Ke's avatar
Guolin Ke committed
485
*        Note:  should pre-allocate memory for out_result,
486
*               for normal and raw score: its length is equal to num_class * num_data
Guolin Ke's avatar
Guolin Ke committed
487
488
489
490
491
492
493
494
495
496
497
*               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
498
499
500
501
502
503
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,
504
  LGBM_SE is_predcontrib,
Guolin Ke's avatar
Guolin Ke committed
505
  LGBM_SE num_iteration,
506
  LGBM_SE parameter,
Guolin Ke's avatar
Guolin Ke committed
507
508
  LGBM_SE out_result,
  LGBM_SE call_state);
Guolin Ke's avatar
Guolin Ke committed
509
510
511
512
513
514
515
516

/*!
* \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
517
518
519
520
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
521

522
523
524
525
526
527
528
529
530
531
532
533
534
535
/*!
* \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
536
537
538
539
540
541
542
/*!
* \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
543
544
545
546
547
548
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
549

550
#endif  // LIGHTGBM_R_H_