[doc] Update document. (#9098)

- Mention flink is still under construction.
- Update doxygen version.
- Fix warnings from doxygen about defgroup title and mismatched parameter name.
This commit is contained in:
Jiaming Yuan 2023-04-27 19:29:03 +08:00 committed by GitHub
parent 511d4996b5
commit 96d3f8a6f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 517 additions and 261 deletions

File diff suppressed because it is too large Load Diff

View File

@ -41,3 +41,7 @@ Contents
XGBoost4J Scala API <scaladocs/xgboost4j/index> XGBoost4J Scala API <scaladocs/xgboost4j/index>
XGBoost4J-Spark Scala API <scaladocs/xgboost4j-spark/index> XGBoost4J-Spark Scala API <scaladocs/xgboost4j-spark/index>
XGBoost4J-Flink Scala API <scaladocs/xgboost4j-flink/index> XGBoost4J-Flink Scala API <scaladocs/xgboost4j-flink/index>
.. note::
Please note that the flink interface is still under construction.

View File

@ -23,7 +23,7 @@ Requirements
Dask can be installed using either pip or conda (see the dask `installation Dask can be installed using either pip or conda (see the dask `installation
documentation <https://docs.dask.org/en/latest/install.html>`_ for more information). For documentation <https://docs.dask.org/en/latest/install.html>`_ for more information). For
accelerating XGBoost with GPUs, `dask-cuda <https://github.com/rapidsai/dask-cuda>`_ is accelerating XGBoost with GPUs, `dask-cuda <https://github.com/rapidsai/dask-cuda>`__ is
recommended for creating GPU clusters. recommended for creating GPU clusters.

View File

@ -38,7 +38,7 @@ typedef uint64_t bst_ulong; // NOLINT(*)
*/ */
/** /**
* @defgroup Library * @defgroup Library Library
* *
* These functions are used to obtain general information about XGBoost including version, * These functions are used to obtain general information about XGBoost including version,
* build info and current global configuration. * build info and current global configuration.
@ -112,7 +112,7 @@ XGB_DLL int XGBGetGlobalConfig(char const **out_config);
/**@}*/ /**@}*/
/** /**
* @defgroup DMatrix * @defgroup DMatrix DMatrix
* *
* @brief DMatrix is the baisc data storage for XGBoost used by all XGBoost algorithms * @brief DMatrix is the baisc data storage for XGBoost used by all XGBoost algorithms
* including both training, prediction and explanation. There are a few variants of * including both training, prediction and explanation. There are a few variants of
@ -200,7 +200,7 @@ XGB_DLL int XGDMatrixCreateFromDense(char const *data, char const *config, DMatr
* \return 0 when success, -1 when failure happens * \return 0 when success, -1 when failure happens
*/ */
XGB_DLL int XGDMatrixCreateFromCSC(char const *indptr, char const *indices, char const *data, XGB_DLL int XGDMatrixCreateFromCSC(char const *indptr, char const *indices, char const *data,
bst_ulong nrow, char const *c_json_config, DMatrixHandle *out); bst_ulong nrow, char const *config, DMatrixHandle *out);
/*! /*!
* \brief create a matrix content from CSC format * \brief create a matrix content from CSC format
@ -281,7 +281,7 @@ XGB_DLL int XGDMatrixCreateFromCudaArrayInterface(char const *data, char const *
DMatrixHandle *out); DMatrixHandle *out);
/** /**
* @defgroup Streaming * @defgroup Streaming Streaming
* @ingroup DMatrix * @ingroup DMatrix
* *
* @brief Quantile DMatrix and external memory DMatrix can be created from batches of * @brief Quantile DMatrix and external memory DMatrix can be created from batches of
@ -431,7 +431,7 @@ XGB_EXTERN_C typedef void DataIterResetCallback(DataIterHandle handle); // NOLIN
* - Step 0: Define a data iterator with 2 methods `reset`, and `next`. * - Step 0: Define a data iterator with 2 methods `reset`, and `next`.
* - Step 1: Create a DMatrix proxy by \ref XGProxyDMatrixCreate and hold the handle. * - Step 1: Create a DMatrix proxy by \ref XGProxyDMatrixCreate and hold the handle.
* - Step 2: Pass the iterator handle, proxy handle and 2 methods into * - Step 2: Pass the iterator handle, proxy handle and 2 methods into
* `XGDMatrixCreateFromCallback`, along with other parameters encoded as a JSON object. * \ref XGDMatrixCreateFromCallback, along with other parameters encoded as a JSON object.
* - Step 3: Call appropriate data setters in `next` functions. * - Step 3: Call appropriate data setters in `next` functions.
* *
* \param iter A handle to external data iterator. * \param iter A handle to external data iterator.
@ -830,7 +830,7 @@ XGB_DLL int XGDMatrixGetDataAsCSR(DMatrixHandle const handle, char const *config
/** @} */ // End of DMatrix /** @} */ // End of DMatrix
/** /**
* @defgroup Booster * @defgroup Booster Booster
* *
* @brief The `Booster` class is the gradient-boosted model for XGBoost. * @brief The `Booster` class is the gradient-boosted model for XGBoost.
* @{ * @{
@ -953,7 +953,7 @@ XGB_DLL int XGBoosterEvalOneIter(BoosterHandle handle, int iter, DMatrixHandle d
*/ */
/** /**
* @defgroup Prediction * @defgroup Prediction Prediction
* @ingroup Booster * @ingroup Booster
* *
* @brief These functions are used for running prediction and explanation algorithms. * @brief These functions are used for running prediction and explanation algorithms.
@ -1155,7 +1155,7 @@ XGB_DLL int XGBoosterPredictFromCudaColumnar(BoosterHandle handle, char const *v
/** /**
* @defgroup Serialization * @defgroup Serialization Serialization
* @ingroup Booster * @ingroup Booster
* *
* @brief There are multiple ways to serialize a Booster object depending on the use case. * @brief There are multiple ways to serialize a Booster object depending on the use case.
@ -1490,7 +1490,7 @@ XGB_DLL int XGBoosterFeatureScore(BoosterHandle handle, const char *config,
/**@}*/ // End of Booster /**@}*/ // End of Booster
/** /**
* @defgroup Collective * @defgroup Collective Collective
* *
* @brief Experimental support for exposing internal communicator in XGBoost. * @brief Experimental support for exposing internal communicator in XGBoost.
* *