Unverified Commit 939a0248 authored by Nikita Titov's avatar Nikita Titov Committed by GitHub
Browse files

fixed C API SetField description (#2406)

parent 15566421
...@@ -309,15 +309,14 @@ LIGHTGBM_C_EXPORT int LGBM_DatasetDumpText(DatasetHandle handle, ...@@ -309,15 +309,14 @@ LIGHTGBM_C_EXPORT int LGBM_DatasetDumpText(DatasetHandle handle,
/*! /*!
* \brief Set vector to a content in info. * \brief Set vector to a content in info.
* \note * \note
* - \a monotone_constraints only works for ``C_API_DTYPE_INT8``;
* - \a group only works for ``C_API_DTYPE_INT32``; * - \a group only works for ``C_API_DTYPE_INT32``;
* - \a label and \a weight only work for ``C_API_DTYPE_FLOAT32``; * - \a label and \a weight only work for ``C_API_DTYPE_FLOAT32``;
* - \a init_score and \a feature_penalty only work for ``C_API_DTYPE_FLOAT64``. * - \a init_score only works for ``C_API_DTYPE_FLOAT64``.
* \param handle Handle of dataset * \param handle Handle of dataset
* \param field_name Field name, can be \a label, \a weight, \a init_score, \a group, \a feature_penalty, \a monotone_constraints * \param field_name Field name, can be \a label, \a weight, \a init_score, \a group
* \param field_data Pointer to data vector * \param field_data Pointer to data vector
* \param num_element Number of elements in ``field_data`` * \param num_element Number of elements in ``field_data``
* \param type Type of ``field_data`` pointer, can be ``C_API_DTYPE_INT8``, ``C_API_DTYPE_INT32``, ``C_API_DTYPE_FLOAT32`` or ``C_API_DTYPE_FLOAT64`` * \param type Type of ``field_data`` pointer, can be ``C_API_DTYPE_INT32``, ``C_API_DTYPE_FLOAT32`` or ``C_API_DTYPE_FLOAT64``
* \return 0 when succeed, -1 when failure happens * \return 0 when succeed, -1 when failure happens
*/ */
LIGHTGBM_C_EXPORT int LGBM_DatasetSetField(DatasetHandle handle, LIGHTGBM_C_EXPORT int LGBM_DatasetSetField(DatasetHandle handle,
......
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