文档和示例

目录

文档

Python 和 C 文档是使用 Sphinx 构建的。
每个文档都是用 reStructuredText 编写的。
文档位于 doc/ 目录。
你可以使用 make html 命令在本地构建它。
```
make html
```
运行 make help 以了解其他命令。

在线文档托管在 Read the Docs 上，其中导入的项目由 Hyunsu Cho 和 Jiaming Yuan 管理。

使用 pip 和 Conda 构建 Python 文档

创建一个 conda 环境。
```
conda create -n xgboost-docs --yes python=3.10
```
备注

xgboost_ray 包需要 Python 3.10。
激活环境
```
conda activate xgboost-docs
```
使用 pip 命令安装所需的包（在当前环境中）。
```
pip install -r requirements.txt
```
备注

由于 xgboost_ray 在 conda 频道中不可用，目前无法使用 conda 安装所需的包。
```
conda install --file requirements.txt --yes -c conda-forge
```
(可选) 安装 graphviz
```
conda install graphviz --yes
```
最终，构建文档。
```
make html
```

您应该在控制台中看到以下消息：

$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v6.2.1
...
The HTML pages are in _build/html.

Build finished. The HTML pages are in _build/html.

示例

用例和示例在 demo 目录中。
我们非常兴奋地想听听你的故事。如果你有使用 XGBoost 的博客文章、教程或代码解决方案，请告诉我们，我们会在示例页面中添加链接。