Documentation and Examples
Python and C documentation is built using Sphinx.
Each document is written in reStructuredText.
The documentation is the
You can build it locally using
make helpto learn about the other commands.
Build the Python Docs using pip and Conda
Create a conda environment.
conda create -n xgboost-docs --yes python=3.10
Python 3.10 is required by xgboost_ray package.
Activate the environment
conda activate xgboost-docs
Install required packages (in the current environment) using
pip install -r requirements.txt
It is currently not possible to install the required packages using
xgboost_raybeing unavailable in conda channels.
conda install --file requirements.txt --yes -c conda-forge
(optional) Install graphviz
conda install graphviz --yes
Eventually, build the docs.
You should see the following messages in the console:$ 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.
Use cases and examples are in demo directory.
We are super excited to hear about your story. If you have blog posts, tutorials, or code solutions using XGBoost, please tell us, and we will add a link in the example pages.