Commit 65e711a2 authored by Allard van Mossel's avatar Allard van Mossel Committed by Guolin Ke
Browse files

Fixed inconsistencies and missing C-API documentation (#96)

parent 405f45a0
...@@ -307,10 +307,10 @@ DllExport int LGBM_BoosterGetPredict(BoosterHandle handle, ...@@ -307,10 +307,10 @@ DllExport int LGBM_BoosterGetPredict(BoosterHandle handle,
* \brief make prediction for file * \brief make prediction for file
* \param handle handle * \param handle handle
* \param predict_type * \param predict_type
* 0:raw score * 0:normal, with transform (if needed)
* 1:with transform(if needed) * 1:raw score
* 2:leaf index * 2:leaf index
* \param n_used_trees number of used tree * \param n_used_trees number of used tree, < 0 means no limit
* \param data_has_header data file has header or not * \param data_has_header data file has header or not
* \param data_filename filename of data file * \param data_filename filename of data file
* \param result_filename filename of result file * \param result_filename filename of result file
...@@ -335,10 +335,10 @@ DllExport int LGBM_BoosterPredictForFile(BoosterHandle handle, ...@@ -335,10 +335,10 @@ DllExport int LGBM_BoosterPredictForFile(BoosterHandle handle,
* \param nelem number of nonzero elements in the matrix * \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 num_col number of columns; when it's set to 0, then guess from data
* \param predict_type * \param predict_type
* 0:raw score * 0:normal, with transform (if needed)
* 1:with transform(if needed) * 1:raw score
* 2:leaf index * 2:leaf index
* \param n_used_trees number of used tree * \param n_used_trees number of used tree, < 0 means no limit
* \param out_result used to set a pointer to array, should allocate memory before call this function * \param out_result used to set a pointer to array, should allocate memory before call this function
* \return 0 when success, -1 when failure happens * \return 0 when success, -1 when failure happens
*/ */
...@@ -364,10 +364,10 @@ DllExport int LGBM_BoosterPredictForCSR(BoosterHandle handle, ...@@ -364,10 +364,10 @@ DllExport int LGBM_BoosterPredictForCSR(BoosterHandle handle,
* \param ncol number columns * \param ncol number columns
* \param is_row_major 1 for row major, 0 for column major * \param is_row_major 1 for row major, 0 for column major
* \param predict_type * \param predict_type
* 0:raw score * 0:normal, with transform (if needed)
* 1:with transform(if needed) * 1:raw score
* 2:leaf index * 2:leaf index
* \param n_used_trees number of used tree * \param n_used_trees number of used tree, < 0 means no limit
* \param out_result used to set a pointer to array, should allocate memory before call this function * \param out_result used to set a pointer to array, should allocate memory before call this function
* \return 0 when success, -1 when failure happens * \return 0 when success, -1 when failure happens
*/ */
...@@ -384,7 +384,7 @@ DllExport int LGBM_BoosterPredictForMat(BoosterHandle handle, ...@@ -384,7 +384,7 @@ DllExport int LGBM_BoosterPredictForMat(BoosterHandle handle,
/*! /*!
* \brief save model into file * \brief save model into file
* \param handle handle * \param handle handle
* \param num_used_model * \param num_used_model, < 0 means no limit
* \param filename file name * \param filename file name
* \return 0 when success, -1 when failure happens * \return 0 when success, -1 when failure happens
*/ */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment